@tmrw-realityos/charm / Exports / Node
Class: Node
Table of contents
Constructors
Properties
Accessors
Methods
- addChild
- centerIn
- clear
- clone
- findNodeByName
- getWorldPosition
- querySelector
- removeChild
- updateBounding
- updateTransforms
- updateWorldMatrix
Constructors
constructor
• new Node(): Node
Returns
Defined in
packages/charm/src/scene/node.ts:43
Properties
bounding
• bounding: AABB
Defined in
packages/charm/src/scene/node.ts:41
children
• children: Node[]
Defined in
packages/charm/src/scene/node.ts:37
enabled
• enabled: boolean = true
Defined in
packages/charm/src/scene/node.ts:31
id
• id: number
Defined in
packages/charm/src/scene/node.ts:26
index
• index: number = -1
Defined in
packages/charm/src/scene/node.ts:27
mesh
• Optional mesh: Mesh
Defined in
packages/charm/src/scene/node.ts:33
name
• name: string
Defined in
packages/charm/src/scene/node.ts:28
parent
• parent: null | Node
Defined in
packages/charm/src/scene/node.ts:36
primitives
• primitives: IPrimitive[]
Defined in
packages/charm/src/scene/node.ts:34
skin
• Optional skin: Skin
Defined in
packages/charm/src/scene/node.ts:39
transform
• transform: Transform
Defined in
packages/charm/src/scene/node.ts:29
last_index
▪ Static last_index: number = 0
Defined in
packages/charm/src/scene/node.ts:24
Accessors
material
• get material(): null | Material
Returns
null | Material
Defined in
packages/charm/src/scene/node.ts:55
• set material(m): void
Parameters
| Name | Type |
|---|---|
m | Material |
Returns
void
Defined in
packages/charm/src/scene/node.ts:59
siblings
• get siblings(): Node[]
Returns
Node[]
Defined in
packages/charm/src/scene/node.ts:141
Methods
addChild
▸ addChild(node): void
Parameters
| Name | Type |
|---|---|
node | Node |
Returns
void
Defined in
packages/charm/src/scene/node.ts:89
centerIn
▸ centerIn(parent): void
Parameters
| Name | Type |
|---|---|
parent | Node |
Returns
void
Defined in
packages/charm/src/scene/node.ts:98
clear
▸ clear(): void
Returns
void
Defined in
packages/charm/src/scene/node.ts:85
clone
▸ clone(inDepth?): Node
Parameters
| Name | Type | Default value |
|---|---|---|
inDepth | boolean | true |
Returns
Defined in
packages/charm/src/scene/node.ts:126
findNodeByName
▸ findNodeByName(name): undefined | Node
Parameters
| Name | Type |
|---|---|
name | string |
Returns
undefined | Node
Defined in
packages/charm/src/scene/node.ts:199
getWorldPosition
▸ getWorldPosition(out): vec3
Calculates the world space position by applying all ancestor transformations in the scene graph.
Parameters
| Name | Type |
|---|---|
out | vec3 |
Returns
vec3
Defined in
packages/charm/src/scene/node.ts:75
querySelector
▸ querySelector(selector): undefined | Node
Parameters
| Name | Type |
|---|---|
selector | string |
Returns
undefined | Node
Defined in
packages/charm/src/scene/node.ts:186
removeChild
▸ removeChild(node): void
Parameters
| Name | Type |
|---|---|
node | Node |
Returns
void
Defined in
packages/charm/src/scene/node.ts:115
updateBounding
▸ updateBounding(): void
Returns
void
Defined in
packages/charm/src/scene/node.ts:180
updateTransforms
▸ updateTransforms(): void
Returns
void
Defined in
packages/charm/src/scene/node.ts:171
updateWorldMatrix
▸ updateWorldMatrix(fast?): mat4
Updates the global matrix in transform taking into account the node ierarchy
Parameters
| Name | Type | Default value | Description |
|---|---|---|---|
fast | boolean | false | if true it asumes the parent global matrix is already updated |
Returns
mat4