@tmrw-realityos/charm

---

@tmrw-realityos/charm / Node

Class: Node

Defined in: packages/charm/src/scene/node.ts:29

Extended by

• TransformGizmo

Constructors

Constructor

new Node(): Node

Defined in: packages/charm/src/scene/node.ts:57

Returns

Node

Properties

bounding

bounding: AABB

Defined in: packages/charm/src/scene/node.ts:49

---

children

children: Node[]

Defined in: packages/charm/src/scene/node.ts:45

---

childrenBounding

childrenBounding: AABB

Defined in: packages/charm/src/scene/node.ts:50

---

enabled

enabled: boolean = true

Defined in: packages/charm/src/scene/node.ts:38

---

flags

flags: number = 0

Defined in: packages/charm/src/scene/node.ts:39

---

id

id: number

Defined in: packages/charm/src/scene/node.ts:32

---

index

index: number = -1

Defined in: packages/charm/src/scene/node.ts:33

---

is_hover

is_hover: boolean = false

Defined in: packages/charm/src/scene/node.ts:55

---

is_model_root

is_model_root: boolean = false

Defined in: packages/charm/src/scene/node.ts:54

---

layers

layers: number = 3

Defined in: packages/charm/src/scene/node.ts:35

---

mesh?

optional mesh: Mesh

Defined in: packages/charm/src/scene/node.ts:41

---

name

name: string

Defined in: packages/charm/src/scene/node.ts:34

---

owner?

optional owner: unknown

Defined in: packages/charm/src/scene/node.ts:52

---

parent

parent: null | Node

Defined in: packages/charm/src/scene/node.ts:44

---

primitives

primitives: IPrimitive[]

Defined in: packages/charm/src/scene/node.ts:42

---

skin?

optional skin: Skin

Defined in: packages/charm/src/scene/node.ts:47

---

transform

transform: Transform

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

---

last_index

static last_index: number = 0

Defined in: packages/charm/src/scene/node.ts:30

Accessors

highlight

Get Signature

get highlight(): boolean

Defined in: packages/charm/src/scene/node.ts:100

Returns

boolean

Set Signature

set highlight(v): void

Defined in: packages/charm/src/scene/node.ts:95

Parameters

v

boolean

Returns

void

---

material

Get Signature

get material(): null | Material

Defined in: packages/charm/src/scene/node.ts:70

Returns

null | Material

Set Signature

set material(m): void

Defined in: packages/charm/src/scene/node.ts:74

Parameters

m

Material

Returns

void

---

outline

Get Signature

get outline(): boolean

Defined in: packages/charm/src/scene/node.ts:91

Returns

boolean

Set Signature

set outline(v): void

Defined in: packages/charm/src/scene/node.ts:86

Parameters

v

boolean

Returns

void

---

siblings

Get Signature

get siblings(): Node[]

Defined in: packages/charm/src/scene/node.ts:224

Returns

Node[]

Methods

addChild()

addChild(node): void

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

Parameters

node

Node

Returns

void

---

centerIn()

centerIn(parent): void

Defined in: packages/charm/src/scene/node.ts:178

Parameters

parent

Node

Returns

void

---

clear()

clear(): void

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

Removes all children and sets up transform to identity

Returns

void

---

clone()

clone(inDepth): Node

Defined in: packages/charm/src/scene/node.ts:212

Parameters

inDepth

boolean = true

Returns

Node

---

collectMaterials()

collectMaterials(materials): void

Defined in: packages/charm/src/scene/node.ts:376

Used to get a list of materials used in this branch of the scene tree

Parameters

materials

Map<string, Material>

Returns

void

---

copyFrom()

copyFrom(n): void

Defined in: packages/charm/src/scene/node.ts:150

doesnt copy children, just node properties

Parameters

n

Node

Returns

void

---

destroy()

destroy(): void

Defined in: packages/charm/src/scene/node.ts:162

Returns

void

---

findNodeByIndex()

findNodeByIndex(index): undefined | Node

Defined in: packages/charm/src/scene/node.ts:362

Parameters

index

number

Returns

undefined | Node

---

findNodeByName()

findNodeByName(name): undefined | Node

Defined in: packages/charm/src/scene/node.ts:349

Parameters

name

string

Returns

undefined | Node

---

getOwner()

getOwner(): unknown

Defined in: packages/charm/src/scene/node.ts:388

Used in case this node is attached to some entity

Returns

unknown

---

getOwnerRoot()

getOwnerRoot(): undefined | Node

Defined in: packages/charm/src/scene/node.ts:395

Returns the first node in ascending hierarchy that contains owner info

Returns

undefined | Node

---

getWorldPosition()

getWorldPosition(out?): vec3

Defined in: packages/charm/src/scene/node.ts:122

Calculates the world space position by applying all ancestor transformations in the scene graph.

Parameters

out?

vec3

Returns

vec3

---

getWorldRotation()

getWorldRotation(out?): quat

Defined in: packages/charm/src/scene/node.ts:136

Calculates the world space rotation by applying all ancestor transformations in the scene graph.

Parameters

out?

quat

Returns

quat

---

globalToLocal()

globalToLocal(v, out?): vec3

Defined in: packages/charm/src/scene/node.ts:275

converts a global coordinate to local coordinates (slow: generates the inverse matrix!)

Parameters

v

vec3

out?

vec3

Returns

vec3

---

globalToLocalVector()

globalToLocalVector(v, out?): vec3

Defined in: packages/charm/src/scene/node.ts:282

converts a global vector to local coordinates (slow: generates the inverse matrix!)

Parameters

v

vec3

out?

vec3

Returns

vec3

---

localToGlobal()

localToGlobal(v, out?): vec3

Defined in: packages/charm/src/scene/node.ts:254

converts a local coordinate to globals coordinates

Parameters

v

vec3

out?

vec3

Returns

vec3

---

localToGlobalVector()

localToGlobalVector(v, out?): vec3

Defined in: packages/charm/src/scene/node.ts:260

converts a local vector to globals coordinates

Parameters

v

vec3

out?

vec3

Returns

vec3

---

orientTo()

orientTo(pos, cylindric): void

Defined in: packages/charm/src/scene/node.ts:297

Parameters

pos

vec3

cylindric

boolean = true

Returns

void

---

querySelector()

querySelector(selector): undefined | Node

Defined in: packages/charm/src/scene/node.ts:336

Parameters

selector

string

Returns

undefined | Node

---

removeChild()

removeChild(node): void

Defined in: packages/charm/src/scene/node.ts:200

Parameters

node

Node

Returns

void

---

setFlagBit()

setFlagBit(mask, v, recursive): void

Defined in: packages/charm/src/scene/node.ts:420

Parameters

mask

number

v

boolean

recursive

boolean = false

Returns

void

---

setLayerBit()

setLayerBit(bit, v, recursive): void

Defined in: packages/charm/src/scene/node.ts:410

Parameters

bit

number

v

boolean

recursive

boolean = true

Returns

void

---

setLayers()

setLayers(v, recursive): void

Defined in: packages/charm/src/scene/node.ts:402

assign a layer bitmask to this node (and its children)

Parameters

v

number

recursive

boolean = true

Returns

void

---

setOutline()

setOutline(v, recursive): void

Defined in: packages/charm/src/scene/node.ts:429

Parameters

v

boolean

recursive

boolean = true

Returns

void

---

updateAllBoundings()

updateAllBoundings(): void

Defined in: packages/charm/src/scene/node.ts:326

Updates the bounding taking into account node.bounding and all children childrenBoundings

Returns

void

---

updateBounding()

updateBounding(): void

Defined in: packages/charm/src/scene/node.ts:316

Updates the bounding taking into account mesh bounding and transfrom (not including children)

Returns

void

---

updateTransforms()

updateTransforms(): void

Defined in: packages/charm/src/scene/node.ts:242

iterates through every transform and updates world matrix and bounding, it propagates to children

Returns

void

---

updateWorldMatrix()

updateWorldMatrix(fast): mat4

Defined in: packages/charm/src/scene/node.ts:233

Updates the global matrix in transform taking into account the node ierarchy

Parameters

fast

boolean = false

if true it asumes the parent global matrix is already updated

Returns

mat4