@orillusion/core

---

Class: AtmosphericComponent

Defined in: src/components/AtmosphericComponent.ts:44

Atmospheric Sky Box Component

Extends

• SkyRenderer

Constructors

Constructor

new AtmosphericComponent(): AtmosphericComponent

Defined in: src/components/renderer/MeshRenderer.ts:26

Returns

AtmosphericComponent

Inherited from

SkyRenderer.constructor

Properties

object3D

object3D: Object3D = null

Defined in: src/components/ComponentBase.ts:29

owner object3D

Inherited from

SkyRenderer.object3D

---

isDestroyed

isDestroyed: boolean = false

Defined in: src/components/ComponentBase.ts:77

Inherited from

SkyRenderer.isDestroyed

---

receiveShadow

receiveShadow: boolean

Defined in: src/components/renderer/MeshRenderer.ts:23

Enabling this option allows the grid to display any shadows cast on the grid.

Inherited from

SkyRenderer.receiveShadow

---

morphData

morphData: MorphTargetData

Defined in: src/components/renderer/MeshRenderer.ts:24

Inherited from

SkyRenderer.morphData

---

instanceCount

instanceCount: number = 0

Defined in: src/components/renderer/RenderNode.ts:35

Inherited from

SkyRenderer.instanceCount

---

lodLevel

lodLevel: number = 0

Defined in: src/components/renderer/RenderNode.ts:36

Inherited from

SkyRenderer.lodLevel

---

alwaysRender

alwaysRender: boolean = false

Defined in: src/components/renderer/RenderNode.ts:37

Inherited from

SkyRenderer.alwaysRender

---

instanceID

instanceID: string

Defined in: src/components/renderer/RenderNode.ts:38

Inherited from

SkyRenderer.instanceID

---

drawType

drawType: number = 0

Defined in: src/components/renderer/RenderNode.ts:39

Inherited from

SkyRenderer.drawType

---

isRenderOrderChange?

optional isRenderOrderChange?: boolean

Defined in: src/components/renderer/RenderNode.ts:55

Inherited from

SkyRenderer.isRenderOrderChange

---

needSortOnCameraZ?

optional needSortOnCameraZ?: boolean

Defined in: src/components/renderer/RenderNode.ts:56

Inherited from

SkyRenderer.needSortOnCameraZ

---

shadowCacheMode

shadowCacheMode: "auto" | "static" | "dynamic" = 'auto'

Defined in: src/components/renderer/RenderNode.ts:437

Shadow cache classification.

• 'auto' (default): renderer is drawn to the shadow map every frame as part of the single-pass render — matches historical behaviour.
• 'static': renderer is drawn only to the cached static depth layer, rebuilt lazily when the light moves or the scene explicitly marks the static cache dirty. Use for buildings, terrain, prop meshes that don't move.
• 'dynamic': renderer is drawn every frame on top of the copied-in static layer. Use for characters, physics objects, anything that moves.

Only consulted when engine.setting.shadow.enableStaticCache === true; otherwise all renderers behave as 'auto'.

Inherited from

SkyRenderer.shadowCacheMode

---

skyMaterial

skyMaterial: SkyMaterial

Defined in: src/components/renderer/SkyRenderer.ts:27

The material used in the Sky Box.

Inherited from

SkyRenderer.skyMaterial

Accessors

sunX

Get Signature

get sunX(): number

Defined in: src/components/AtmosphericComponent.ts:59

Horizontal sun position in normalized [0,1] sky coordinates.

Returns

number

Set Signature

set sunX(value): void

Defined in: src/components/AtmosphericComponent.ts:60

Parameters

value

number

Returns

void

---

sunY

Get Signature

get sunY(): number

Defined in: src/components/AtmosphericComponent.ts:65

Vertical sun position in normalized [0,1] sky coordinates.

Returns

number

Set Signature

set sunY(value): void

Defined in: src/components/AtmosphericComponent.ts:66

Parameters

value

number

Returns

void

---

eyePos

Get Signature

get eyePos(): number

Defined in: src/components/AtmosphericComponent.ts:71

Eye (viewer) altitude used by the atmospheric scattering model.

Returns

number

Set Signature

set eyePos(value): void

Defined in: src/components/AtmosphericComponent.ts:72

Parameters

value

number

Returns

void

---

sunRadius

Get Signature

get sunRadius(): number

Defined in: src/components/AtmosphericComponent.ts:77

Angular radius of the sun disc.

Returns

number

Set Signature

set sunRadius(value): void

Defined in: src/components/AtmosphericComponent.ts:78

Parameters

value

number

Returns

void

---

sunRadiance

Get Signature

get sunRadiance(): number

Defined in: src/components/AtmosphericComponent.ts:83

Radiance (intensity) of the sun.

Returns

number

Set Signature

set sunRadiance(value): void

Defined in: src/components/AtmosphericComponent.ts:84

Parameters

value

number

Returns

void

---

sunBrightness

Get Signature

get sunBrightness(): number

Defined in: src/components/AtmosphericComponent.ts:89

Overall brightness of the sun.

Returns

number

Set Signature

set sunBrightness(value): void

Defined in: src/components/AtmosphericComponent.ts:90

Parameters

value

number

Returns

void

---

displaySun

Get Signature

get displaySun(): boolean

Defined in: src/components/AtmosphericComponent.ts:95

Whether the sun disc is drawn in the sky.

Returns

boolean

Set Signature

set displaySun(value): void

Defined in: src/components/AtmosphericComponent.ts:96

Parameters

value

boolean

Returns

void

---

relativeTransform

Get Signature

get relativeTransform(): Transform

Defined in: src/components/AtmosphericComponent.ts:124

Transform whose rotation is kept in sync with the sun direction.

Returns

Transform

Set Signature

set relativeTransform(value): void

Defined in: src/components/AtmosphericComponent.ts:128

Parameters

value

Transform

Returns

void

---

visibleLayer

Get Signature

get visibleLayer(): number

Defined in: src/components/ComponentBase.ts:46

Composition-layer membership bitmask. The pass / camera / collector filters via

(component.visibleLayer & pass.layerMask & camera.cullingMask) !== 0

Defaults to VisibleLayer.Default (bit 0) so a fresh subclass is visible to passes whose layerMask is VisibleLayer.All (which includes bit 0). Application code can assign project-specific bits (1..31) to organise the scene into composition layers.

Returns

number

Set Signature

set visibleLayer(value): void

Defined in: src/components/ComponentBase.ts:50

Parameters

value

number

Returns

void

Inherited from

SkyRenderer.visibleLayer

---

eventDispatcher

Get Signature

get eventDispatcher(): CEventDispatcher

Defined in: src/components/ComponentBase.ts:63

Returns

CEventDispatcher

Set Signature

set eventDispatcher(value): void

Defined in: src/components/ComponentBase.ts:68

Parameters

value

CEventDispatcher

Returns

void

Inherited from

SkyRenderer.eventDispatcher

---

isStart

Get Signature

get isStart(): boolean

Defined in: src/components/ComponentBase.ts:79

Returns

boolean

Inherited from

SkyRenderer.isStart

---

transform

Get Signature

get transform(): Transform

Defined in: src/components/ComponentBase.ts:89

Return the Transform component attached to the Object3D. Null before the component is attached — addComponent assigns object3D only after construction — so constructor-time callers can probe safely via this.transform?..

Returns

Transform

Inherited from

SkyRenderer.transform

---

enable

Get Signature

get enable(): boolean

Defined in: src/components/ComponentBase.ts:113

Enable/disable components. The enabled components can be updated, while the disabled components cannot be updated.

Returns

boolean

Set Signature

set enable(value): void

Defined in: src/components/ComponentBase.ts:96

Enable/disable components. The enabled components can be updated, while the disabled components cannot be updated.

Parameters

value

boolean

Returns

void

Inherited from

SkyRenderer.enable

---

geometry

Get Signature

get geometry(): GeometryBase

Defined in: src/components/renderer/MeshRenderer.ts:53

The geometry of the mesh determines its shape

Returns

GeometryBase

Set Signature

set geometry(value): void

Defined in: src/components/renderer/MeshRenderer.ts:57

Parameters

value

GeometryBase

Returns

void

Inherited from

SkyRenderer.geometry

---

material

Get Signature

get material(): Material

Defined in: src/components/renderer/MeshRenderer.ts:99

material

Returns

Material

Set Signature

set material(value): void

Defined in: src/components/renderer/MeshRenderer.ts:103

Parameters

value

Material

Returns

void

Inherited from

SkyRenderer.material

---

batchMode

Get Signature

get batchMode(): BatchMode

Defined in: src/components/renderer/RenderNode.ts:118

Returns

BatchMode

Set Signature

set batchMode(value): void

Defined in: src/components/renderer/RenderNode.ts:122

Parameters

value

BatchMode

Returns

void

Inherited from

SkyRenderer.batchMode

---

rendererMask

Get Signature

get rendererMask(): number

Defined in: src/components/renderer/RenderNode.ts:156

Returns

number

Set Signature

set rendererMask(value): void

Defined in: src/components/renderer/RenderNode.ts:160

Parameters

value

number

Returns

void

Inherited from

SkyRenderer.rendererMask

---

renderOrder

Get Signature

get renderOrder(): number

Defined in: src/components/renderer/RenderNode.ts:164

Returns

number

Set Signature

set renderOrder(value): void

Defined in: src/components/renderer/RenderNode.ts:168

Parameters

value

number

Returns

void

Inherited from

SkyRenderer.renderOrder

---

materials

Get Signature

get materials(): Material[]

Defined in: src/components/renderer/RenderNode.ts:177

Returns

Material[]

Set Signature

set materials(value): void

Defined in: src/components/renderer/RenderNode.ts:181

Parameters

value

Material[]

Returns

void

Inherited from

SkyRenderer.materials

---

castShadow

Get Signature

get castShadow(): boolean

Defined in: src/components/renderer/RenderNode.ts:413

Returns

boolean

Set Signature

set castShadow(value): void

Defined in: src/components/renderer/RenderNode.ts:417

Parameters

value

boolean

Returns

void

Inherited from

SkyRenderer.castShadow

---

castGI

Get Signature

get castGI(): boolean

Defined in: src/components/renderer/RenderNode.ts:440

Returns

boolean

Set Signature

set castGI(value): void

Defined in: src/components/renderer/RenderNode.ts:444

Parameters

value

boolean

Returns

void

Inherited from

SkyRenderer.castGI

---

castReflection

Get Signature

get castReflection(): boolean

Defined in: src/components/renderer/RenderNode.ts:448

Returns

boolean

Set Signature

set castReflection(value): void

Defined in: src/components/renderer/RenderNode.ts:452

Parameters

value

boolean

Returns

void

Inherited from

SkyRenderer.castReflection

---

map

Get Signature

get map(): Texture

Defined in: src/components/renderer/SkyRenderer.ts:92

get environment texture

Returns

Texture

Set Signature

set map(texture): void

Defined in: src/components/renderer/SkyRenderer.ts:80

set environment texture

Parameters

texture

Texture

Returns

void

Inherited from

SkyRenderer.map

---

exposure

Get Signature

get exposure(): number

Defined in: src/components/renderer/SkyRenderer.ts:96

Returns

number

Set Signature

set exposure(value): void

Defined in: src/components/renderer/SkyRenderer.ts:100

Parameters

value

number

Returns

void

Inherited from

SkyRenderer.exposure

---

roughness

Get Signature

get roughness(): number

Defined in: src/components/renderer/SkyRenderer.ts:105

Returns

number

Set Signature

set roughness(value): void

Defined in: src/components/renderer/SkyRenderer.ts:109

Parameters

value

number

Returns

void

Inherited from

SkyRenderer.roughness

Methods

init()

init(): void

Defined in: src/components/AtmosphericComponent.ts:102

Initialize history tracking and the pending sky setting.

Returns

void

Overrides

SkyRenderer.init

---

start()

start(view?): void

Defined in: src/components/AtmosphericComponent.ts:117

Ensure the GPU sky exists, then run base startup.

Parameters

view?

any

Returns

void

Overrides

SkyRenderer.start

---

onUpdate()

onUpdate(view?): void

Defined in: src/components/AtmosphericComponent.ts:134

Per-frame update: sync sun/transform rotation and re-bake the sky on change.

Parameters

view?

any

Returns

void

Overrides

SkyRenderer.onUpdate

---

destroy()

destroy(force?): void

Defined in: src/components/AtmosphericComponent.ts:158

Destroy the component and release the GPU sky resources.

Parameters

force?

boolean

Returns

void

Overrides

SkyRenderer.destroy

---

stop()

stop(): void

Defined in: src/components/ComponentBase.ts:163

Returns

void

Inherited from

SkyRenderer.stop

---

onLateUpdate()?

optional onLateUpdate(view?): any

Defined in: src/components/ComponentBase.ts:167

Parameters

view?

View3D

Returns

any

Inherited from

SkyRenderer.onLateUpdate

---

onBeforeUpdate()?

optional onBeforeUpdate(view?): any

Defined in: src/components/ComponentBase.ts:168

Parameters

view?

View3D

Returns

any

Inherited from

SkyRenderer.onBeforeUpdate

---

onGraphic()?

optional onGraphic(view?): any

Defined in: src/components/ComponentBase.ts:170

Parameters

view?

View3D

Returns

any

Inherited from

SkyRenderer.onGraphic

---

onParentChange()?

optional onParentChange(lastParent?, currentParent?): any

Defined in: src/components/ComponentBase.ts:171

Parameters

lastParent?

Object3D

currentParent?

Object3D

Returns

any

Inherited from

SkyRenderer.onParentChange

---

onAddChild()?

optional onAddChild(child): any

Defined in: src/components/ComponentBase.ts:172

Parameters

child

Object3D

Returns

any

Inherited from

SkyRenderer.onAddChild

---

onRemoveChild()?

optional onRemoveChild(child): any

Defined in: src/components/ComponentBase.ts:173

Parameters

child

Object3D

Returns

any

Inherited from

SkyRenderer.onRemoveChild

---

cloneTo()

cloneTo(obj): void

Defined in: src/components/renderer/MeshRenderer.ts:38

clone component data to target object3D

Parameters

obj

Object3D

target object3D

Returns

void

Inherited from

SkyRenderer.cloneTo

---

copyComponent()

copyComponent(from): this

Defined in: src/components/renderer/MeshRenderer.ts:43

Parameters

from

this

Returns

this

Inherited from

SkyRenderer.copyComponent

---

setMorphInfluence()

setMorphInfluence(key, value): void

Defined in: src/components/renderer/MeshRenderer.ts:110

Set deformation animation parameters

Parameters

key

string

value

number

Returns

void

Inherited from

SkyRenderer.setMorphInfluence

---

setMorphInfluenceIndex()

setMorphInfluenceIndex(index, value): void

Defined in: src/components/renderer/MeshRenderer.ts:119

Parameters

index

number

value

number

Returns

void

Inherited from

SkyRenderer.setMorphInfluenceIndex

---

onCompute()

onCompute(view, command): void

Defined in: src/components/renderer/MeshRenderer.ts:128

Parameters

view

View3D

command

GPUCommandEncoder

Returns

void

Inherited from

SkyRenderer.onCompute

---

attachSceneOctree()

attachSceneOctree(octree): void

Defined in: src/components/renderer/RenderNode.ts:87

Parameters

octree

Octree

Returns

void

Inherited from

SkyRenderer.attachSceneOctree

---

detachSceneOctree()

detachSceneOctree(): void

Defined in: src/components/renderer/RenderNode.ts:92

Returns

void

Inherited from

SkyRenderer.detachSceneOctree

---

addMask()

addMask(mask): void

Defined in: src/components/renderer/RenderNode.ts:144

Parameters

mask

RendererMask

Returns

void

Inherited from

SkyRenderer.addMask

---

removeMask()

removeMask(mask): void

Defined in: src/components/renderer/RenderNode.ts:148

Parameters

mask

RendererMask

Returns

void

Inherited from

SkyRenderer.removeMask

---

hasMask()

hasMask(mask): boolean

Defined in: src/components/renderer/RenderNode.ts:152

Parameters

mask

RendererMask

Returns

boolean

Inherited from

SkyRenderer.hasMask

---

addRendererMask()

addRendererMask(tag): void

Defined in: src/components/renderer/RenderNode.ts:232

Parameters

tag

RendererMask

Returns

void

Inherited from

SkyRenderer.addRendererMask

---

removeRendererMask()

removeRendererMask(tag): void

Defined in: src/components/renderer/RenderNode.ts:236

Parameters

tag

RendererMask

Returns

void

Inherited from

SkyRenderer.removeRendererMask

---

refreshRenderClassification()

refreshRenderClassification(): void

Defined in: src/components/renderer/RenderNode.ts:270

Recompute renderOrder from current pass states and re-bucket this renderer in EntityCollect (opaque vs transparent map).

Called when a material's alphaMode flips at runtime — the pass.renderOrder changes (3000 ↔ 0), but EntityCollect classifies once at addRenderNode time. Without this nudge the renderer stays in its old list and gets drawn through the wrong pipeline (e.g. WBOIT continues drawing a HASH-toggled material).

Materials hop into this via Reference.getReference(material) to find every renderer holding them; sample code can also call it directly after manual state changes.

Returns

void

Inherited from

SkyRenderer.refreshRenderClassification

---

selfCloneMaterials()

selfCloneMaterials(key): this

Defined in: src/components/renderer/RenderNode.ts:295

Parameters

key

string

Returns

this

Inherited from

SkyRenderer.selfCloneMaterials

---

renderPass()

renderPass(view, passType, renderContext): void

Defined in: src/components/renderer/RenderNode.ts:456

Parameters

view

View3D

passType

PassType

renderContext

RenderContext

Returns

void

Inherited from

SkyRenderer.renderPass

---

recordRenderPass2()

recordRenderPass2(view, passType, rendererPassState, clusterLightingBuffer, encoder, useBundle?): void

Defined in: src/components/renderer/RenderNode.ts:586

Parameters

view

View3D

passType

PassType

rendererPassState

RendererPassState

clusterLightingBuffer

ClusterLightingBuffer

encoder

GPURenderPassEncoder

useBundle?

boolean = false

Returns

void

Inherited from

SkyRenderer.recordRenderPass2

---

preInit()

preInit(_rendererType): boolean

Defined in: src/components/renderer/RenderNode.ts:624

Parameters

_rendererType

PassType

Returns

boolean

Inherited from

SkyRenderer.preInit

---

beforeDestroy()

beforeDestroy(force?): void

Defined in: src/components/renderer/RenderNode.ts:741

before release this component, object refrences are not be set null now.

Parameters

force?

boolean

Returns

void

Inherited from

SkyRenderer.beforeDestroy

---

onEnable()

onEnable(): void

Defined in: src/components/renderer/SkyRenderer.ts:40

Returns

void

Inherited from

SkyRenderer.onEnable

---

onDisable()

onDisable(): void

Defined in: src/components/renderer/SkyRenderer.ts:57

Returns

void

Inherited from

SkyRenderer.onDisable

---

renderPass2()

renderPass2(view, passType, rendererPassState, clusterLightingBuffer, encoder, useBundle?): void

Defined in: src/components/renderer/SkyRenderer.ts:71

render pass at passType

Parameters

view

View3D

passType

PassType

rendererPassState

RendererPassState

clusterLightingBuffer

ClusterLightingBuffer

encoder

GPURenderPassEncoder

useBundle?

boolean = false

Returns

void

Inherited from

SkyRenderer.renderPass2

---

useSkyReflection()

useSkyReflection(): void

Defined in: src/components/renderer/SkyRenderer.ts:114

Returns

void

Inherited from

SkyRenderer.useSkyReflection