Class: UIInteractive

The basic class of interactive GUI component

Hierarchy

• UIComponentBase

  ↳ UIInteractive

  ↳↳ UIButton

Implements

• IUIInteractive

Constructors

• constructor

Properties

• object3D
• isDestroyed

Accessors

• eventDispatcher
• isStart
• transform
• enable
• uiTransform
• visible
• interactive
• mouseStyle
• interactiveVisible

Methods

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

Constructors

constructor

• new UIInteractive(): UIInteractive

Returns

UIInteractive

Inherited from

UIComponentBase.constructor

Properties

object3D

• object3D: Object3D = null

owner object3D

Implementation of

IUIInteractive.object3D

Inherited from

UIComponentBase.object3D

Defined in

src/components/ComponentBase.ts:17

---

isDestroyed

• Optional isDestroyed: boolean

Inherited from

UIComponentBase.isDestroyed

Defined in

src/components/ComponentBase.ts:38

Accessors

eventDispatcher

• get eventDispatcher(): CEventDispatcher

Returns

CEventDispatcher

Inherited from

UIComponentBase.eventDispatcher

Defined in

src/components/ComponentBase.ts:23

• set eventDispatcher(value): void

Parameters

Name	Type
value	CEventDispatcher

Returns

void

Inherited from

UIComponentBase.eventDispatcher

Defined in

src/components/ComponentBase.ts:28

---

isStart

• get isStart(): boolean

Returns

boolean

Inherited from

UIComponentBase.isStart

Defined in

src/components/ComponentBase.ts:40

---

transform

• get transform(): Transform

Return the Transform component attached to the Object3D.

Returns

Transform

Inherited from

UIComponentBase.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

IUIInteractive.enable

Inherited from

UIComponentBase.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

Name	Type
value	boolean

Returns

void

Implementation of

IUIInteractive.enable

Inherited from

UIComponentBase.enable

Defined in

src/components/ComponentBase.ts:54

---

uiTransform

• get uiTransform(): UITransform

Returns

UITransform

Inherited from

UIComponentBase.uiTransform

Defined in

src/components/gui/uiComponents/UIComponentBase.ts:16

---

visible

• get visible(): boolean

Returns

boolean

Implementation of

IUIInteractive.visible

Inherited from

UIComponentBase.visible

Defined in

src/components/gui/uiComponents/UIComponentBase.ts:20

• set visible(value): void

Parameters

Name	Type
value	boolean

Returns

void

Implementation of

IUIInteractive.visible

Inherited from

UIComponentBase.visible

Defined in

src/components/gui/uiComponents/UIComponentBase.ts:24

---

interactive

• get interactive(): boolean

Returns

boolean

Implementation of

IUIInteractive.interactive

Defined in

src/components/gui/uiComponents/UIInteractive.ts:23

• set interactive(value): void

Parameters

Name	Type
value	boolean

Returns

void

Implementation of

IUIInteractive.interactive

Defined in

src/components/gui/uiComponents/UIInteractive.ts:19

---

mouseStyle

• set mouseStyle(value): void

Parameters

Name	Type
value	UIInteractiveStyle

Returns

void

Implementation of

IUIInteractive.mouseStyle

Defined in

src/components/gui/uiComponents/UIInteractive.ts:27

---

interactiveVisible

• get interactiveVisible(): boolean

Returns

boolean

Implementation of

IUIInteractive.interactiveVisible

Defined in

src/components/gui/uiComponents/UIInteractive.ts:31

Methods

start

▸ start(): void

Returns

void

Inherited from

UIComponentBase.start

Defined in

src/components/ComponentBase.ts:113

---

stop

▸ stop(): void

Returns

void

Inherited from

UIComponentBase.stop

Defined in

src/components/ComponentBase.ts:114

---

onEnable

▸ onEnable(view?): any

Parameters

Name	Type
view?	View3D

Returns

any

Inherited from

UIComponentBase.onEnable

Defined in

src/components/ComponentBase.ts:115

---

onDisable

▸ onDisable(view?): any

Parameters

Name	Type
view?	View3D

Returns

any

Inherited from

UIComponentBase.onDisable

Defined in

src/components/ComponentBase.ts:116

---

onUpdate

▸ onUpdate(view?): any

Parameters

Name	Type
view?	View3D

Returns

any

Inherited from

UIComponentBase.onUpdate

Defined in

src/components/ComponentBase.ts:117

---

onLateUpdate

▸ onLateUpdate(view?): any

Parameters

Name	Type
view?	View3D

Returns

any

Inherited from

UIComponentBase.onLateUpdate

Defined in

src/components/ComponentBase.ts:118

---

onBeforeUpdate

▸ onBeforeUpdate(view?): any

Parameters

Name	Type
view?	View3D

Returns

any

Inherited from

UIComponentBase.onBeforeUpdate

Defined in

src/components/ComponentBase.ts:119

---

onCompute

▸ onCompute(view?, command?): any

Parameters

Name	Type
view?	View3D
command?	GPUCommandEncoder

Returns

any

Inherited from

UIComponentBase.onCompute

Defined in

src/components/ComponentBase.ts:120

---

onGraphic

▸ onGraphic(view?): any

Parameters

Name	Type
view?	View3D

Returns

any

Inherited from

UIComponentBase.onGraphic

Defined in

src/components/ComponentBase.ts:121

---

onParentChange

▸ onParentChange(lastParent?, currentParent?): any

Parameters

Name	Type
lastParent?	Object3D
currentParent?	Object3D

Returns

any

Inherited from

UIComponentBase.onParentChange

Defined in

src/components/ComponentBase.ts:122

---

onAddChild

▸ onAddChild(child): any

Parameters

Name	Type
child	Object3D

Returns

any

Inherited from

UIComponentBase.onAddChild

Defined in

src/components/ComponentBase.ts:123

---

onRemoveChild

▸ onRemoveChild(child): any

Parameters

Name	Type
child	Object3D

Returns

any

Inherited from

UIComponentBase.onRemoveChild

Defined in

src/components/ComponentBase.ts:124

---

beforeDestroy

▸ beforeDestroy(force?): void

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

Parameters

Name	Type
force?	boolean

Returns

void

Inherited from

UIComponentBase.beforeDestroy

Defined in

src/components/ComponentBase.ts:200

---

init

▸ init(param?): void

Parameters

Name	Type
param?	any

Returns

void

Overrides

UIComponentBase.init

Defined in

src/components/gui/uiComponents/UIInteractive.ts:35

---

destroy

▸ destroy(): void

release this component

Returns

void

Implementation of

IUIInteractive.destroy

Overrides

UIComponentBase.destroy

Defined in

src/components/gui/uiComponents/UIInteractive.ts:40

---

rayPick

▸ rayPick(ray, panel, screenPos, screenSize): HitInfo

Parameters

Name	Type
ray	Ray
panel	UIPanel
screenPos	Vector2
screenSize	Vector2

Returns

HitInfo

Implementation of

IUIInteractive.rayPick

Defined in

src/components/gui/uiComponents/UIInteractive.ts:45

---

cloneTo

▸ cloneTo(obj): void

clone component data to target object3D

Parameters

Name	Type	Description
obj	Object3D	target object3D

Returns

void

Overrides

UIComponentBase.cloneTo

Defined in

src/components/gui/uiComponents/UIInteractive.ts:49

---

copyComponent

▸ copyComponent(from): this

Parameters

Name	Type
from	this

Returns

this

Overrides

UIComponentBase.copyComponent

Defined in

src/components/gui/uiComponents/UIInteractive.ts:54