Class: Transform

The Transform component contains the position, rotation, and scaling of an object in 3D space. Each object (Object 3D) has a Transform component

Hierarchy

• ComponentBase

  ↳ Transform

Constructors

• constructor

Properties

• object3D
• isDestroyed
• _localRot
• index
• index2
• _worldMatrix
• static
• depthOrder

Accessors

• eventDispatcher
• isStart
• transform
• localChange
• targetPos
• parent
• enable
• scene3D
• view3D
• up
• down
• forward
• back
• left
• right
• localRotQuat
• x
• y
• z
• scaleX
• scaleY
• scaleZ
• rotationX
• rotationY
• rotationZ
• worldPosition
• localPosition
• localRotation
• localScale
• localDetailScale
• localDetailRot
• localDetailPos

Methods

• init
• onEnable
• onDisable
• onUpdate
• onLateUpdate
• onBeforeUpdate
• onCompute
• onGraphic
• onParentChange
• copyComponent
• awake
• start
• stop
• updateWorldMatrix
• updateChildTransform
• lookTarget
• lookAt
• decomposeFromMatrix
• cloneTo
• beforeDestroy
• destroy

Constructors

constructor

• new Transform(): Transform

Returns

Transform

Overrides

ComponentBase.constructor

Defined in

src/components/Transform.ts:205

Properties

object3D

• object3D: Object3D = null

owner object3D

Inherited from

ComponentBase.object3D

Defined in

src/components/ComponentBase.ts:17

---

isDestroyed

• Optional isDestroyed: boolean

Inherited from

ComponentBase.isDestroyed

Defined in

src/components/ComponentBase.ts:38

---

_localRot

• _localRot: Vector3

Defined in

src/components/Transform.ts:96

---

index

• index: number

Defined in

src/components/Transform.ts:106

---

index2

• index2: number

Defined in

src/components/Transform.ts:107

---

_worldMatrix

• Readonly _worldMatrix: Matrix4

Defined in

src/components/Transform.ts:118

---

static

• static: boolean = false

Defined in

src/components/Transform.ts:121

---

depthOrder

• depthOrder: number = 0

Defined in

src/components/Transform.ts:122

Accessors

eventDispatcher

• get eventDispatcher(): CEventDispatcher

Returns

CEventDispatcher

Inherited from

ComponentBase.eventDispatcher

Defined in

src/components/ComponentBase.ts:23

• set eventDispatcher(value): void

Parameters

Name	Type
value	CEventDispatcher

Returns

void

Inherited from

ComponentBase.eventDispatcher

Defined in

src/components/ComponentBase.ts:28

---

isStart

• get isStart(): boolean

Returns

boolean

Inherited from

ComponentBase.isStart

Defined in

src/components/ComponentBase.ts:40

---

transform

• get transform(): Transform

Return the Transform component attached to the Object3D.

Returns

Transform

Inherited from

ComponentBase.transform

Defined in

src/components/ComponentBase.ts:47

---

localChange

• get localChange(): boolean

Returns

boolean

Defined in

src/components/Transform.ts:124

• set localChange(value): void

Parameters

Name	Type
value	boolean

Returns

void

Defined in

src/components/Transform.ts:128

---

targetPos

• get targetPos(): Vector3

Returns

Vector3

Defined in

src/components/Transform.ts:133

• set targetPos(value): void

Parameters

Name	Type
value	Vector3

Returns

void

Defined in

src/components/Transform.ts:136

---

parent

• get parent(): Transform

Returns

Transform

Defined in

src/components/Transform.ts:140

• set parent(value): void

Parameters

Name	Type
value	Transform

Returns

void

Defined in

src/components/Transform.ts:144

---

enable

• get enable(): boolean

Enable/disable components. The enabled components can be updated, while the disabled components cannot be updated.

Returns

boolean

Overrides

ComponentBase.enable

Defined in

src/components/Transform.ts:186

• set enable(value): void

Enable/disable components. The enabled components can be updated, while the disabled components cannot be updated.

Parameters

Name	Type
value	boolean

Returns

void

Overrides

ComponentBase.enable

Defined in

src/components/Transform.ts:176

---

scene3D

• get scene3D(): Scene3D

Returns

Scene3D

Defined in

src/components/Transform.ts:190

• set scene3D(value): void

Parameters

Name	Type
value	Scene3D

Returns

void

Defined in

src/components/Transform.ts:194

---

view3D

• get view3D(): View3D

Returns

View3D

Defined in

src/components/Transform.ts:198

---

up

• get up(): Vector3

Returns

Vector3

Defined in

src/components/Transform.ts:243

• set up(value): void

Parameters

Name	Type
value	Vector3

Returns

void

Defined in

src/components/Transform.ts:248

---

down

• get down(): Vector3

Returns

Vector3

Defined in

src/components/Transform.ts:255

• set down(value): void

Parameters

Name	Type
value	Vector3

Returns

void

Defined in

src/components/Transform.ts:260

---

forward

• get forward(): Vector3

Returns

Vector3

Defined in

src/components/Transform.ts:274

• set forward(value): void

Parameters

Name	Type
value	Vector3

Returns

void

Defined in

src/components/Transform.ts:279

---

back

• get back(): Vector3

Returns

Vector3

Defined in

src/components/Transform.ts:293

• set back(value): void

Parameters

Name	Type
value	Vector3

Returns

void

Defined in

src/components/Transform.ts:298

---

left

• get left(): Vector3

Returns

Vector3

Defined in

src/components/Transform.ts:305

• set left(value): void

Parameters

Name	Type
value	Vector3

Returns

void

Defined in

src/components/Transform.ts:310

---

right

• get right(): Vector3

Returns

Vector3

Defined in

src/components/Transform.ts:317

• set right(value): void

Parameters

Name	Type
value	Vector3

Returns

void

Defined in

src/components/Transform.ts:322

---

localRotQuat

• get localRotQuat(): Quaternion

The transformation property of the object relative to the parent, stored in the from of a quaternion

Returns

Quaternion

Defined in

src/components/Transform.ts:340

• set localRotQuat(value): void

Parameters

Name	Type
value	Quaternion

Returns

void

Defined in

src/components/Transform.ts:344

---

x

• get x(): number

The position of the object relative to its parent X-axis

Returns

number

Defined in

src/components/Transform.ts:487

• set x(value): void

Parameters

Name	Type
value	number

Returns

void

Defined in

src/components/Transform.ts:471

---

y

• get y(): number

The position of the object relative to its parent Y-axis

Returns

number

Defined in

src/components/Transform.ts:507

• set y(value): void

Parameters

Name	Type
value	number

Returns

void

Defined in

src/components/Transform.ts:491

---

z

• get z(): number

The position of the object relative to its parent Y-axis

Returns

number

Defined in

src/components/Transform.ts:527

• set z(value): void

Parameters

Name	Type
value	number

Returns

void

Defined in

src/components/Transform.ts:511

---

scaleX

• get scaleX(): number

The scale of the object relative to its parent X-axis

Returns

number

Defined in

src/components/Transform.ts:547

• set scaleX(value): void

Parameters

Name	Type
value	number

Returns

void

Defined in

src/components/Transform.ts:531

---

scaleY

• get scaleY(): number

The scale of the object relative to its parent Y-axis

Returns

number

Defined in

src/components/Transform.ts:567

• set scaleY(value): void

Parameters

Name	Type
value	number

Returns

void

Defined in

src/components/Transform.ts:551

---

scaleZ

• get scaleZ(): number

The scale of the object relative to its parent Z-axis

Returns

number

Defined in

src/components/Transform.ts:588

• set scaleZ(value): void

Parameters

Name	Type
value	number

Returns

void

Defined in

src/components/Transform.ts:571

---

rotationX

• get rotationX(): number

The rotation of the object relative to its parent X-axis

Returns

number

Defined in

src/components/Transform.ts:608

• set rotationX(value): void

Parameters

Name	Type
value	number

Returns

void

Defined in

src/components/Transform.ts:592

---

rotationY

• get rotationY(): number

The rotation of the object relative to its parent Y-axis

Returns

number

Defined in

src/components/Transform.ts:628

• set rotationY(value): void

Parameters

Name	Type
value	number

Returns

void

Defined in

src/components/Transform.ts:612

---

rotationZ

• get rotationZ(): number

The rotation of the object relative to its parent Z-axis

Returns

number

Defined in

src/components/Transform.ts:648

• set rotationZ(value): void

Parameters

Name	Type
value	number

Returns

void

Defined in

src/components/Transform.ts:632

---

worldPosition

• get worldPosition(): Vector3

world position

Returns

Vector3

Defined in

src/components/Transform.ts:655

---

localPosition

• get localPosition(): Vector3

The position of an object relative to its parent

Returns

Vector3

Defined in

src/components/Transform.ts:678

• set localPosition(v): void

Parameters

Name	Type
v	Vector3

Returns

void

Defined in

src/components/Transform.ts:662

---

localRotation

• get localRotation(): Vector3

The rotaion vector of an object relative to its parent

Returns

Vector3

Defined in

src/components/Transform.ts:699

• set localRotation(v): void

Parameters

Name	Type
v	Vector3

Returns

void

Defined in

src/components/Transform.ts:682

---

localScale

• get localScale(): Vector3

The scale of an object relative to its parent

Returns

Vector3

Defined in

src/components/Transform.ts:720

• set localScale(v): void

Parameters

Name	Type
v	Vector3

Returns

void

Defined in

src/components/Transform.ts:703

---

localDetailScale

• get localDetailScale(): Vector3

Returns

Vector3

Defined in

src/components/Transform.ts:725

• set localDetailScale(value): void

Parameters

Name	Type
value	Vector3

Returns

void

Defined in

src/components/Transform.ts:729

---

localDetailRot

• get localDetailRot(): Vector3

Returns

Vector3

Defined in

src/components/Transform.ts:734

• set localDetailRot(value): void

Parameters

Name	Type
value	Vector3

Returns

void

Defined in

src/components/Transform.ts:738

---

localDetailPos

• get localDetailPos(): Vector3

Returns

Vector3

Defined in

src/components/Transform.ts:743

• set localDetailPos(value): void

Parameters

Name	Type
value	Vector3

Returns

void

Defined in

src/components/Transform.ts:746

Methods

init

▸ init(param?): void

Parameters

Name	Type
param?	any

Returns

void

Inherited from

ComponentBase.init

Defined in

src/components/ComponentBase.ts:112

---

onEnable

▸ onEnable(view?): any

Parameters

Name	Type
view?	View3D

Returns

any

Inherited from

ComponentBase.onEnable

Defined in

src/components/ComponentBase.ts:115

---

onDisable

▸ onDisable(view?): any

Parameters

Name	Type
view?	View3D

Returns

any

Inherited from

ComponentBase.onDisable

Defined in

src/components/ComponentBase.ts:116

---

onUpdate

▸ onUpdate(view?): any

Parameters

Name	Type
view?	View3D

Returns

any

Inherited from

ComponentBase.onUpdate

Defined in

src/components/ComponentBase.ts:117

---

onLateUpdate

▸ onLateUpdate(view?): any

Parameters

Name	Type
view?	View3D

Returns

any

Inherited from

ComponentBase.onLateUpdate

Defined in

src/components/ComponentBase.ts:118

---

onBeforeUpdate

▸ onBeforeUpdate(view?): any

Parameters

Name	Type
view?	View3D

Returns

any

Inherited from

ComponentBase.onBeforeUpdate

Defined in

src/components/ComponentBase.ts:119

---

onCompute

▸ onCompute(view?, command?): any

Parameters

Name	Type
view?	View3D
command?	GPUCommandEncoder

Returns

any

Inherited from

ComponentBase.onCompute

Defined in

src/components/ComponentBase.ts:120

---

onGraphic

▸ onGraphic(view?): any

Parameters

Name	Type
view?	View3D

Returns

any

Inherited from

ComponentBase.onGraphic

Defined in

src/components/ComponentBase.ts:121

---

onParentChange

▸ onParentChange(lastParent?, currentParent?): any

Parameters

Name	Type
lastParent?	Object3D
currentParent?	Object3D

Returns

any

Inherited from

ComponentBase.onParentChange

Defined in

src/components/ComponentBase.ts:122

---

copyComponent

▸ copyComponent(from): this

Parameters

Name	Type
from	this

Returns

this

Inherited from

ComponentBase.copyComponent

Defined in

src/components/ComponentBase.ts:131

---

awake

▸ awake(): void

Returns

void

Defined in

src/components/Transform.ts:220

---

start

▸ start(): void

Returns

void

Overrides

ComponentBase.start

Defined in

src/components/Transform.ts:222

---

stop

▸ stop(): void

Returns

void

Overrides

ComponentBase.stop

Defined in

src/components/Transform.ts:224

---

updateWorldMatrix

▸ updateWorldMatrix(force?): void

Update the matrix4 in world space

Parameters

Name	Type	Default value
force	boolean	false

Returns

void

Defined in

src/components/Transform.ts:394

---

updateChildTransform

▸ updateChildTransform(): void

Returns

void

Defined in

src/components/Transform.ts:406

---

lookTarget

▸ lookTarget(target, up?): void

Parameters

Name	Type	Default value
target	Vector3	undefined
up	Vector3	Vector3.UP

Returns

void

Defined in

src/components/Transform.ts:422

---

lookAt

▸ lookAt(pos, target, up?): void

Current object's gaze position (global) (modified by its own global transformation)

Parameters

Name	Type	Default value	Description
pos	Vector3	undefined	Own position (global)
target	Vector3	undefined	Location of the target (global)
up	Vector3	Vector3.UP	up direction

Returns

void

Defined in

src/components/Transform.ts:432

---

decomposeFromMatrix

▸ decomposeFromMatrix(matrix, orientationStyle?): this

Parameters

Name	Type	Default value
matrix	Matrix4	undefined
orientationStyle	string	'eulerAngles'

Returns

this

Defined in

src/components/Transform.ts:448

---

cloneTo

▸ cloneTo(obj): void

Create a new component, copy the properties of the current component, and add it to the target object.

Parameters

Name	Type	Description
obj	Object3D	source Object3D

Returns

void

Overrides

ComponentBase.cloneTo

Defined in

src/components/Transform.ts:465

---

beforeDestroy

▸ beforeDestroy(force?): void

before release this component, object refrences are not be set null now.

Parameters

Name	Type
force?	boolean

Returns

void

Overrides

ComponentBase.beforeDestroy

Defined in

src/components/Transform.ts:752

---

destroy

▸ destroy(): void

release this component

Returns

void

Overrides

ComponentBase.destroy

Defined in

src/components/Transform.ts:759