Class: ColliderComponent ​

collider component

Hierarchy ​

• ComponentBase

  ↳ ColliderComponent

Constructors ​

• constructor

Accessors ​

• shape
• transform
• enable

Properties ​

• object3D

Methods ​

• init
• stop
• onEnable
• onDisable
• onUpdate
• onLateUpdate
• onBeforeUpdate
• onCompute
• onGraphic
• onParentChange
• cloneTo

Constructors ​

constructor ​

• new ColliderComponent()

Overrides ​

ComponentBase.constructor

Defined in ​

src/components/ColliderComponent.ts:15

Accessors ​

shape ​

• get shape(): ColliderShape

Returns the shape of collider

Returns ​

ColliderShape

Defined in ​

src/components/ColliderComponent.ts:31

• set shape(value): void

Set the shape of collider

Parameters ​

Returns ​

void

Defined in ​

src/components/ColliderComponent.ts:38

transform ​

• get transform(): Transform

Return the Transform component attached to the Object3D.

Returns ​

Transform

Inherited from ​

ComponentBase.transform

Defined in ​

src/components/ComponentBase.ts:38

enable ​

• get enable(): boolean

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

Returns ​

boolean

Inherited from ​

ComponentBase.enable

Defined in ​

src/components/ComponentBase.ts:59

• set enable(value): void

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

Parameters ​

Returns ​

void

Inherited from ​

ComponentBase.enable

Defined in ​

src/components/ComponentBase.ts:45

Properties ​

object3D ​

• object3D: Object3D = null

owner object3D

Inherited from ​

ComponentBase.object3D

Defined in ​

src/components/ComponentBase.ts:17

Methods ​

init ​

▸ init(param?): void

Parameters ​

Returns ​

void

Inherited from ​

ComponentBase.init

Defined in ​

src/components/ComponentBase.ts:106

stop ​

▸ stop(): void

Returns ​

void

Inherited from ​

ComponentBase.stop

Defined in ​

src/components/ComponentBase.ts:108

onEnable ​

▸ Optional onEnable(view?): any

Parameters ​

Returns ​

any

Inherited from ​

ComponentBase.onEnable

Defined in ​

src/components/ComponentBase.ts:109

onDisable ​

▸ Optional onDisable(view?): any

Parameters ​

Returns ​

any

Inherited from ​

ComponentBase.onDisable

Defined in ​

src/components/ComponentBase.ts:110

onUpdate ​

▸ Optional onUpdate(view?): any

Parameters ​

Returns ​

any

Inherited from ​

ComponentBase.onUpdate

Defined in ​

src/components/ComponentBase.ts:111

onLateUpdate ​

▸ Optional onLateUpdate(view?): any

Parameters ​

Returns ​

any

Inherited from ​

ComponentBase.onLateUpdate

Defined in ​

src/components/ComponentBase.ts:112

onBeforeUpdate ​

▸ Optional onBeforeUpdate(view?): any

Parameters ​

Returns ​

any

Inherited from ​

ComponentBase.onBeforeUpdate

Defined in ​

src/components/ComponentBase.ts:113

onCompute ​

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

Parameters ​

Returns ​

any

Inherited from ​

ComponentBase.onCompute

Defined in ​

src/components/ComponentBase.ts:114

onGraphic ​

▸ Optional onGraphic(view?): any

Parameters ​

Returns ​

any

Inherited from ​

ComponentBase.onGraphic

Defined in ​

src/components/ComponentBase.ts:115

onParentChange ​

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

Parameters ​

Returns ​

any

Inherited from ​

ComponentBase.onParentChange

Defined in ​

src/components/ComponentBase.ts:116

cloneTo ​

▸ cloneTo(obj): void

clone component data to target object3D

Parameters ​

Returns ​

void

Inherited from ​

ComponentBase.cloneTo

Defined in ​

src/components/ComponentBase.ts:123