Skip to content
本页内容

Class: UITransform

组件用于在实体对象上附加功能。组件可以在每个帧接收更新事件。

Hierarchy

Properties

Accessors

Methods

Constructors

Properties

object3D

object3D: Object3D = null

此组件附加到的Object3D对象。

Inherited from

ComponentBase.object3D

Defined in

src/engine/components/ComponentBase.ts:14


serializeTag

Optional serializeTag: SerializeTag

Inherited from

ComponentBase.serializeTag

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

Transform

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

NameType
valueboolean

Returns

void

Inherited from

ComponentBase.enable

Defined in

src/engine/components/ComponentBase.ts:43


uiInteractiveList

get uiInteractiveList(): IUIInteractive[]

Returns

IUIInteractive[]

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

NameType
valuenumber

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

NameType
valuenumber

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

NameType
valuenumber

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

NameType
valuenumber

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

NameType
valuenumber

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

NameType
valueboolean

Returns

void

Defined in

src/engine/gui/components/UITransform.ts:130

Methods

destroy

destroy(): void

移除组件时候调用

Returns

void

Inherited from

ComponentBase.destroy

Defined in

src/engine/components/ComponentBase.ts:119


onUpdate

onUpdate(call): void

添加更新函数。会在每帧更新时执行。

Parameters

NameTypeDescription
callFunction回调函数

Returns

void

Inherited from

ComponentBase.onUpdate

Defined in

src/engine/components/ComponentBase.ts:135


onLateUpdate

onLateUpdate(call): void

添加延迟更新函数。

Parameters

NameTypeDescription
callFunction回调函数

Returns

void

Inherited from

ComponentBase.onLateUpdate

Defined in

src/engine/components/ComponentBase.ts:148


onBeforeUpdate

onBeforeUpdate(call): void

添加帧更新前执行的函数。

Parameters

NameTypeDescription
callFunction回调函数

Returns

void

Inherited from

ComponentBase.onBeforeUpdate

Defined in

src/engine/components/ComponentBase.ts:161


serialization

serialization(assets): SerializeComponentBase

Parameters

NameType
assetsISerializeAssetsCollect

Returns

SerializeComponentBase

Inherited from

ComponentBase.serialization

Defined in

src/engine/components/ComponentBase.ts:170


unSerialization

unSerialization(componentData, data): void

Parameters

NameType
componentDataSerializeComponentBase
dataUnSerializeData

Returns

void

Inherited from

ComponentBase.unSerialization

Defined in

src/engine/components/ComponentBase.ts:175


addUIInteractive

addUIInteractive(item): void

Parameters

NameType
itemIUIInteractive

Returns

void

Defined in

src/engine/gui/components/UITransform.ts:25


removeUIInteractive

removeUIInteractive(item): IUIInteractive

Parameters

NameType
itemIUIInteractive

Returns

IUIInteractive

Defined in

src/engine/gui/components/UITransform.ts:30


onParentChange

onParentChange(parent): void

Parameters

NameType
parentObject3D

Returns

void

Defined in

src/engine/gui/components/UITransform.ts:41


resize

resize(width, height): boolean

Parameters

NameType
widthnumber
heightnumber

Returns

boolean

Defined in

src/engine/gui/components/UITransform.ts:54


onVisible

onVisible(value): void

Parameters

NameType
valueboolean

Returns

void

Overrides

ComponentBase.onVisible

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

NameTypeDescription
objObject3D源对象

Returns

void

Overrides

ComponentBase.cloneTo

Defined in

src/engine/gui/components/UITransform.ts:167


matrix

matrix(): Matrix3

Returns

Matrix3

Defined in

src/engine/gui/components/UITransform.ts:183


worldMatrix

worldMatrix(): Matrix3

Returns

Matrix3

Defined in

src/engine/gui/components/UITransform.ts:204

Constructors

constructor

new UITransform()

Overrides

ComponentBase.constructor

Defined in

src/engine/gui/components/UITransform.ts:161