Class Object2D<T>

Type parameters

T: THREE.Object3D = THREE.Object3D

Hierarchy

DisplayObject<T>
- Object2D
  - Container2D
  - Sprite

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new Object2D<T>(three: T): Object2D<T>

Overrides DisplayObject.constructor
- Defined in src/Object2D.ts:5
Type parameters
- T: Object3D<T> = Object3D
Parameters
- three: T
Returns Object2D<T>

Properties

Protected _children

_children: DisplayObject<Object3D>[] = []

Protected _pivot

_pivot: Vector3 = ...

Protected _size

_size: Vector3 = ...

Protected _skew

_skew: Vector2 = ...

Protected _sub

_sub: T

Protected _task

_task: Task

Protected _three

_three: T

interactive

interactive: boolean = false

taskEnabledChildren

taskEnabledChildren: boolean = true

Accessors

children

get children(): DisplayObject<Object3D>[]

- Defined in src/DisplayObject.ts:86
Returns DisplayObject<Object3D>[]

depth

get depth(): number

- Defined in src/DisplayObject.ts:104
Returns number

height

get height(): number

- Defined in src/DisplayObject.ts:99
Returns number

parent

get parent(): null | DisplayObject<Object3D>

- Defined in src/DisplayObject.ts:82
Returns null | DisplayObject<Object3D>

pivot

get pivot(): Vector3

- Defined in src/DisplayObject.ts:143
Returns Vector3

rotation

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

- Defined in src/Object2D.ts:17
Returns number
- Defined in src/Object2D.ts:21
Parameters
- value: number
Returns void

scale

get scale(): Vector3

- Defined in src/DisplayObject.ts:139
Returns Vector3

skew

get skew(): Vector2

- Defined in src/Object2D.ts:13
Returns Vector2

task

get task(): Task

- Defined in src/DisplayObject.ts:70
Returns Task

taskEnabled

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

- Defined in src/DisplayObject.ts:74
Returns boolean
- Defined in src/DisplayObject.ts:78
Parameters
- value: boolean
Returns void

three

get three(): T

- Defined in src/DisplayObject.ts:66
Returns T

width

get width(): number

- Defined in src/DisplayObject.ts:94
Returns number

x

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

- Defined in src/DisplayObject.ts:109
Returns number
- Defined in src/DisplayObject.ts:113
Parameters
- value: number
Returns void

y

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

- Defined in src/DisplayObject.ts:117
Returns number
- Defined in src/DisplayObject.ts:121
Parameters
- value: number
Returns void

z

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

- Defined in src/DisplayObject.ts:125
Returns number
- Defined in src/DisplayObject.ts:129
Parameters
- value: number
Returns void

Methods

_updateMatrix

_updateMatrix(): void

- Defined in src/Object2D.ts:29
Returns void

addChild

addChild(object: DisplayObject<Object3D>): DisplayObject<Object3D>

Inherited from DisplayObject.addChild
- Defined in src/DisplayObject.ts:168
Parameters
- object: DisplayObject<Object3D>
Returns DisplayObject<Object3D>

cemit

cemit(type: string, context: any, ...args: any[]): Object2D<T>

Inherited from DisplayObject.cemit
- Defined in node_modules/@tawaship/emitter/types/modules/Emitter.d.ts:43
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 Object2D<T>

cemitAll

cemitAll(context: any, ...args: any[]): Object2D<T>

Inherited from DisplayObject.cemitAll
- Defined in node_modules/@tawaship/emitter/types/modules/Emitter.d.ts:57
Emit all events with specifying a context.

Parameters
- context: any
  
  Context to execute the callback.
- Rest ...args: any[]
  
  Argument(s) in callback.
Returns Object2D<T>

clear

clear(type?: string): Object2D<T>

Inherited from DisplayObject.clear
- Defined in node_modules/@tawaship/emitter/types/modules/Emitter.d.ts:63
Remove events grouped event type.

Parameters
- Optional type: string
  
  Event type to remove. If it is empty, removes all events.
Returns Object2D<T>

emit

emit(type: string, ...args: any[]): Object2D<T>

Inherited from DisplayObject.emit
- Defined in node_modules/@tawaship/emitter/types/modules/Emitter.d.ts:35
Emit event.

Parameters
- type: string
  
  Event type to emit.
- Rest ...args: any[]
  
  Argument(s) in callback.
Returns Object2D<T>

emitAll

emitAll(...args: any[]): Object2D<T>

Inherited from DisplayObject.emitAll
- Defined in node_modules/@tawaship/emitter/types/modules/Emitter.d.ts:50
Emit all events.

Parameters
- Rest ...args: any[]
  
  Argument(s) in callback.
Returns Object2D<T>

off

off(type: string, callback: IEmitterDelegate): Object2D<T>

Inherited from DisplayObject.off
- Defined in node_modules/@tawaship/emitter/types/modules/Emitter.d.ts:27
Unregister event.

Parameters
- type: string
  
  Event type.
- callback: IEmitterDelegate
  
  Registered callback.
Returns Object2D<T>

on

on(type: string, callback: IEmitterDelegate): Object2D<T>

Inherited from DisplayObject.on
- Defined in node_modules/@tawaship/emitter/types/modules/Emitter.d.ts:13
Register event.

Parameters
- type: string
  
  Event type.
- callback: IEmitterDelegate
  
  Callback when the event fires.
Returns Object2D<T>

once

once(type: string, callback: IEmitterDelegate): Object2D<T>

Inherited from DisplayObject.once
- Defined in node_modules/@tawaship/emitter/types/modules/Emitter.d.ts:20
Register one-time event.

Parameters
- type: string
  
  Event type.
- callback: IEmitterDelegate
  
  Callback when the event fires.
Returns Object2D<T>

removeChild

removeChild(object: DisplayObject<Object3D>): undefined | DisplayObject<Object3D>

Inherited from DisplayObject.removeChild
- Defined in src/DisplayObject.ts:180
Parameters
- object: DisplayObject<Object3D>
Returns undefined | DisplayObject<Object3D>

update

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

Inherited from DisplayObject.update
- Defined in src/DisplayObject.ts:147
Parameters
- e: ITickerData
- taskDisabledChildren: boolean
Returns void

updateBoundingBox

updateBoundingBox(): void

Inherited from DisplayObject.updateBoundingBox
- Defined in src/DisplayObject.ts:160
Returns void

updateTask

updateTask(e: ITickerData): void

Inherited from DisplayObject.updateTask
- Defined in src/DisplayObject.ts:90
Parameters
- e: ITickerData
Returns void

updateTransform

updateTransform(): void

Overrides DisplayObject.updateTransform
- Defined in src/Object2D.ts:25
Returns void

Generated using TypeDoc