RoyInterface / Exports / hierarchy/RoyScene / RoyScene

Class: RoyScene

hierarchy/RoyScene.RoyScene

Hierarchy

• Events

  ↳ RoyScene

Implements

• RoyTransDataObject

Table of contents

Constructors

• constructor

Properties

• _events
• _suspendEvents
• _additionalEmitters
• CLASS_NAME
• sTypeClass
• s_handleID
• m_handleID
• m_name
• m_impl
• m_sceneInfo
• m_sceneNodeMap
• m_rootSceneNode
• m_sceneRefHead
• m_selectedCount
• m_occlusionMgr
• m_componentList
• m_compUpdateMap
• m_nodeFrameUpdateMap
• m_skinAnimatorMap
• m_wireframeBatchHelper
• m_cullDirtyFrameId
• m_contextDirtyFrameId
• m_contextDirtyExcludeWireframeFrameId
• m_canBaseImplSetLightMode
• m_lightMode
• m_directLightEnabled
• m_punctualLightIntensity
• m_directionalLightShadowEnabled
• m_spotLightShadowEnabled
• m_lightModePerformStatic
• m_lightModePerformMask
• m_lightModePerformIncludeSun
• m_cameraAtOrigin
• m_lodSettingDirty
• m_lodEnabled
• m_gizmoMaterial
• m_gizmoPickProirity
• m_useSSRefraction
• m_transDataInfo

Accessors

• suspendEvents
• handleID
• name
• impl
• sceneInfo
• sceneNodeMap
• rootSceneNode
• sceneRefHead
• selectedCount
• occlusionMgr
• wireframeBatchHelper
• lightMode
• directLightEnabled
• punctualLightIntensity
• directionalLightShadowEnabled
• spotLightShadowEnabled
• lightModePerformStatic
• lightModePerformMask
• lightModePerformIncludeSun
• cameraAtOrigin
• lodEnabled
• gizmoMaterial
• gizmoPickProirity
• useSSRefraction
• transDataInfo
• canTransfer

Methods

• on
• once
• emit
• unbind
• addEmitter
• removeEmitter
• registerImplClass
• getComponentMap
• markTransDataDirty
• markCanTransfer
• destroy
• createSceneNode
• getSceneNode
• getSceneNodeByName
• destroySceneNode
• createExecution
• destroyExecution
• getExecutionList
• addComponent
• removeComponent
• traverseComponent
• addToNodeFrameUpdateList
• removeFromNodeFrameUpdateList
• addToCompUpdateList
• removeFromCompUpdateList
• addRDisp
• resetSelectedCount
• removeRDisp
• markContextDirty
• markCullDirty
• raycastMulti
• raycastComponents
• raycastSingle
• frustumQuery
• frustumQueryComponents
• preRender
• postRender
• isFBODirty
• isCullDirty
• isFBODirtyExcludeWireframe
• dumpSceneInfo
• handleGPURes
• refreshLightMode
• setRenderDirty
• refreshSSRefraction
• refreshDirectLightStatus
• refreshDirectLightParam
• refreshIndirectLightParam
• getRoyObject3D
• getActiveDispCount
• getComponentCount
• removeRelObjectFromMap
• collectTransData
• serializeTransData
• deserializeTransData
• addSkinAnimation
• removeSkinAnimation
• preRenderScene
• renderScene
• postRenderScene
• setRefreshScene

Constructors

constructor

• new RoyScene(name, sceneInfo, transDataInfo?): RoyScene

Parameters

Name	Type
name	string
sceneInfo	RoySceneInfo
transDataInfo?	RoyTransDataInfo

Returns

RoyScene

Overrides

Events.constructor

Properties

_events

• Protected _events: Object = {}

Index signature

▪ [key: string]: EvtTriggerFunc[]

Inherited from

Events._events

---

_suspendEvents

• Protected _suspendEvents: boolean = false

Inherited from

Events._suspendEvents

---

_additionalEmitters

• Protected _additionalEmitters: Events[] = []

Inherited from

Events._additionalEmitters

---

CLASS_NAME

▪ Static CLASS_NAME: string = 'RoyScene'

---

sTypeClass

▪ Static Protected sTypeClass: Object = {}

Index signature

▪ [key: number]: RoySceneImplClass

---

s_handleID

▪ Static Private s_handleID: number = 0

---

m_handleID

• Private m_handleID: number = 0

---

m_name

• Private m_name: string = ''

---

m_impl

• Private m_impl: RoySceneImpl[]

---

m_sceneInfo

• Private m_sceneInfo: RoySceneInfo

---

m_sceneNodeMap

• Private m_sceneNodeMap: Map<number, RoySceneNode>

---

m_rootSceneNode

• Private m_rootSceneNode: RoySceneNode

---

m_sceneRefHead

• m_sceneRefHead: RoyObject3D

---

m_selectedCount

• Private m_selectedCount: number = 0

---

m_occlusionMgr

• Private m_occlusionMgr: IOcclusion

---

m_componentList

• Private m_componentList: Map<number, RoyComponent>[]

---

m_compUpdateMap

• Private m_compUpdateMap: Map<number, RoyComponent>

---

m_nodeFrameUpdateMap

• Private m_nodeFrameUpdateMap: Map<number, RoySceneNode>

---

m_skinAnimatorMap

• Private m_skinAnimatorMap: Map<number, RoySkinMeshComponent>

---

m_wireframeBatchHelper

• Private m_wireframeBatchHelper: RoyWireframeBatchHelper

---

m_cullDirtyFrameId

• Private m_cullDirtyFrameId: number = 0

---

m_contextDirtyFrameId

• Private m_contextDirtyFrameId: number = 0

---

m_contextDirtyExcludeWireframeFrameId

• Private m_contextDirtyExcludeWireframeFrameId: number = 0

---

m_canBaseImplSetLightMode

• Private m_canBaseImplSetLightMode: boolean = true

---

m_lightMode

• Private m_lightMode: LightModeType = LightModeType.Edit

---

m_directLightEnabled

• Private m_directLightEnabled: boolean = true

---

m_punctualLightIntensity

• Private m_punctualLightIntensity: number = 0.72

---

m_directionalLightShadowEnabled

• Private m_directionalLightShadowEnabled: boolean = true

---

m_spotLightShadowEnabled

• Private m_spotLightShadowEnabled: boolean = false

---

m_lightModePerformStatic

• Private m_lightModePerformStatic: number = 0xff

---

m_lightModePerformMask

• Private m_lightModePerformMask: number = Light3DType.NORECT

---

m_lightModePerformIncludeSun

• Private m_lightModePerformIncludeSun: boolean = false

---

m_cameraAtOrigin

• Private m_cameraAtOrigin: boolean = false

---

m_lodSettingDirty

• Private m_lodSettingDirty: boolean = true

---

m_lodEnabled

• Private m_lodEnabled: boolean = false

---

m_gizmoMaterial

• Protected m_gizmoMaterial: RoyMaterialBase

---

m_gizmoPickProirity

• Protected m_gizmoPickProirity: number = 1

---

m_useSSRefraction

• Private m_useSSRefraction: boolean = false

---

m_transDataInfo

• Protected m_transDataInfo: RoyTransDataInfo

Accessors

suspendEvents

• get suspendEvents(): boolean

Returns

boolean

Inherited from

Events.suspendEvents

• set suspendEvents(value): void

Parameters

Name	Type
value	boolean

Returns

void

Inherited from

Events.suspendEvents

---

handleID

• get handleID(): number

Returns

number

---

name

• get name(): string

Returns

string

---

impl

• get impl(): RoySceneImpl[]

Returns

RoySceneImpl[]

---

sceneInfo

• get sceneInfo(): RoySceneInfo

Returns

RoySceneInfo

---

sceneNodeMap

• get sceneNodeMap(): Map<number, RoySceneNode>

Returns

Map<number, RoySceneNode>

---

rootSceneNode

• get rootSceneNode(): RoySceneNode

Returns

RoySceneNode

---

sceneRefHead

• get sceneRefHead(): RoyObject3D

Returns

RoyObject3D

---

selectedCount

• get selectedCount(): number

Returns

number

---

occlusionMgr

• get occlusionMgr(): IOcclusion

Returns

IOcclusion

• set occlusionMgr(value): void

Parameters

Name	Type
value	IOcclusion

Returns

void

---

wireframeBatchHelper

• get wireframeBatchHelper(): RoyWireframeBatchHelper

Returns

RoyWireframeBatchHelper

---

lightMode

• get lightMode(): LightModeType

Returns

LightModeType

• set lightMode(value): void

Parameters

Name	Type
value	LightModeType

Returns

void

---

directLightEnabled

• get directLightEnabled(): boolean

Returns

boolean

• set directLightEnabled(value): void

Parameters

Name	Type
value	boolean

Returns

void

---

punctualLightIntensity

• get punctualLightIntensity(): number

Returns

number

• set punctualLightIntensity(value): void

Parameters

Name	Type
value	number

Returns

void

---

directionalLightShadowEnabled

• get directionalLightShadowEnabled(): boolean

Returns

boolean

• set directionalLightShadowEnabled(value): void

Parameters

Name	Type
value	boolean

Returns

void

---

spotLightShadowEnabled

• get spotLightShadowEnabled(): boolean

Returns

boolean

• set spotLightShadowEnabled(value): void

Parameters

Name	Type
value	boolean

Returns

void

---

lightModePerformStatic

• get lightModePerformStatic(): number

Returns

number

• set lightModePerformStatic(value): void

Parameters

Name	Type
value	number

Returns

void

---

lightModePerformMask

• get lightModePerformMask(): number

Returns

number

• set lightModePerformMask(value): void

Parameters

Name	Type
value	number

Returns

void

---

lightModePerformIncludeSun

• get lightModePerformIncludeSun(): boolean

Returns

boolean

• set lightModePerformIncludeSun(value): void

Parameters

Name	Type
value	boolean

Returns

void

---

cameraAtOrigin

• get cameraAtOrigin(): boolean

Returns

boolean

• set cameraAtOrigin(value): void

Parameters

Name	Type
value	boolean

Returns

void

---

lodEnabled

• get lodEnabled(): boolean

Returns

boolean

• set lodEnabled(value): void

Parameters

Name	Type
value	boolean

Returns

void

---

gizmoMaterial

• get gizmoMaterial(): RoyMaterialBase

Returns

RoyMaterialBase

• set gizmoMaterial(value): void

Parameters

Name	Type
value	RoyMaterialBase

Returns

void

---

gizmoPickProirity

• get gizmoPickProirity(): number

Returns

number

• set gizmoPickProirity(value): void

Parameters

Name	Type
value	number

Returns

void

---

useSSRefraction

• get useSSRefraction(): boolean

Returns

boolean

• set useSSRefraction(value): void

Parameters

Name	Type
value	boolean

Returns

void

---

transDataInfo

• get transDataInfo(): RoyTransDataInfo

Returns

RoyTransDataInfo

Implementation of

RoyTransDataObject.transDataInfo

---

canTransfer

• get canTransfer(): boolean

Returns

boolean

Implementation of

RoyTransDataObject.canTransfer

Methods

on

▸ on(name, fn): EventHandle

Parameters

Name	Type	Description
name	string	Name
fn	EvtTriggerFunc	Callback function

Returns

EventHandle

EventHandle

Inherited from

Events.on

---

once

▸ once(name, fn): EventHandle

Parameters

Name	Type	Description
name	string	Name
fn	EvtTriggerFunc	Callback function

Returns

EventHandle

EventHandle

Inherited from

Events.once

---

emit

▸ emit(name, ...args): RoyScene

Parameters

Name	Type	Description
name	string	Name
...args	any[]	-

Returns

RoyScene

Self for chaining.

Inherited from

Events.emit

---

unbind

▸ unbind(name?, fn?): RoyScene

Parameters

Name	Type	Description
name?	string	Name
fn?	EvtTriggerFunc	Callback function

Returns

RoyScene

• This

Inherited from

Events.unbind

---

addEmitter

▸ addEmitter(emitter): void

Adds another emitter. Any events fired by this instance will also be fired on the additional emitter.

Parameters

Name	Type	Description
emitter	Events	The emitter

Returns

void

Inherited from

Events.addEmitter

---

removeEmitter

▸ removeEmitter(emitter): void

Removes emitter.

Parameters

Name	Type	Description
emitter	Events	The emitter

Returns

void

Inherited from

Events.removeEmitter

---

registerImplClass

▸ registerImplClass(type, classIns): void

Parameters

Name	Type
type	RendererType
classIns	RoySceneImplClass

Returns

void

---

getComponentMap

▸ getComponentMap(componentType): Map<number, RoyComponent>

Parameters

Name	Type
componentType	RoyComponentClassifyType

Returns

Map<number, RoyComponent>

---

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(): void

Destroy the RoyScene object.

Returns

void

---

createSceneNode

▸ createSceneNode(name, transDataInfo?): RoySceneNode

Create a new scene node.

Parameters

Name	Type	Description
name	string	The name of the scene node.
transDataInfo?	RoyTransDataInfo	-

Returns

RoySceneNode

The newly created scene node.

---

getSceneNode

▸ getSceneNode(handleID): RoySceneNode

Parameters

Name	Type
handleID	number

Returns

RoySceneNode

---

getSceneNodeByName

▸ getSceneNodeByName(nodeName): RoySceneNode[]

Parameters

Name	Type
nodeName	string

Returns

RoySceneNode[]

---

destroySceneNode

▸ destroySceneNode(sceneNode): void

Parameters

Name	Type
sceneNode	RoySceneNode

Returns

void

---

createExecution

▸ createExecution<T>(classIns): T

Type parameters

Name	Type
T	extends RoyExecution

Parameters

Name	Type
classIns	() => RoyExecution

Returns

T

---

destroyExecution

▸ destroyExecution(execution): void

Parameters

Name	Type
execution	RoyExecution

Returns

void

---

getExecutionList

▸ getExecutionList(): RoyExecution[]

Returns

RoyExecution[]

---

addComponent

▸ addComponent(component): void

Parameters

Name	Type
component	RoyComponent

Returns

void

---

removeComponent

▸ removeComponent(component): void

Parameters

Name	Type
component	RoyComponent

Returns

void

---

traverseComponent

▸ traverseComponent(compType, callback): void

Parameters

Name	Type
compType	RoyComponentClassifyType
callback	(component: RoyComponent) => void

Returns

void

---

addToNodeFrameUpdateList

▸ addToNodeFrameUpdateList(node): void

Parameters

Name	Type
node	RoySceneNode

Returns

void

---

removeFromNodeFrameUpdateList

▸ removeFromNodeFrameUpdateList(node): void

Parameters

Name	Type
node	RoySceneNode

Returns

void

---

addToCompUpdateList

▸ addToCompUpdateList(component): void

Parameters

Name	Type
component	RoyComponent

Returns

void

---

removeFromCompUpdateList

▸ removeFromCompUpdateList(component): void

Parameters

Name	Type
component	RoyComponent

Returns

void

---

addRDisp

▸ addRDisp(disp): void

Parameters

Name	Type
disp	RoyObject3D

Returns

void

---

resetSelectedCount

▸ resetSelectedCount(isAdd): void

Parameters

Name	Type
isAdd	boolean

Returns

void

---

removeRDisp

▸ removeRDisp(disp): void

Parameters

Name	Type
disp	RoyObject3D

Returns

void

---

markContextDirty

▸ markContextDirty(dirtyType, dirtyParam): void

Parameters

Name	Type
dirtyType	RoySceneDirtyType
dirtyParam	unknown

Returns

void

---

markCullDirty

▸ markCullDirty(): void

Returns

void

---

raycastMulti

▸ raycastMulti(rl, options): RoyQueryResultRay[]

Parameters

Name	Type
rl	RadialLine
options	SceneQueryOptions

Returns

RoyQueryResultRay[]

---

raycastComponents

▸ raycastComponents(componentType, sceneNode, options, rl, resultArray): void

Parameters

Name	Type
componentType	string
sceneNode	RoySceneNode
options	SceneQueryOptions
rl	RadialLine
resultArray	RoyQueryResultRay[]

Returns

void

---

raycastSingle

▸ raycastSingle(rl, options): RoyQueryResultRay

Parameters

Name	Type
rl	RadialLine
options	SceneQueryOptions

Returns

RoyQueryResultRay

---

frustumQuery

▸ frustumQuery(frustumPlanes, options): RoyQueryResultFrustum[]

Parameters

Name	Type
frustumPlanes	Plane[]
options	SceneQueryOptions

Returns

RoyQueryResultFrustum[]

---

frustumQueryComponents

▸ frustumQueryComponents(componentType, sceneNode, intersection, frustum, options, resultArray): void

Parameters

Name	Type
componentType	string
sceneNode	RoySceneNode
intersection	Intersection
frustum	Frustum
options	SceneQueryOptions
resultArray	RoyQueryResultFrustum[]

Returns

void

---

preRender

▸ preRender(royCamera, drawWireframe): void

Parameters

Name	Type
royCamera	RoyCamera3D
drawWireframe	boolean

Returns

void

---

postRender

▸ postRender(royCamera): void

Parameters

Name	Type
royCamera	RoyCamera3D

Returns

void

---

isFBODirty

▸ isFBODirty(): boolean

Returns

boolean

---

isCullDirty

▸ isCullDirty(): boolean

Returns

boolean

---

isFBODirtyExcludeWireframe

▸ isFBODirtyExcludeWireframe(): boolean

Returns

boolean

---

dumpSceneInfo

▸ dumpSceneInfo(): void

Returns

void

---

handleGPURes

▸ handleGPURes(royCamera): void

Parameters

Name	Type
royCamera	RoyCamera3D

Returns

void

---

refreshLightMode

▸ refreshLightMode(): void

Returns

void

---

setRenderDirty

▸ setRenderDirty(): void

Returns

void

---

refreshSSRefraction

▸ refreshSSRefraction(): void

Returns

void

---

refreshDirectLightStatus

▸ refreshDirectLightStatus(filterFunc?): void

Parameters

Name	Type
filterFunc?	(light: RoyLight3D) => boolean

Returns

void

---

refreshDirectLightParam

▸ refreshDirectLightParam(filterFunc?): void

Parameters

Name	Type
filterFunc?	(light: RoyLight3D) => boolean

Returns

void

---

refreshIndirectLightParam

▸ refreshIndirectLightParam(): void

Returns

void

---

getRoyObject3D

▸ getRoyObject3D(dispObjID): RoyObject3D

Parameters

Name	Type
dispObjID	number

Returns

RoyObject3D

---

getActiveDispCount

▸ getActiveDispCount(): number

Returns

number

---

getComponentCount

▸ getComponentCount(type): number

Parameters

Name	Type
type	number

Returns

number

---

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): RoySceneData

Parameters

Name	Type
dataTransfer	RoyDataTransferSend

Returns

RoySceneData

Implementation of

RoyTransDataObject.serializeTransData

---

deserializeTransData

▸ deserializeTransData(dataTransfer, sceneData): void

Parameters

Name	Type
dataTransfer	RoyDataTransferRecv
sceneData	RoySceneData

Returns

void

---

addSkinAnimation

▸ addSkinAnimation(index, component): void

Parameters

Name	Type
index	number
component	RoySkinMeshComponent

Returns

void

---

removeSkinAnimation

▸ removeSkinAnimation(index): void

Parameters

Name	Type
index	number

Returns

void

---

preRenderScene

▸ preRenderScene(cameraComponent): void

Parameters

Name	Type
cameraComponent	RoyCameraComponent

Returns

void

---

renderScene

▸ renderScene(cameraComponent): void

Parameters

Name	Type
cameraComponent	RoyCameraComponent

Returns

void

---

postRenderScene

▸ postRenderScene(cameraComponent): void

Parameters

Name	Type
cameraComponent	RoyCameraComponent

Returns

void

---

setRefreshScene

▸ setRefreshScene(): void

Returns

void