Class: UITransform
组件用于在实体对象上附加功能。组件可以在每个帧接收更新事件。
Hierarchy
↳
UITransform
Properties
Accessors
Methods
- destroy
- onUpdate
- onLateUpdate
- onBeforeUpdate
- serialization
- unSerialization
- addUIInteractive
- removeUIInteractive
- onParentChange
- resize
- onVisible
- markNeedsUpdateGUIMesh
- cloneTo
- matrix
- worldMatrix
Constructors
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
useParentPivot
• useParentPivot: boolean
= false
Defined in
src/engine/gui/components/UITransform.ts:6
parent
• parent: UITransform
Defined in
src/engine/gui/components/UITransform.ts:7
pivotX
• pivotX: number
= 0.5
Defined in
src/engine/gui/components/UITransform.ts:8
pivotY
• pivotY: number
= 0.5
Defined in
src/engine/gui/components/UITransform.ts:9
guiMesh
• guiMesh: GUIMesh
Defined in
src/engine/gui/components/UITransform.ts:13
EventUIResize
▪ Static
Readonly
EventUIResize: string
= 'EventUIResize'
Defined in
src/engine/gui/components/UITransform.ts:15
quads
• quads: GUIQuad
[] = []
Defined in
src/engine/gui/components/UITransform.ts:116
needUpdateQuads
• needUpdateQuads: boolean
= true
Defined in
src/engine/gui/components/UITransform.ts:122
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
uiInteractiveList
• get
uiInteractiveList(): IUIInteractive
[]
Returns
Defined in
src/engine/gui/components/UITransform.ts:21
width
• get
width(): number
Returns
number
Defined in
src/engine/gui/components/UITransform.ts:46
height
• get
height(): number
Returns
number
Defined in
src/engine/gui/components/UITransform.ts:50
x
• get
x(): number
Returns
number
Defined in
src/engine/gui/components/UITransform.ts:65
• set
x(value
): void
Parameters
Name | Type |
---|---|
value | number |
Returns
void
Defined in
src/engine/gui/components/UITransform.ts:69
y
• get
y(): number
Returns
number
Defined in
src/engine/gui/components/UITransform.ts:76
• set
y(value
): void
Parameters
Name | Type |
---|---|
value | number |
Returns
void
Defined in
src/engine/gui/components/UITransform.ts:80
z
• get
z(): number
Returns
number
Defined in
src/engine/gui/components/UITransform.ts:87
• set
z(value
): void
Parameters
Name | Type |
---|---|
value | number |
Returns
void
Defined in
src/engine/gui/components/UITransform.ts:91
scaleX
• get
scaleX(): number
Returns
number
Defined in
src/engine/gui/components/UITransform.ts:98
• set
scaleX(value
): void
Parameters
Name | Type |
---|---|
value | number |
Returns
void
Defined in
src/engine/gui/components/UITransform.ts:102
scaleY
• get
scaleY(): number
Returns
number
Defined in
src/engine/gui/components/UITransform.ts:107
• set
scaleY(value
): void
Parameters
Name | Type |
---|---|
value | number |
Returns
void
Defined in
src/engine/gui/components/UITransform.ts:111
onChange
• get
onChange(): boolean
Returns
boolean
Defined in
src/engine/gui/components/UITransform.ts:124
• set
onChange(value
): void
Parameters
Name | Type |
---|---|
value | boolean |
Returns
void
Defined in
src/engine/gui/components/UITransform.ts:130
Methods
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
addUIInteractive
▸ addUIInteractive(item
): void
Parameters
Name | Type |
---|---|
item | IUIInteractive |
Returns
void
Defined in
src/engine/gui/components/UITransform.ts:25
removeUIInteractive
▸ removeUIInteractive(item
): IUIInteractive
Parameters
Name | Type |
---|---|
item | IUIInteractive |
Returns
Defined in
src/engine/gui/components/UITransform.ts:30
onParentChange
▸ onParentChange(parent
): void
Parameters
Name | Type |
---|---|
parent | Object3D |
Returns
void
Defined in
src/engine/gui/components/UITransform.ts:41
resize
▸ resize(width
, height
): boolean
Parameters
Name | Type |
---|---|
width | number |
height | number |
Returns
boolean
Defined in
src/engine/gui/components/UITransform.ts:54
onVisible
▸ onVisible(value
): void
Parameters
Name | Type |
---|---|
value | boolean |
Returns
void
Overrides
Defined in
src/engine/gui/components/UITransform.ts:144
markNeedsUpdateGUIMesh
▸ markNeedsUpdateGUIMesh(): void
Returns
void
Defined in
src/engine/gui/components/UITransform.ts:150
cloneTo
▸ cloneTo(obj
): void
创建新的组件,复制当前组件的属性,并添加到目标对象上。
Parameters
Name | Type | Description |
---|---|---|
obj | Object3D | 源对象 |
Returns
void
Overrides
Defined in
src/engine/gui/components/UITransform.ts:167
matrix
▸ matrix(): Matrix3
Returns
Defined in
src/engine/gui/components/UITransform.ts:183
worldMatrix
▸ worldMatrix(): Matrix3
Returns
Defined in
src/engine/gui/components/UITransform.ts:204
Constructors
constructor
• new UITransform()