RoyInterface / Exports / hierarchy/RoySceneNode / RoySceneNode

Class: RoySceneNode

hierarchy/RoySceneNode.RoySceneNode

Implements

• RoyTransDataObject
• IOcclusionItem

Table of contents

Constructors

• constructor

Properties

• cacheTranslate
• cacheRotation
• cacheScale
• cacheTransform
• CLASS_NAME
• s_handleID
• m_handleID
• m_name
• m_scene
• m_parent
• m_childrenList
• m_nextSibling
• m_componentList
• m_translation
• m_scale
• m_rotation
• m_transformDirty
• m_transform
• m_worldTransformDirty
• m_worldTransform
• m_selfBoundBoxDirty
• m_selfBoundBox
• m_boundBoxDirty
• m_boundBox
• m_worldBoundBoxDirty
• m_worldBoundBox
• m_ignoreBoundBox
• m_visible
• m_worldVisible
• m_enabled
• m_worldEnabled
• m_userData
• m_boundBoxComponent
• sBatchGroupID
• batchGroupID
• occFingerprint
• occLinkID
• m_occCompRefMap
• editorHierachyInfo
• m_transDataInfo
• m_canTransfer
• vs

Accessors

• handleID
• name
• scene
• parent
• childrenList
• nextSibling
• componentList
• translation
• scale
• rotation
• transformDirty
• transform
• worldTransformDirty
• worldTransform
• selfBoundBoxDirty
• selfBoundBox
• boundBoxDirty
• boundBox
• worldBoundBox
• ignoreBoundBox
• visible
• worldVisible
• enabled
• worldEnabled
• transDataInfo
• canTransfer

Methods

• updateWorldTransform
• updateWorldVisibleRecursive
• updateWorldEnabledRecursive
• setUserData
• getUserData
• deleteUserData
• requestGroupBatch
• resetGroupBatch
• fetchGroupBatchID
• addCompToOcclusion
• removeCompFromOcclusion
• markTransDataDirty
• markCanTransfer
• destroy
• addChild
• removeChild
• updateSelfBoundBox
• updateBoundBox
• getTransformBoundBox
• addToUpdateList
• update
• onFrameUpdate
• addComponent
• removeComponent
• getComponent
• getComponents
• createComponent
• destroyComponent
• traverseChildNode
• traverseComponent
• showBoundBox
• addFrameUpdate
• removeFrameUpdate
• updateBoundBoxComponentTransform
• removeRelObjectFromMap
• collectTransData
• serializeTransData
• deserializeTransData

Constructors

constructor

• new RoySceneNode(scene, transDataInfo?): RoySceneNode

Parameters

Name	Type
scene	RoyScene
transDataInfo?	RoyTransDataInfo

Returns

RoySceneNode

Properties

cacheTranslate

▪ Static Protected cacheTranslate: Vec3

---

cacheRotation

▪ Static Protected cacheRotation: Quat

---

cacheScale

▪ Static Protected cacheScale: Vec3

---

cacheTransform

▪ Static Protected cacheTransform: Mat4

---

CLASS_NAME

▪ Static CLASS_NAME: string = 'RoySceneNode'

---

s_handleID

▪ Static Private s_handleID: number = 0

---

m_handleID

• Private m_handleID: number = 0

---

m_name

• Private m_name: string = ''

---

m_scene

• Private m_scene: RoyScene

---

m_parent

• Private m_parent: RoySceneNode

---

m_childrenList

• Private m_childrenList: RoySceneNode

---

m_nextSibling

• Private m_nextSibling: RoySceneNode

---

m_componentList

• Private m_componentList: RoyComponent[]

---

m_translation

• Private m_translation: Vec3

---

m_scale

• Private m_scale: Vec3

---

m_rotation

• Private m_rotation: Quat

---

m_transformDirty

• Private m_transformDirty: boolean = false

---

m_transform

• Private m_transform: Mat4

---

m_worldTransformDirty

• Private m_worldTransformDirty: boolean = false

---

m_worldTransform

• Private m_worldTransform: Mat4

---

m_selfBoundBoxDirty

• Private m_selfBoundBoxDirty: boolean = false

---

m_selfBoundBox

• Private m_selfBoundBox: AABB

---

m_boundBoxDirty

• Private m_boundBoxDirty: boolean = false

---

m_boundBox

• Private m_boundBox: AABB

---

m_worldBoundBoxDirty

• Private m_worldBoundBoxDirty: boolean = false

---

m_worldBoundBox

• Private m_worldBoundBox: AABB

---

m_ignoreBoundBox

• Private m_ignoreBoundBox: boolean = false

---

m_visible

• Private m_visible: boolean = true

---

m_worldVisible

• Private m_worldVisible: boolean = true

---

m_enabled

• Private m_enabled: boolean = true

---

m_worldEnabled

• Private m_worldEnabled: boolean = true

---

m_userData

• Private m_userData: object = {}

---

m_boundBoxComponent

• Private m_boundBoxComponent: RoyWireframeComponent

---

sBatchGroupID

▪ Static sBatchGroupID: number = 1

---

batchGroupID

• batchGroupID: number = 0

---

occFingerprint

• occFingerprint: number = -1

Implementation of

IOcclusionItem.occFingerprint

---

occLinkID

• occLinkID: number = -1

Implementation of

IOcclusionItem.occLinkID

---

m_occCompRefMap

• Private m_occCompRefMap: Map<number, number>

---

editorHierachyInfo

• editorHierachyInfo: EditorHierachyInfo

---

m_transDataInfo

• Protected m_transDataInfo: RoyTransDataInfo

---

m_canTransfer

• Protected m_canTransfer: boolean = true

---

vs

▪ Static Private vs: Vec3[]

Accessors

handleID

• get handleID(): number

Returns

number

Implementation of

IOcclusionItem.handleID

---

name

• get name(): string

Returns

string

• set name(value): void

Parameters

Name	Type
value	string

Returns

void

---

scene

• get scene(): RoyScene

Returns

RoyScene

---

parent

• get parent(): RoySceneNode

Returns

RoySceneNode

• set parent(value): void

Parameters

Name	Type
value	RoySceneNode

Returns

void

---

childrenList

• get childrenList(): RoySceneNode

Returns

RoySceneNode

---

nextSibling

• get nextSibling(): RoySceneNode

Returns

RoySceneNode

---

componentList

• get componentList(): RoyComponent[]

Returns

RoyComponent[]

---

translation

• get translation(): Vec3

Returns

Vec3

• set translation(value): void

Parameters

Name	Type
value	Vec3

Returns

void

---

scale

• get scale(): Vec3

Returns

Vec3

• set scale(value): void

Parameters

Name	Type
value	Vec3

Returns

void

---

rotation

• get rotation(): Quat

Returns

Quat

• set rotation(value): void

Parameters

Name	Type
value	Quat

Returns

void

---

transformDirty

• get transformDirty(): boolean

Returns

boolean

• set transformDirty(value): void

Parameters

Name	Type
value	boolean

Returns

void

---

transform

• get transform(): Mat4

Returns

Mat4

• set transform(value): void

Parameters

Name	Type
value	Mat4

Returns

void

---

worldTransformDirty

• get worldTransformDirty(): boolean

Returns

boolean

• set worldTransformDirty(value): void

Parameters

Name	Type
value	boolean

Returns

void

---

worldTransform

• get worldTransform(): Mat4

Returns

Mat4

Implementation of

IOcclusionItem.worldTransform

---

selfBoundBoxDirty

• get selfBoundBoxDirty(): boolean

Returns

boolean

• set selfBoundBoxDirty(value): void

Parameters

Name	Type
value	boolean

Returns

void

---

selfBoundBox

• get selfBoundBox(): AABB

Returns

AABB

---

boundBoxDirty

• get boundBoxDirty(): boolean

Returns

boolean

• set boundBoxDirty(value): void

Parameters

Name	Type
value	boolean

Returns

void

---

boundBox

• get boundBox(): AABB

Returns

AABB

• set boundBox(value): void

Parameters

Name	Type
value	AABB

Returns

void

---

worldBoundBox

• get worldBoundBox(): AABB

Returns

AABB

Implementation of

IOcclusionItem.worldBoundBox

---

ignoreBoundBox

• get ignoreBoundBox(): boolean

Returns

boolean

• set ignoreBoundBox(value): void

Parameters

Name	Type
value	boolean

Returns

void

---

visible

• get visible(): boolean

Returns

boolean

• set visible(value): void

Parameters

Name	Type
value	boolean

Returns

void

---

worldVisible

• get worldVisible(): boolean

Returns

boolean

Implementation of

IOcclusionItem.worldVisible

---

enabled

• get enabled(): boolean

Returns

boolean

• set enabled(value): void

Parameters

Name	Type
value	boolean

Returns

void

---

worldEnabled

• get worldEnabled(): boolean

Returns

boolean

---

transDataInfo

• get transDataInfo(): RoyTransDataInfo

Returns

RoyTransDataInfo

Implementation of

RoyTransDataObject.transDataInfo

---

canTransfer

• get canTransfer(): boolean

Returns

boolean

Implementation of

RoyTransDataObject.canTransfer

Methods

updateWorldTransform

▸ updateWorldTransform(): void

Returns

void

---

updateWorldVisibleRecursive

▸ updateWorldVisibleRecursive(): void

Returns

void

---

updateWorldEnabledRecursive

▸ updateWorldEnabledRecursive(): void

Returns

void

---

setUserData

▸ setUserData(key, value): void

Parameters

Name	Type
key	string
value	unknown

Returns

void

---

getUserData

▸ getUserData(key): unknown

Parameters

Name	Type
key	string

Returns

unknown

---

deleteUserData

▸ deleteUserData(key): void

Parameters

Name	Type
key	string

Returns

void

---

requestGroupBatch

▸ requestGroupBatch(): void

Returns

void

---

resetGroupBatch

▸ resetGroupBatch(): void

Returns

void

---

fetchGroupBatchID

▸ fetchGroupBatchID(): number

Returns

number

---

addCompToOcclusion

▸ addCompToOcclusion(handleID): void

Parameters

Name	Type
handleID	number

Returns

void

---

removeCompFromOcclusion

▸ removeCompFromOcclusion(handleID): void

Parameters

Name	Type
handleID	number

Returns

void

---

markTransDataDirty

▸ markTransDataDirty(): void

Returns

void

Implementation of

RoyTransDataObject.markTransDataDirty

---

markCanTransfer

▸ markCanTransfer(value): void

Parameters

Name	Type
value	boolean

Returns

void

Implementation of

RoyTransDataObject.markCanTransfer

---

destroy

▸ destroy(entrance): void

Parameters

Name	Type
entrance	boolean

Returns

void

---

addChild

▸ addChild(child): void

Parameters

Name	Type
child	RoySceneNode

Returns

void

---

removeChild

▸ removeChild(child): void

Parameters

Name	Type
child	RoySceneNode

Returns

void

---

updateSelfBoundBox

▸ updateSelfBoundBox(): void

Returns

void

---

updateBoundBox

▸ updateBoundBox(): void

Returns

void

---

getTransformBoundBox

▸ getTransformBoundBox(out): boolean

Parameters

Name	Type
out	AABB

Returns

boolean

---

addToUpdateList

▸ addToUpdateList(): void

Returns

void

---

update

▸ update(): void

Returns

void

---

onFrameUpdate

▸ onFrameUpdate(): void

Returns

void

---

addComponent

▸ addComponent(component): void

Parameters

Name	Type
component	RoyComponent

Returns

void

---

removeComponent

▸ removeComponent(component): void

Parameters

Name	Type
component	RoyComponent

Returns

void

---

getComponent

▸ getComponent(compTypeName): RoyComponent

Parameters

Name	Type
compTypeName	string

Returns

RoyComponent

---

getComponents

▸ getComponents(compTypeName): RoyComponent[]

Parameters

Name	Type
compTypeName	string

Returns

RoyComponent[]

---

createComponent

▸ createComponent<T>(classIns, transDataInfo?): T

Create a new component of the given type and add it to the component list of this node.

Type parameters

Name	Type
T	extends RoyComponent

Parameters

Name	Type
classIns	(node: RoySceneNode, transDataInfo?: RoyTransDataInfo) => T
transDataInfo?	RoyTransDataInfo

Returns

T

---

destroyComponent

▸ destroyComponent(component): void

Parameters

Name	Type
component	RoyComponent

Returns

void

---

traverseChildNode

▸ traverseChildNode(callback): void

Parameters

Name	Type
callback	(node: RoySceneNode) => void

Returns

void

---

traverseComponent

▸ traverseComponent(compTypeName, callback): void

Parameters

Name	Type
compTypeName	string
callback	(component: RoyComponent) => void

Returns

void

---

showBoundBox

▸ showBoundBox(visible, param?): void

Parameters

Name	Type
visible	boolean
param?	ShowWireframeOptions

Returns

void

---

addFrameUpdate

▸ addFrameUpdate(): void

Returns

void

---

removeFrameUpdate

▸ removeFrameUpdate(): void

Returns

void

---

updateBoundBoxComponentTransform

▸ updateBoundBoxComponentTransform(): void

Returns

void

---

removeRelObjectFromMap

▸ removeRelObjectFromMap(dataTransfer): void

Parameters

Name	Type
dataTransfer	RoyDataTransferRecv

Returns

void

Implementation of

RoyTransDataObject.removeRelObjectFromMap

---

collectTransData

▸ collectTransData(dataTransfer): void

Parameters

Name	Type
dataTransfer	RoyDataTransferSend

Returns

void

Implementation of

RoyTransDataObject.collectTransData

---

serializeTransData

▸ serializeTransData(dataTransfer): RoySceneNodeData

Parameters

Name	Type
dataTransfer	RoyDataTransferSend

Returns

RoySceneNodeData

Implementation of

RoyTransDataObject.serializeTransData

---

deserializeTransData

▸ deserializeTransData(dataTransfer, nodeData): void

Parameters

Name	Type
dataTransfer	RoyDataTransferRecv
nodeData	RoySceneNodeData

Returns

void