@tmrw-realityos/charm

---

@tmrw-realityos/charm / Transform

Class: Transform

Defined in: packages/charm/src/scene/transform.ts:16

Constructors

Constructor

new Transform(): Transform

Defined in: packages/charm/src/scene/transform.ts:25

Returns

Transform

Properties

global_model

global_model: mat4

Defined in: packages/charm/src/scene/transform.ts:21

---

local_model

local_model: mat4

Defined in: packages/charm/src/scene/transform.ts:20

---

mustUpdate

mustUpdate: boolean

Defined in: packages/charm/src/scene/transform.ts:23

---

parent?

optional parent: Transform

Defined in: packages/charm/src/scene/transform.ts:22

---

position_

position_: vec3

Defined in: packages/charm/src/scene/transform.ts:17

---

rotation_

rotation_: quat

Defined in: packages/charm/src/scene/transform.ts:18

---

scale_

scale_: vec3

Defined in: packages/charm/src/scene/transform.ts:19

Methods

copyFrom()

copyFrom(v): void

Defined in: packages/charm/src/scene/transform.ts:129

Copies all data (but not the parent)

Parameters

v

Transform

Returns

void

---

fromJSON()

fromJSON(o): void

Defined in: packages/charm/src/scene/transform.ts:187

Parameters

o

TransformSpec

Returns

void

---

fromMatrix()

fromMatrix(m): void

Defined in: packages/charm/src/scene/transform.ts:139

Decomposes the model matrix in position, rotation and scale

Parameters

m

mat4

Returns

void

---

getLocalMatrix()

getLocalMatrix(): ReadonlyMat4

Defined in: packages/charm/src/scene/transform.ts:121

Returns

ReadonlyMat4

---

getPosition()

getPosition(): ReadonlyVec3

Defined in: packages/charm/src/scene/transform.ts:51

Returns

ReadonlyVec3

---

getRotation()

getRotation(): ReadonlyQuat

Defined in: packages/charm/src/scene/transform.ts:68

Returns

ReadonlyQuat

---

getScale()

getScale(): ReadonlyVec3

Defined in: packages/charm/src/scene/transform.ts:84

Returns

ReadonlyVec3

---

getWorldPosition()

getWorldPosition(out?): vec3

Defined in: packages/charm/src/scene/transform.ts:159

Returns position taking into account global transform

Parameters

out?

vec3

Returns

vec3

---

getWorldRotation()

getWorldRotation(out?): quat

Defined in: packages/charm/src/scene/transform.ts:172

returns the rotation taking into account parent rotations

Parameters

out?

quat

Returns

quat

---

localToGlobal()

localToGlobal(out, v): vec3

Defined in: packages/charm/src/scene/transform.ts:166

transforms local position to global coordinates

Parameters

out

vec3

v

vec3

Returns

vec3

---

move()

move(v, scale): void

Defined in: packages/charm/src/scene/transform.ts:56

apply local translation

Parameters

v

vec3

scale

number = 1

Returns

void

---

reset()

reset(keepParent): void

Defined in: packages/charm/src/scene/transform.ts:36

Clears all info inside the transform

Parameters

keepParent

boolean = false

Returns

void

---

rotate()

rotate(angle_in_rad, axis): void

Defined in: packages/charm/src/scene/transform.ts:73

apply local rotation

Parameters

angle_in_rad

number

axis

vec3

Returns

void

---

setPosition()

setPosition(v): void

Defined in: packages/charm/src/scene/transform.ts:46

Parameters

v

vec3

Returns

void

---

setRotation()

setRotation(q): void

Defined in: packages/charm/src/scene/transform.ts:63

Parameters

q

quat | ReadonlyQuat

Returns

void

---

setScale()

setScale(v): void

Defined in: packages/charm/src/scene/transform.ts:79

Parameters

v

vec3

Returns

void

---

toJSON()

toJSON(): TransformSpec

Defined in: packages/charm/src/scene/transform.ts:179

Returns

TransformSpec

---

updateGlobalMatrix()

updateGlobalMatrix(fast): mat4

Defined in: packages/charm/src/scene/transform.ts:105

Updates the global matrix in transform taking into account the parents transforms

Parameters

fast

boolean = false

if true it asumes the parent global matrix is already updated

Returns

mat4

---

updateLocalMatrix()

updateLocalMatrix(): mat4

Defined in: packages/charm/src/scene/transform.ts:88

Returns

mat4