@orillusion/core

---

Class: Transform

Defined in: src/components/Transform.ts:20

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

Extends

• ComponentBase

Constructors

Constructor

new Transform(): Transform

Defined in: src/components/Transform.ts:214

Returns

Transform

Overrides

ComponentBase.constructor

Properties

object3D

object3D: Object3D = null

Defined in: src/components/ComponentBase.ts:29

owner object3D

Inherited from

ComponentBase.object3D

---

isDestroyed

isDestroyed: boolean = false

Defined in: src/components/ComponentBase.ts:77

Inherited from

ComponentBase.isDestroyed

---

_localRot

_localRot: Vector3

Defined in: src/components/Transform.ts:99

---

index

index: number

Defined in: src/components/Transform.ts:109

---

index2

index2: number

Defined in: src/components/Transform.ts:110

---

_worldMatrix

readonly _worldMatrix: Matrix4

Defined in: src/components/Transform.ts:121

---

static

static: boolean = false

Defined in: src/components/Transform.ts:124

---

depthOrder

depthOrder: number = 0

Defined in: src/components/Transform.ts:125

Accessors

visibleLayer

Get Signature

get visibleLayer(): number

Defined in: src/components/ComponentBase.ts:46

Composition-layer membership bitmask. The pass / camera / collector filters via

(component.visibleLayer & pass.layerMask & camera.cullingMask) !== 0

Defaults to VisibleLayer.Default (bit 0) so a fresh subclass is visible to passes whose layerMask is VisibleLayer.All (which includes bit 0). Application code can assign project-specific bits (1..31) to organise the scene into composition layers.

Returns

number

Set Signature

set visibleLayer(value): void

Defined in: src/components/ComponentBase.ts:50

Parameters

value

number

Returns

void

Inherited from

ComponentBase.visibleLayer

---

eventDispatcher

Get Signature

get eventDispatcher(): CEventDispatcher

Defined in: src/components/ComponentBase.ts:63

Returns

CEventDispatcher

Set Signature

set eventDispatcher(value): void

Defined in: src/components/ComponentBase.ts:68

Parameters

value

CEventDispatcher

Returns

void

Inherited from

ComponentBase.eventDispatcher

---

isStart

Get Signature

get isStart(): boolean

Defined in: src/components/ComponentBase.ts:79

Returns

boolean

Inherited from

ComponentBase.isStart

---

transform

Get Signature

get transform(): Transform

Defined in: src/components/ComponentBase.ts:89

Return the Transform component attached to the Object3D. Null before the component is attached — addComponent assigns object3D only after construction — so constructor-time callers can probe safely via this.transform?..

Returns

Transform

Inherited from

ComponentBase.transform

---

localChange

Get Signature

get localChange(): boolean

Defined in: src/components/Transform.ts:128

Whether the local transform is dirty and the world matrix needs recomputing.

Returns

boolean

Set Signature

set localChange(value): void

Defined in: src/components/Transform.ts:132

Parameters

value

boolean

Returns

void

---

targetPos

Get Signature

get targetPos(): Vector3

Defined in: src/components/Transform.ts:138

Optional look-at target position used by orientation helpers.

Returns

Vector3

Set Signature

set targetPos(value): void

Defined in: src/components/Transform.ts:141

Parameters

value

Vector3

Returns

void

---

parent

Get Signature

get parent(): Transform

Defined in: src/components/Transform.ts:146

Parent transform in the hierarchy, or null for a root.

Returns

Transform

Set Signature

set parent(value): void

Defined in: src/components/Transform.ts:150

Parameters

value

Transform

Returns

void

---

enable

Get Signature

get enable(): boolean

Defined in: src/components/Transform.ts:193

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

Returns

boolean

Set Signature

set enable(value): void

Defined in: src/components/Transform.ts:183

Enable state; propagates to all child transforms.

Parameters

value

boolean

Returns

void

Overrides

ComponentBase.enable

---

scene3D

Get Signature

get scene3D(): Scene3D

Defined in: src/components/Transform.ts:198

The scene this transform belongs to.

Returns

Scene3D

Set Signature

set scene3D(value): void

Defined in: src/components/Transform.ts:202

Parameters

value

Scene3D

Returns

void

---

view3D

Get Signature

get view3D(): View3D

Defined in: src/components/Transform.ts:207

The view associated with this transform's scene, or null.

Returns

View3D

---

up

Get Signature

get up(): Vector3

Defined in: src/components/Transform.ts:256

World-space up direction; setting it rotates the object to face that up.

Returns

Vector3

Set Signature

set up(value): void

Defined in: src/components/Transform.ts:261

Parameters

value

Vector3

Returns

void

---

down

Get Signature

get down(): Vector3

Defined in: src/components/Transform.ts:269

World-space down direction; setting it reorients the object.

Returns

Vector3

Set Signature

set down(value): void

Defined in: src/components/Transform.ts:274

Parameters

value

Vector3

Returns

void

---

forward

Get Signature

get forward(): Vector3

Defined in: src/components/Transform.ts:289

World-space forward direction; setting it reorients the object.

Returns

Vector3

Set Signature

set forward(value): void

Defined in: src/components/Transform.ts:294

Parameters

value

Vector3

Returns

void

---

back

Get Signature

get back(): Vector3

Defined in: src/components/Transform.ts:309

World-space back direction; setting it reorients the object.

Returns

Vector3

Set Signature

set back(value): void

Defined in: src/components/Transform.ts:314

Parameters

value

Vector3

Returns

void

---

left

Get Signature

get left(): Vector3

Defined in: src/components/Transform.ts:322

World-space left direction; setting it reorients the object.

Returns

Vector3

Set Signature

set left(value): void

Defined in: src/components/Transform.ts:327

Parameters

value

Vector3

Returns

void

---

right

Get Signature

get right(): Vector3

Defined in: src/components/Transform.ts:335

World-space right direction; setting it reorients the object.

Returns

Vector3

Set Signature

set right(value): void

Defined in: src/components/Transform.ts:340

Parameters

value

Vector3

Returns

void

---

localRotQuat

Get Signature

get localRotQuat(): Quaternion

Defined in: src/components/Transform.ts:358

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

Returns

Quaternion

Set Signature

set localRotQuat(value): void

Defined in: src/components/Transform.ts:365

Parameters

value

Quaternion

Returns

void

---

x

Get Signature

get x(): number

Defined in: src/components/Transform.ts:519

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

Returns

number

Set Signature

set x(value): void

Defined in: src/components/Transform.ts:503

Parameters

value

number

Returns

void

---

y

Get Signature

get y(): number

Defined in: src/components/Transform.ts:539

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

Returns

number

Set Signature

set y(value): void

Defined in: src/components/Transform.ts:523

Parameters

value

number

Returns

void

---

z

Get Signature

get z(): number

Defined in: src/components/Transform.ts:559

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

Returns

number

Set Signature

set z(value): void

Defined in: src/components/Transform.ts:543

Parameters

value

number

Returns

void

---

scaleX

Get Signature

get scaleX(): number

Defined in: src/components/Transform.ts:579

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

Returns

number

Set Signature

set scaleX(value): void

Defined in: src/components/Transform.ts:563

Parameters

value

number

Returns

void

---

scaleY

Get Signature

get scaleY(): number

Defined in: src/components/Transform.ts:599

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

Returns

number

Set Signature

set scaleY(value): void

Defined in: src/components/Transform.ts:583

Parameters

value

number

Returns

void

---

scaleZ

Get Signature

get scaleZ(): number

Defined in: src/components/Transform.ts:620

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

Returns

number

Set Signature

set scaleZ(value): void

Defined in: src/components/Transform.ts:603

Parameters

value

number

Returns

void

---

rotationX

Get Signature

get rotationX(): number

Defined in: src/components/Transform.ts:641

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

Returns

number

Set Signature

set rotationX(value): void

Defined in: src/components/Transform.ts:624

Parameters

value

number

Returns

void

---

rotationY

Get Signature

get rotationY(): number

Defined in: src/components/Transform.ts:662

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

Returns

number

Set Signature

set rotationY(value): void

Defined in: src/components/Transform.ts:645

Parameters

value

number

Returns

void

---

rotationZ

Get Signature

get rotationZ(): number

Defined in: src/components/Transform.ts:683

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

Returns

number

Set Signature

set rotationZ(value): void

Defined in: src/components/Transform.ts:666

Parameters

value

number

Returns

void

---

worldPosition

Get Signature

get worldPosition(): Vector3

Defined in: src/components/Transform.ts:690

world position

Returns

Vector3

---

localPosition

Get Signature

get localPosition(): Vector3

Defined in: src/components/Transform.ts:718

The position of an object relative to its parent

Returns

Vector3

Set Signature

set localPosition(v): void

Defined in: src/components/Transform.ts:697

Parameters

v

Vector3

Returns

void

---

localRotation

Get Signature

get localRotation(): Vector3

Defined in: src/components/Transform.ts:750

The rotaion vector of an object relative to its parent

Returns

Vector3

Set Signature

set localRotation(v): void

Defined in: src/components/Transform.ts:722

Parameters

v

Vector3

Returns

void

---

localScale

Get Signature

get localScale(): Vector3

Defined in: src/components/Transform.ts:771

The scale of an object relative to its parent

Returns

Vector3

Set Signature

set localScale(v): void

Defined in: src/components/Transform.ts:754

Parameters

v

Vector3

Returns

void

---

localDetailScale

Get Signature

get localDetailScale(): Vector3

Defined in: src/components/Transform.ts:777

Per-frame continuous scale delta auto-applied by the matrix solver.

Returns

Vector3

Set Signature

set localDetailScale(value): void

Defined in: src/components/Transform.ts:781

Parameters

value

Vector3

Returns

void

---

localDetailRot

Get Signature

get localDetailRot(): Vector3

Defined in: src/components/Transform.ts:787

Per-frame continuous rotation delta auto-applied by the matrix solver.

Returns

Vector3

Set Signature

set localDetailRot(value): void

Defined in: src/components/Transform.ts:791

Parameters

value

Vector3

Returns

void

---

localDetailPos

Get Signature

get localDetailPos(): Vector3

Defined in: src/components/Transform.ts:797

Per-frame continuous translation delta auto-applied by the matrix solver.

Returns

Vector3

Set Signature

set localDetailPos(value): void

Defined in: src/components/Transform.ts:800

Parameters

value

Vector3

Returns

void

Methods

init()

init(param?): void

Defined in: src/components/ComponentBase.ts:161

Parameters

param?

any

Returns

void

Inherited from

ComponentBase.init

---

onEnable()?

optional onEnable(view?): any

Defined in: src/components/ComponentBase.ts:164

Parameters

view?

View3D

Returns

any

Inherited from

ComponentBase.onEnable

---

onDisable()?

optional onDisable(view?): any

Defined in: src/components/ComponentBase.ts:165

Parameters

view?

View3D

Returns

any

Inherited from

ComponentBase.onDisable

---

onUpdate()?

optional onUpdate(view?): any

Defined in: src/components/ComponentBase.ts:166

Parameters

view?

View3D

Returns

any

Inherited from

ComponentBase.onUpdate

---

onLateUpdate()?

optional onLateUpdate(view?): any

Defined in: src/components/ComponentBase.ts:167

Parameters

view?

View3D

Returns

any

Inherited from

ComponentBase.onLateUpdate

---

onBeforeUpdate()?

optional onBeforeUpdate(view?): any

Defined in: src/components/ComponentBase.ts:168

Parameters

view?

View3D

Returns

any

Inherited from

ComponentBase.onBeforeUpdate

---

onCompute()?

optional onCompute(view?, command?): any

Defined in: src/components/ComponentBase.ts:169

Parameters

view?

View3D

command?

GPUCommandEncoder

Returns

any

Inherited from

ComponentBase.onCompute

---

onGraphic()?

optional onGraphic(view?): any

Defined in: src/components/ComponentBase.ts:170

Parameters

view?

View3D

Returns

any

Inherited from

ComponentBase.onGraphic

---

onParentChange()?

optional onParentChange(lastParent?, currentParent?): any

Defined in: src/components/ComponentBase.ts:171

Parameters

lastParent?

Object3D

currentParent?

Object3D

Returns

any

Inherited from

ComponentBase.onParentChange

---

onAddChild()?

optional onAddChild(child): any

Defined in: src/components/ComponentBase.ts:172

Parameters

child

Object3D

Returns

any

Inherited from

ComponentBase.onAddChild

---

onRemoveChild()?

optional onRemoveChild(child): any

Defined in: src/components/ComponentBase.ts:173

Parameters

child

Object3D

Returns

any

Inherited from

ComponentBase.onRemoveChild

---

copyComponent()

copyComponent(from): this

Defined in: src/components/ComponentBase.ts:182

Parameters

from

this

Returns

this

Inherited from

ComponentBase.copyComponent

---

awake()

awake(): void

Defined in: src/components/Transform.ts:230

Lifecycle hook called once when the transform is created.

Returns

void

---

start()

start(): void

Defined in: src/components/Transform.ts:233

Lifecycle hook called when the transform starts.

Returns

void

Overrides

ComponentBase.start

---

stop()

stop(): void

Defined in: src/components/Transform.ts:236

Lifecycle hook called when the transform stops.

Returns

void

Overrides

ComponentBase.stop

---

updateWorldMatrix()

updateWorldMatrix(force?): void

Defined in: src/components/Transform.ts:415

Update the matrix4 in world space

Parameters

force?

boolean = false

Returns

void

---

updateChildTransform()

updateChildTransform(): void

Defined in: src/components/Transform.ts:428

Recursively update this transform and all descendants' world matrices.

Returns

void

---

lookTarget()

lookTarget(target, up?): void

Defined in: src/components/Transform.ts:449

Rotate the object to look at a world-space target from its current position.

Parameters

target

Vector3

world-space point to look at

up?

Vector3 = Vector3.UP

up direction

Returns

void

---

lookAt()

lookAt(pos, target, up?): void

Defined in: src/components/Transform.ts:459

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

Parameters

pos

Vector3

Own position (global)

target

Vector3

Location of the target (global)

up?

Vector3 = Vector3.UP

up direction

Returns

void

---

decomposeFromMatrix()

decomposeFromMatrix(matrix, orientationStyle?): this

Defined in: src/components/Transform.ts:480

Set this transform's local position/rotation/scale by decomposing a matrix.

Parameters

matrix

Matrix4

the matrix to decompose

orientationStyle?

string = 'eulerAngles'

decomposition style (defaults to euler angles)

Returns

this

---

cloneTo()

cloneTo(obj): void

Defined in: src/components/Transform.ts:497

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

Parameters

obj

Object3D

source Object3D

Returns

void

Overrides

ComponentBase.cloneTo

---

beforeDestroy()

beforeDestroy(force?): void

Defined in: src/components/Transform.ts:807

Detach from the parent before the component is destroyed.

Parameters

force?

boolean

Returns

void

Overrides

ComponentBase.beforeDestroy

---

destroy()

destroy(): void

Defined in: src/components/Transform.ts:815

Destroy the transform and free its matrix-table slot.

Returns

void

Overrides

ComponentBase.destroy