Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Sprite

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • new Sprite(texture: Texture): Sprite

Properties

Private _anchor

_anchor: Anchor

Protected _children

_children: DisplayObject<Object3D>[] = []

Private _height

_height: number = 0

Private _material

_material: MeshBasicMaterial

Protected _pivot

_pivot: Vector3 = ...

Protected _size

_size: Vector3 = ...

Protected _skew

_skew: Vector2 = ...

Protected _sub

_sub: Mesh<BufferGeometry, Material | Material[]>

Protected _task

_task: Task

Private _texture

_texture: Texture

Protected _three

_three: Mesh<BufferGeometry, Material | Material[]>

Private _width

_width: number = 0

interactive

interactive: boolean = false

taskEnabledChildren

taskEnabledChildren: boolean = true

Accessors

anchor

children

depth

  • get depth(): number

height

  • get height(): number

parent

pivot

  • get pivot(): Vector3

rotation

  • get rotation(): number
  • set rotation(value: number): void

scale

  • get scale(): Vector3

skew

  • get skew(): Vector2

task

  • get task(): Task

taskEnabled

  • get taskEnabled(): boolean
  • set taskEnabled(value: boolean): void

texture

  • get texture(): Texture
  • set texture(texture: Texture): void

three

  • get three(): T

width

  • get width(): number

x

  • get x(): number
  • set x(value: number): void

y

  • get y(): number
  • set y(value: number): void

z

  • get z(): number
  • set z(value: number): void

Methods

_updateGeometry

  • _updateGeometry(width: number, height: number): void

  • Parameters

    • width: number
    • height: number

    Returns void

_updateMatrix

  • _updateMatrix(): void

addChild

cemit

  • cemit(type: string, context: any, ...args: any[]): Sprite

  • Emit event with specifying a context.

    Parameters

    • type: string

      Event type to emit.

    • context: any

      Context to execute the callback.

    • Rest ...args: any[]

      Argument(s) in callback.

    Returns Sprite

cemitAll

  • cemitAll(context: any, ...args: any[]): Sprite

  • Emit all events with specifying a context.

    Parameters

    • context: any

      Context to execute the callback.

    • Rest ...args: any[]

      Argument(s) in callback.

    Returns Sprite

clear

  • clear(type?: string): Sprite

  • Remove events grouped event type.

    Parameters

    • Optional type: string

      Event type to remove. If it is empty, removes all events.

    Returns Sprite

emit

  • emit(type: string, ...args: any[]): Sprite

  • Emit event.

    Parameters

    • type: string

      Event type to emit.

    • Rest ...args: any[]

      Argument(s) in callback.

    Returns Sprite

emitAll

  • emitAll(...args: any[]): Sprite

  • Emit all events.

    Parameters

    • Rest ...args: any[]

      Argument(s) in callback.

    Returns Sprite

off

  • off(type: string, callback: IEmitterDelegate): Sprite

  • Unregister event.

    Parameters

    • type: string

      Event type.

    • callback: IEmitterDelegate

      Registered callback.

    Returns Sprite

on

  • on(type: string, callback: IEmitterDelegate): Sprite

  • Register event.

    Parameters

    • type: string

      Event type.

    • callback: IEmitterDelegate

      Callback when the event fires.

    Returns Sprite

once

  • once(type: string, callback: IEmitterDelegate): Sprite

  • Register one-time event.

    Parameters

    • type: string

      Event type.

    • callback: IEmitterDelegate

      Callback when the event fires.

    Returns Sprite

removeChild

update

  • update(e: ITickerData, taskDisabledChildren: boolean): void

updateBoundingBox

  • updateBoundingBox(): void

updateGeometryPosition

  • updateGeometryPosition(): void

updateTask

updateTransform

  • updateTransform(): void

Static from

  • from(url: string, callback: (sprite: Sprite) => void): Sprite

Generated using TypeDoc