Class: Transform
Transform 组件上包含了一个对象在3D空间里的位置、旋转和缩放。 每一个对象(Object3D)都有一个Transform组件。
Hierarchy
↳
Transform
Properties
Accessors
- transform
- enable
- targetPos
- parent
- scene3d
- up
- down
- forward
- back
- left
- right
- localRotQuat
- x
- y
- z
- scaleX
- scaleY
- scaleZ
- rotationX
- rotationY
- rotationZ
- worldPosition
- localPosition
- localRotation
- localScale
Methods
- onVisible
- onUpdate
- onLateUpdate
- onBeforeUpdate
- awake
- start
- stop
- update
- lateUpdate
- updateWorldMatrix
- lookAt
- destroy
- decomposeFromMatrix
- cloneTo
- serialization
- unSerialization
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
_worldMatrix
• _worldMatrix: Matrix4
Defined in
src/engine/components/Transform.ts:103
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
targetPos
• get
targetPos(): Vector3
Returns
Defined in
src/engine/components/Transform.ts:110
• set
targetPos(value
): void
Parameters
Name | Type |
---|---|
value | Vector3 |
Returns
void
Defined in
src/engine/components/Transform.ts:113
parent
• get
parent(): Transform
Returns
Defined in
src/engine/components/Transform.ts:117
• set
parent(value
): void
Parameters
Name | Type |
---|---|
value | Transform |
Returns
void
Defined in
src/engine/components/Transform.ts:121
scene3d
• get
scene3d(): Scene3D
Returns
Defined in
src/engine/components/Transform.ts:132
• set
scene3d(value
): void
Parameters
Name | Type |
---|---|
value | Scene3D |
Returns
void
Defined in
src/engine/components/Transform.ts:136
up
• get
up(): Vector3
Returns
Defined in
src/engine/components/Transform.ts:191
• set
up(value
): void
Parameters
Name | Type |
---|---|
value | Vector3 |
Returns
void
Defined in
src/engine/components/Transform.ts:196
down
• get
down(): Vector3
Returns
Defined in
src/engine/components/Transform.ts:209
• set
down(value
): void
Parameters
Name | Type |
---|---|
value | Vector3 |
Returns
void
Defined in
src/engine/components/Transform.ts:214
forward
• get
forward(): Vector3
Returns
Defined in
src/engine/components/Transform.ts:227
• set
forward(value
): void
Parameters
Name | Type |
---|---|
value | Vector3 |
Returns
void
Defined in
src/engine/components/Transform.ts:232
back
• get
back(): Vector3
Returns
Defined in
src/engine/components/Transform.ts:247
• set
back(value
): void
Parameters
Name | Type |
---|---|
value | Vector3 |
Returns
void
Defined in
src/engine/components/Transform.ts:252
left
• get
left(): Vector3
Returns
Defined in
src/engine/components/Transform.ts:267
• set
left(value
): void
Parameters
Name | Type |
---|---|
value | Vector3 |
Returns
void
Defined in
src/engine/components/Transform.ts:272
right
• get
right(): Vector3
Returns
Defined in
src/engine/components/Transform.ts:285
• set
right(value
): void
Parameters
Name | Type |
---|---|
value | Vector3 |
Returns
void
Defined in
src/engine/components/Transform.ts:290
localRotQuat
• get
localRotQuat(): Quaternion
物体相对于父级变换属性,以四元数形式存储
Returns
Defined in
src/engine/components/Transform.ts:307
• set
localRotQuat(value
): void
Parameters
Name | Type |
---|---|
value | Quaternion |
Returns
void
Defined in
src/engine/components/Transform.ts:311
x
• get
x(): number
物体相对于父级X轴位置
Returns
number
Defined in
src/engine/components/Transform.ts:480
• set
x(value
): void
Parameters
Name | Type |
---|---|
value | number |
Returns
void
Defined in
src/engine/components/Transform.ts:462
y
• get
y(): number
物体相对于父级Y轴位置
Returns
number
Defined in
src/engine/components/Transform.ts:502
• set
y(value
): void
Parameters
Name | Type |
---|---|
value | number |
Returns
void
Defined in
src/engine/components/Transform.ts:484
z
• get
z(): number
物体相对于父级Z轴位置
Returns
number
Defined in
src/engine/components/Transform.ts:524
• set
z(value
): void
Parameters
Name | Type |
---|---|
value | number |
Returns
void
Defined in
src/engine/components/Transform.ts:506
scaleX
• get
scaleX(): number
物体相对于父级X轴的缩放
Returns
number
Defined in
src/engine/components/Transform.ts:542
• set
scaleX(value
): void
Parameters
Name | Type |
---|---|
value | number |
Returns
void
Defined in
src/engine/components/Transform.ts:528
scaleY
• get
scaleY(): number
物体相对于父级Y轴的缩放
Returns
number
Defined in
src/engine/components/Transform.ts:560
• set
scaleY(value
): void
Parameters
Name | Type |
---|---|
value | number |
Returns
void
Defined in
src/engine/components/Transform.ts:546
scaleZ
• get
scaleZ(): number
物体相对于父级Z轴的缩放
Returns
number
Defined in
src/engine/components/Transform.ts:579
• set
scaleZ(value
): void
Parameters
Name | Type |
---|---|
value | number |
Returns
void
Defined in
src/engine/components/Transform.ts:564
rotationX
• get
rotationX(): number
物体相对于父级的X轴旋转属性
Returns
number
Defined in
src/engine/components/Transform.ts:601
• set
rotationX(value
): void
Parameters
Name | Type |
---|---|
value | number |
Returns
void
Defined in
src/engine/components/Transform.ts:583
rotationY
• get
rotationY(): number
物体相对于父级的Y轴旋转属性
Returns
number
Defined in
src/engine/components/Transform.ts:623
• set
rotationY(value
): void
Parameters
Name | Type |
---|---|
value | number |
Returns
void
Defined in
src/engine/components/Transform.ts:605
rotationZ
• get
rotationZ(): number
物体相对于父级的Z轴旋转属性
Returns
number
Defined in
src/engine/components/Transform.ts:645
• set
rotationZ(value
): void
Parameters
Name | Type |
---|---|
value | number |
Returns
void
Defined in
src/engine/components/Transform.ts:627
worldPosition
• get
worldPosition(): Vector3
世界坐标系下物体位置
Returns
Defined in
src/engine/components/Transform.ts:652
localPosition
• get
localPosition(): Vector3
物体相对于父级的位置
Returns
Defined in
src/engine/components/Transform.ts:677
• set
localPosition(v
): void
Parameters
Name | Type |
---|---|
v | Vector3 |
Returns
void
Defined in
src/engine/components/Transform.ts:659
localRotation
• get
localRotation(): Vector3
物体相对于父级的旋转属性
Returns
Defined in
src/engine/components/Transform.ts:700
• set
localRotation(v
): void
Parameters
Name | Type |
---|---|
v | Vector3 |
Returns
void
Defined in
src/engine/components/Transform.ts:681
localScale
• get
localScale(): Vector3
物体相对于父级的缩放属性
Returns
Defined in
src/engine/components/Transform.ts:718
• set
localScale(v
): void
Parameters
Name | Type |
---|---|
v | Vector3 |
Returns
void
Defined in
src/engine/components/Transform.ts:704
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
Defined in
src/engine/components/ComponentBase.ts:161
awake
▸ awake(): void
Returns
void
Defined in
src/engine/components/Transform.ts:171
start
▸ start(): void
Returns
void
Overrides
ComponentBase.start
Defined in
src/engine/components/Transform.ts:173
stop
▸ stop(): void
Returns
void
Overrides
ComponentBase.stop
Defined in
src/engine/components/Transform.ts:175
update
▸ update(): void
Returns
void
Overrides
ComponentBase.update
Defined in
src/engine/components/Transform.ts:177
lateUpdate
▸ lateUpdate(): void
Returns
void
Overrides
ComponentBase.lateUpdate
Defined in
src/engine/components/Transform.ts:179
updateWorldMatrix
▸ updateWorldMatrix(force?
): void
更新世界空间矩阵
Parameters
Name | Type | Default value |
---|---|---|
force | boolean | false |
Returns
void
Defined in
src/engine/components/Transform.ts:365
lookAt
▸ lookAt(pos
, target
, up?
): void
当前对象对视位置 (全局) (修改的是自身的全局变换)
Parameters
Name | Type | Default value | Description |
---|---|---|---|
pos | Vector3 | undefined | 自身的位置 (全局) |
target | Vector3 | undefined | 目标的位置 (全局) |
up | Vector3 | Vector3.UP | 向上的方向 |
Returns
void
Defined in
src/engine/components/Transform.ts:390
destroy
▸ destroy(): void
移除组件时候调用
Returns
void
Overrides
Defined in
src/engine/components/Transform.ts:421
decomposeFromMatrix
▸ decomposeFromMatrix(matrix
, orientationStyle?
): Transform
Parameters
Name | Type | Default value |
---|---|---|
matrix | Matrix4 | undefined |
orientationStyle | string | 'eulerAngles' |
Returns
Defined in
src/engine/components/Transform.ts:434
cloneTo
▸ cloneTo(obj
): void
创建新的组件,复制当前组件的属性,并添加到目标对象上。
Parameters
Name | Type | Description |
---|---|---|
obj | Object3D | 源对象 |
Returns
void
Overrides
Defined in
src/engine/components/Transform.ts:456
serialization
▸ serialization(assets
): SerializeComponentBase
Parameters
Name | Type |
---|---|
assets | ISerializeAssetsCollect |
Returns
Overrides
Defined in
src/engine/components/Transform.ts:802
unSerialization
▸ unSerialization(componentData
, data
): void
Parameters
Name | Type |
---|---|
componentData | SerializeComponentBase |
data | UnSerializeData |
Returns
void
Overrides
Defined in
src/engine/components/Transform.ts:815
Constructors
constructor
• new Transform()