RoyInterface / Exports / hierarchy/RoyRoot / RoyRoot

Class: RoyRoot

hierarchy/RoyRoot.RoyRoot

RoyRoot is the root of the Roy Engine. It is a singleton class. It is used to manage the scenes and resources.

Table of contents

Constructors

• constructor

Properties

• instance
• sRenderDeviceType
• sRendererType
• sTypeClass
• m_impl
• m_firstSceneSet
• m_mainScene
• m_sceneMap
• m_editModeAmbientColor
• editModeDirLightCount
• m_editModeDirLightList
• m_lengthFactor
• m_stageWidth
• m_stageHeight
• m_externalPrepareRenderCallback
• m_executeFinishCallbacks
• m_royEngine3DList
• m_cameraCompList
• m_lodQualityLevel
• m_texQualityLevel

Accessors

• impl
• editModeAmbientColor
• editModeDirLightList
• lengthFactor
• stageWidth
• stageHeight
• externalPrepareRenderCallback
• cameraCompList
• lodQualityLevel
• texQualityLevel

Methods

• getInstance
• addRendererType
• hasRendererType
• registerImplClass
• getMainScene
• getSceneMap
• createImpl
• initEngine
• addEditModeDirLight
• addExecuteFinishCallback
• removeExecuteFinishCallback
• setEditModeDirLight
• syncEditModeLights
• createScene
• destroyScene
• getScene
• getSceneByName
• markSceneDirty
• setAssetPath
• loadMaterialTemplate
• addScene3DInfo
• execute
• onResizeEvent
• onContextLost
• onContextLostEvent
• onContextRestoreEvent
• dumpEngineInfo

Constructors

constructor

• new RoyRoot(): RoyRoot

Returns

RoyRoot

Properties

instance

▪ Static Private instance: RoyRoot

---

sRenderDeviceType

▪ Static sRenderDeviceType: RenderDeviceType = RenderDeviceType.Software

---

sRendererType

▪ Static sRendererType: number = 0

---

sTypeClass

▪ Static Protected sTypeClass: Object = {}

Index signature

▪ [key: number]: RoyRootImplClass

---

m_impl

• Private m_impl: RoyRootImpl[]

---

m_firstSceneSet

• Private m_firstSceneSet: boolean = false

---

m_mainScene

• Private m_mainScene: RoyScene

---

m_sceneMap

• Private m_sceneMap: Map<number, RoyScene>

---

m_editModeAmbientColor

• Private m_editModeAmbientColor: number[]

---

editModeDirLightCount

• editModeDirLightCount: number = 8

---

m_editModeDirLightList

• Private m_editModeDirLightList: EditModeDirLight[]

---

m_lengthFactor

• Private m_lengthFactor: number = 1.0

---

m_stageWidth

• Private m_stageWidth: number = 0

---

m_stageHeight

• Private m_stageHeight: number = 0

---

m_externalPrepareRenderCallback

• Protected m_externalPrepareRenderCallback: () => void

Type declaration

▸ (): void

Returns

void

---

m_executeFinishCallbacks

• Private m_executeFinishCallbacks: () => void[] = []

---

m_royEngine3DList

• Protected m_royEngine3DList: RoyEngine3DInfo[] = []

---

m_cameraCompList

• Protected m_cameraCompList: RoyCameraComponent[] = []

---

m_lodQualityLevel

• Private m_lodQualityLevel: RendererLevel = RendererLevel.LowQuality

---

m_texQualityLevel

• Private m_texQualityLevel: RendererLevel = RendererLevel.HighQuality

Accessors

impl

• get impl(): RoyRootImpl[]

Returns

RoyRootImpl[]

---

editModeAmbientColor

• get editModeAmbientColor(): number[]

Returns

number[]

• set editModeAmbientColor(value): void

Parameters

Name	Type
value	number[]

Returns

void

---

editModeDirLightList

• get editModeDirLightList(): EditModeDirLight[]

Returns

EditModeDirLight[]

---

lengthFactor

• get lengthFactor(): number

Returns

number

• set lengthFactor(value): void

Parameters

Name	Type
value	number

Returns

void

---

stageWidth

• get stageWidth(): number

Returns

number

---

stageHeight

• get stageHeight(): number

Returns

number

---

externalPrepareRenderCallback

• get externalPrepareRenderCallback(): (renderFunc: () => void, preRenderFunc: () => void, postRenderFunc: () => void, mainScene: boolean) => void

Returns

fn

▸ (renderFunc, preRenderFunc, postRenderFunc, mainScene): void

Parameters

Name	Type
renderFunc	() => void
preRenderFunc	() => void
postRenderFunc	() => void
mainScene	boolean

Returns

void

---

cameraCompList

• get cameraCompList(): RoyCameraComponent[]

Returns

RoyCameraComponent[]

---

lodQualityLevel

• get lodQualityLevel(): RendererLevel

Returns

RendererLevel

• set lodQualityLevel(value): void

Parameters

Name	Type
value	RendererLevel

Returns

void

---

texQualityLevel

• get texQualityLevel(): RendererLevel

Returns

RendererLevel

• set texQualityLevel(value): void

Parameters

Name	Type
value	RendererLevel

Returns

void

Methods

getInstance

▸ getInstance(): RoyRoot

Returns

RoyRoot

---

addRendererType

▸ addRendererType(type): void

Parameters

Name	Type
type	RendererType

Returns

void

---

hasRendererType

▸ hasRendererType(type): boolean

Parameters

Name	Type
type	RendererType

Returns

boolean

---

registerImplClass

▸ registerImplClass(type, classIns): void

Parameters

Name	Type
type	RendererType
classIns	RoyRootImplClass

Returns

void

---

getMainScene

▸ getMainScene(): RoyScene

Returns

RoyScene

---

getSceneMap

▸ getSceneMap(): Map<number, RoyScene>

Returns

Map<number, RoyScene>

---

createImpl

▸ createImpl(type): void

Parameters

Name	Type
type	RendererType

Returns

void

---

initEngine

▸ initEngine(width, height, prepareRenderCallback): void

Parameters

Name	Type
width	number
height	number
prepareRenderCallback	() => void

Returns

void

---

addEditModeDirLight

▸ addEditModeDirLight(dir, color, mask?): void

Parameters

Name	Type	Default value
dir	Vec3	undefined
color	number[]	undefined
mask	number	1

Returns

void

---

addExecuteFinishCallback

▸ addExecuteFinishCallback(callback): void

add a callback function which will be called when execute finish

Parameters

Name	Type	Description
callback	() => void	function (frameId:number, time:number, deltaTime:number)

Returns

void

---

removeExecuteFinishCallback

▸ removeExecuteFinishCallback(callback): void

remove a callback function which will be called when execute finish

Parameters

Name	Type	Description
callback	() => void	function (frameId:number, time:number, deltaTime:number)

Returns

void

---

setEditModeDirLight

▸ setEditModeDirLight(index, dir, color): void

Parameters

Name	Type
index	number
dir	Vec3
color	number[]

Returns

void

---

syncEditModeLights

▸ syncEditModeLights(): void

Returns

void

---

createScene

▸ createScene(name, sceneInfo): RoyScene

Parameters

Name	Type
name	string
sceneInfo	RoySceneInfo

Returns

RoyScene

---

destroyScene

▸ destroyScene(scene): void

Parameters

Name	Type
scene	RoyScene

Returns

void

---

getScene

▸ getScene(handleID): RoyScene

Parameters

Name	Type
handleID	number

Returns

RoyScene

---

getSceneByName

▸ getSceneByName(name): RoyScene

Parameters

Name	Type
name	string

Returns

RoyScene

---

markSceneDirty

▸ markSceneDirty(dirtyType, dirtyParam): void

Parameters

Name	Type
dirtyType	RoySceneDirtyType
dirtyParam	unknown

Returns

void

---

setAssetPath

▸ setAssetPath(assetPath): void

Parameters

Name	Type
assetPath	string

Returns

void

---

loadMaterialTemplate

▸ loadMaterialTemplate(matInfo, customKeyPath?): void

Parameters

Name	Type
matInfo	RoyMatInfo
customKeyPath?	string | Uint8Array

Returns

void

---

addScene3DInfo

▸ addScene3DInfo(renderFunc, preRenderFunc, postRenderFunc, mainScene): void

Parameters

Name	Type
renderFunc	() => void
preRenderFunc	() => void
postRenderFunc	() => void
mainScene	boolean

Returns

void

---

execute

▸ execute(): void

Returns

void

---

onResizeEvent

▸ onResizeEvent(width, height): void

Parameters

Name	Type
width	number
height	number

Returns

void

---

onContextLost

▸ onContextLost(): void

Returns

void

---

onContextLostEvent

▸ onContextLostEvent(): void

Returns

void

---

onContextRestoreEvent

▸ onContextRestoreEvent(): void

Returns

void

---

dumpEngineInfo

▸ dumpEngineInfo(): void

Returns

void