RoyInterface / Exports / scene/RoySkybox / RoySkyBox

Class: RoySkyBox

scene/RoySkybox.RoySkyBox

Table of contents

Constructors

• constructor

Properties

• sTypeClass
• m_impl
• m_parentScene
• s_handleID
• m_handleID
• m_enabled
• m_visible
• m_color
• m_rotation
• m_ignoreIntensity
• m_halfSize
• m_provider
• m_providerHdr
• m_baseRotation

Accessors

• impl
• parentScene
• enabled
• visible
• color
• rotation
• ignoreIntensity
• halfSize
• provider
• providerHdr
• baseRotation

Methods

• registerImplClass
• handleID
• setParamDirty
• destroy
• onAddToScene
• onRemoveFromScene
• markContentDirtyFromObject

Constructors

constructor

• new RoySkyBox(scene): RoySkyBox

Parameters

Name	Type
scene	RoyScene

Returns

RoySkyBox

Properties

sTypeClass

▪ Static Protected sTypeClass: Object = {}

Index signature

▪ [key: number]: RoySkyboxImplClass

---

m_impl

• Private m_impl: RoySkyboxImpl[]

---

m_parentScene

• Private m_parentScene: RoyScene

---

s_handleID

▪ Static Private s_handleID: number = 1

---

m_handleID

• Private m_handleID: number

---

m_enabled

• Private m_enabled: boolean = true

---

m_visible

• Private m_visible: boolean = true

---

m_color

• Private m_color: number[]

---

m_rotation

• Private m_rotation: number = 0

---

m_ignoreIntensity

• Private m_ignoreIntensity: boolean = true

---

m_halfSize

• Private m_halfSize: number = 0

---

m_provider

• Private m_provider: RoyTextureProvider

---

m_providerHdr

• Private m_providerHdr: RoyTextureProvider

---

m_baseRotation

• Private m_baseRotation: number = 0

Accessors

impl

• get impl(): RoySkyboxImpl[]

Returns

RoySkyboxImpl[]

---

parentScene

• get parentScene(): RoyScene

Returns

RoyScene

---

enabled

• get enabled(): boolean

Returns

boolean

• set enabled(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

---

color

• get color(): number[]

Returns

number[]

• set color(value): void

Parameters

Name	Type
value	number[]

Returns

void

---

rotation

• get rotation(): number

Returns

number

• set rotation(value): void

Parameters

Name	Type
value	number

Returns

void

---

ignoreIntensity

• get ignoreIntensity(): boolean

Returns

boolean

• set ignoreIntensity(value): void

Parameters

Name	Type
value	boolean

Returns

void

---

halfSize

• get halfSize(): number

Returns

number

• set halfSize(value): void

Parameters

Name	Type
value	number

Returns

void

---

provider

• get provider(): RoyTextureProvider

Returns

RoyTextureProvider

• set provider(value): void

Parameters

Name	Type
value	RoyTextureProvider

Returns

void

---

providerHdr

• get providerHdr(): RoyTextureProvider

Returns

RoyTextureProvider

• set providerHdr(value): void

Parameters

Name	Type
value	RoyTextureProvider

Returns

void

---

baseRotation

• get baseRotation(): number

Returns

number

• set baseRotation(value): void

Parameters

Name	Type
value	number

Returns

void

Methods

registerImplClass

▸ registerImplClass(type, classIns): void

Parameters

Name	Type
type	RendererType
classIns	RoySkyboxImplClass

Returns

void

---

handleID

▸ handleID(): number

Returns

number

---

setParamDirty

▸ setParamDirty(flag): void

Parameters

Name	Type
flag	SkyboxDirtyFlag

Returns

void

---

destroy

▸ destroy(): void

Returns

void

---

onAddToScene

▸ onAddToScene(): void

Returns

void

---

onRemoveFromScene

▸ onRemoveFromScene(): void

Returns

void

---

markContentDirtyFromObject

▸ markContentDirtyFromObject(): void

Returns

void