Class: UIInteractive
组件用于在实体对象上附加功能。组件可以在每个帧接收更新事件。
Hierarchy
↳
UIInteractive
↳↳
UIButton
Implements
Properties
Accessors
Methods
- onVisible
- onUpdate
- onLateUpdate
- onBeforeUpdate
- serialization
- unSerialization
- addQuad
- clean
- destroy
- rayPick
- cloneTo
Constructors
Properties
object3D
• object3D: Object3D
= null
此组件附加到的Object3D对象。
Implementation of
Inherited from
Defined in
src/engine/components/ComponentBase.ts:14
serializeTag
• Optional
serializeTag: SerializeTag
Inherited from
Defined in
src/engine/components/ComponentBase.ts:30
Accessors
transform
• get
transform(): Transform
附加到此 Object3D对象 的 Transform组件。
Returns
Inherited from
UIComponentBase.transform
Defined in
src/engine/components/ComponentBase.ts:39
enable
• get
enable(): boolean
启用/禁用 组件。启用的组件可更新,禁用的组件不可更新。
Returns
boolean
Implementation of
Inherited from
UIComponentBase.enable
Defined in
src/engine/components/ComponentBase.ts:62
• set
enable(value
): void
Parameters
Name | Type |
---|---|
value | boolean |
Returns
void
Implementation of
Inherited from
UIComponentBase.enable
Defined in
src/engine/components/ComponentBase.ts:43
uiTransform
• get
uiTransform(): UITransform
Returns
Inherited from
UIComponentBase.uiTransform
Defined in
src/engine/gui/components/UIComponentBase.ts:6
interactive
• get
interactive(): boolean
Returns
boolean
Implementation of
Defined in
src/engine/gui/components/UIInteractive.ts:14
• set
interactive(value
): void
Parameters
Name | Type |
---|---|
value | boolean |
Returns
void
Implementation of
Defined in
src/engine/gui/components/UIInteractive.ts:10
mouseStyle
• set
mouseStyle(value
): void
Parameters
Name | Type |
---|---|
value | UIInteractiveStyle |
Returns
void
Implementation of
IUIInteractive.mouseStyle
Defined in
src/engine/gui/components/UIInteractive.ts:18
Methods
onVisible
▸ onVisible(value
): void
Parameters
Name | Type |
---|---|
value | boolean |
Returns
void
Inherited from
Defined in
src/engine/components/ComponentBase.ts:66
onUpdate
▸ onUpdate(call
): void
添加更新函数。会在每帧更新时执行。
Parameters
Name | Type | Description |
---|---|---|
call | Function | 回调函数 |
Returns
void
Inherited from
Defined in
src/engine/components/ComponentBase.ts:135
onLateUpdate
▸ onLateUpdate(call
): void
添加延迟更新函数。
Parameters
Name | Type | Description |
---|---|---|
call | Function | 回调函数 |
Returns
void
Inherited from
Defined in
src/engine/components/ComponentBase.ts:148
onBeforeUpdate
▸ onBeforeUpdate(call
): void
添加帧更新前执行的函数。
Parameters
Name | Type | Description |
---|---|---|
call | Function | 回调函数 |
Returns
void
Inherited from
UIComponentBase.onBeforeUpdate
Defined in
src/engine/components/ComponentBase.ts:161
serialization
▸ serialization(assets
): SerializeComponentBase
Parameters
Name | Type |
---|---|
assets | ISerializeAssetsCollect |
Returns
Inherited from
Defined in
src/engine/components/ComponentBase.ts:170
unSerialization
▸ unSerialization(componentData
, data
): void
Parameters
Name | Type |
---|---|
componentData | SerializeComponentBase |
data | UnSerializeData |
Returns
void
Inherited from
UIComponentBase.unSerialization
Defined in
src/engine/components/ComponentBase.ts:175
addQuad
▸ addQuad(quad
): void
Parameters
Name | Type |
---|---|
quad | GUIQuad |
Returns
void
Inherited from
Defined in
src/engine/gui/components/UIComponentBase.ts:28
clean
▸ clean(): void
Returns
void
Inherited from
Defined in
src/engine/gui/components/UIComponentBase.ts:32
destroy
▸ destroy(): void
移除组件时候调用
Returns
void
Implementation of
Overrides
Defined in
src/engine/gui/components/UIInteractive.ts:27
rayPick
▸ rayPick(ray
, screenPos
, screenSize
): Object
Parameters
Name | Type |
---|---|
ray | Ray |
screenPos | Vector2 |
screenSize | Vector2 |
Returns
Object
Name | Type |
---|---|
intersect | boolean |
intersectPoint? | Vector3 |
distance | number |
Implementation of
Defined in
src/engine/gui/components/UIInteractive.ts:32
cloneTo
▸ cloneTo(obj
): void
创建新的组件,复制当前组件的属性,并添加到目标对象上。
Parameters
Name | Type | Description |
---|---|---|
obj | Object3D | 源对象 |
Returns
void
Overrides
Defined in
src/engine/gui/components/UIInteractive.ts:37
Constructors
constructor
• new UIInteractive()