Class: UICanvas
组件用于在实体对象上附加功能。组件可以在每个帧接收更新事件。
Hierarchy
↳
UICanvas
Properties
Constructors
Accessors
Methods
- onVisible
- destroy
- onUpdate
- onLateUpdate
- onBeforeUpdate
- serialization
- unSerialization
- addGUIChild
- update
- rebuildGUIMesh
- cloneTo
Properties
object3D
• object3D: Object3D
= null
此组件附加到的Object3D对象。
Inherited from
Defined in
src/engine/components/ComponentBase.ts:14
serializeTag
• Optional
serializeTag: SerializeTag
Inherited from
Defined in
src/engine/components/ComponentBase.ts:30
camera
• camera: Camera3D
Defined in
src/engine/gui/core/UICanvas.ts:16
Constructors
constructor
• new UICanvas()
Inherited from
Defined in
src/engine/components/ComponentBase.ts:32
Accessors
transform
• get
transform(): Transform
附加到此 Object3D对象 的 Transform组件。
Returns
Inherited from
ComponentBase.transform
Defined in
src/engine/components/ComponentBase.ts:39
enable
• get
enable(): boolean
启用/禁用 组件。启用的组件可更新,禁用的组件不可更新。
Returns
boolean
Inherited from
ComponentBase.enable
Defined in
src/engine/components/ComponentBase.ts:62
• set
enable(value
): void
Parameters
Name | Type |
---|---|
value | boolean |
Returns
void
Inherited from
ComponentBase.enable
Defined in
src/engine/components/ComponentBase.ts:43
Methods
onVisible
▸ onVisible(value
): void
Parameters
Name | Type |
---|---|
value | boolean |
Returns
void
Inherited from
Defined in
src/engine/components/ComponentBase.ts:66
destroy
▸ destroy(): void
移除组件时候调用
Returns
void
Inherited from
Defined in
src/engine/components/ComponentBase.ts:119
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
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
Defined in
src/engine/components/ComponentBase.ts:175
addGUIChild
▸ addGUIChild(child
): void
Parameters
Name | Type |
---|---|
child | Object3D |
Returns
void
Defined in
src/engine/gui/core/UICanvas.ts:23
update
▸ update(): void
Returns
void
Overrides
ComponentBase.update
Defined in
src/engine/gui/core/UICanvas.ts:27
rebuildGUIMesh
▸ rebuildGUIMesh(): void
Returns
void
Defined in
src/engine/gui/core/UICanvas.ts:32
cloneTo
▸ cloneTo(obj
): void
创建新的组件,复制当前组件的属性,并添加到目标对象上。
Parameters
Name | Type | Description |
---|---|---|
obj | Object3D | 源对象 |
Returns
void