Class: ComponentBase ​

Components are used to attach functionality to object3D, it has an owner object3D. The component can receive update events at each frame.

Hierarchy ​

• ComponentBase

  ↳ BillboardComponent

  ↳ ColliderComponent

  ↳ SkeletonAnimationComponent

  ↳ Transform

  ↳ PropertyAnimation

  ↳ MorphTargetBlender

  ↳ FlyCameraController

  ↳ HoverCameraController

  ↳ OrbitController

  ↳ GUICanvas

  ↳ UIComponentBase

  ↳ UITransform

  ↳ PostProcessingComponent

  ↳ GlobalIlluminationComponent

  ↳ Camera3D

Implements ​

• IComponent

Constructors ​

• constructor

Properties ​

• object3D
• isDestroyed

Accessors ​

• eventDispatcher
• isStart
• transform
• enable

Methods ​

• init
• start
• stop
• onEnable
• onDisable
• onUpdate
• onLateUpdate
• onBeforeUpdate
• onCompute
• onGraphic
• onParentChange
• cloneTo
• copyComponent
• beforeDestroy
• destroy

Constructors ​

constructor ​

• new ComponentBase()

Properties ​

object3D ​

• object3D: Object3D = null

owner object3D

Implementation of ​

IComponent.object3D

Defined in ​

src/components/ComponentBase.ts:17

isDestroyed ​

• Optional isDestroyed: boolean

Implementation of ​

IComponent.isDestroyed

Defined in ​

src/components/ComponentBase.ts:38

Accessors ​

eventDispatcher ​

• get eventDispatcher(): CEventDispatcher

Returns ​

CEventDispatcher

Implementation of ​

IComponent.eventDispatcher

Defined in ​

src/components/ComponentBase.ts:23

• set eventDispatcher(value): void

Parameters ​

Returns ​

void

Implementation of ​

IComponent.eventDispatcher

Defined in ​

src/components/ComponentBase.ts:28

isStart ​

• get isStart(): boolean

Returns ​

boolean

Defined in ​

src/components/ComponentBase.ts:40

transform ​

• get transform(): Transform

Return the Transform component attached to the Object3D.

Returns ​

Transform

Implementation of ​

IComponent.transform

Defined in ​

src/components/ComponentBase.ts:47

enable ​

• get enable(): boolean

Enable/disable components. The enabled components can be updated, while the disabled components cannot be updated.

Returns ​

boolean

Implementation of ​

IComponent.enable

Defined in ​

src/components/ComponentBase.ts:68

• set enable(value): void

Enable/disable components. The enabled components can be updated, while the disabled components cannot be updated.

Parameters ​

Returns ​

void

Implementation of ​

IComponent.enable

Defined in ​

src/components/ComponentBase.ts:54

Methods ​

init ​

▸ init(param?): void

Parameters ​

Returns ​

void

Implementation of ​

IComponent.init

Defined in ​

src/components/ComponentBase.ts:112

start ​

▸ start(): void

Returns ​

void

Implementation of ​

IComponent.start

Defined in ​

src/components/ComponentBase.ts:113

stop ​

▸ stop(): void

Returns ​

void

Implementation of ​

IComponent.stop

Defined in ​

src/components/ComponentBase.ts:114

onEnable ​

▸ Optional onEnable(view?): any

Parameters ​

Returns ​

any

Implementation of ​

IComponent.onEnable

Defined in ​

src/components/ComponentBase.ts:115

onDisable ​

▸ Optional onDisable(view?): any

Parameters ​

Returns ​

any

Implementation of ​

IComponent.onDisable

Defined in ​

src/components/ComponentBase.ts:116

onUpdate ​

▸ Optional onUpdate(view?): any

Parameters ​

Returns ​

any

Implementation of ​

IComponent.onUpdate

Defined in ​

src/components/ComponentBase.ts:117

onLateUpdate ​

▸ Optional onLateUpdate(view?): any

Parameters ​

Returns ​

any

Implementation of ​

IComponent.onLateUpdate

Defined in ​

src/components/ComponentBase.ts:118

onBeforeUpdate ​

▸ Optional onBeforeUpdate(view?): any

Parameters ​

Returns ​

any

Implementation of ​

IComponent.onBeforeUpdate

Defined in ​

src/components/ComponentBase.ts:119

onCompute ​

▸ Optional onCompute(view?, command?): any

Parameters ​

Returns ​

any

Implementation of ​

IComponent.onCompute

Defined in ​

src/components/ComponentBase.ts:120

onGraphic ​

▸ Optional onGraphic(view?): any

Parameters ​

Returns ​

any

Implementation of ​

IComponent.onGraphic

Defined in ​

src/components/ComponentBase.ts:121

onParentChange ​

▸ Optional onParentChange(lastParent?, currentParent?): any

Parameters ​

Returns ​

any

Implementation of ​

IComponent.onParentChange

Defined in ​

src/components/ComponentBase.ts:122

cloneTo ​

▸ cloneTo(obj): void

clone component data to target object3D

Parameters ​

Returns ​

void

Implementation of ​

IComponent.cloneTo

Defined in ​

src/components/ComponentBase.ts:129

copyComponent ​

▸ copyComponent(from): ComponentBase

Parameters ​

Returns ​

ComponentBase

Defined in ​

src/components/ComponentBase.ts:131

beforeDestroy ​

▸ beforeDestroy(force?): void

before release this component, object refrences are not be set null now.

Parameters ​

Returns ​

void

Implementation of ​

IComponent.beforeDestroy

Defined in ​

src/components/ComponentBase.ts:198

destroy ​

▸ destroy(force?): void

release this component

Parameters ​

Returns ​

void

Implementation of ​

IComponent.destroy

Defined in ​

src/components/ComponentBase.ts:205