Class: AtmosphericComponent

Atmospheric Sky Box Component

Hierarchy

• SkyRenderer

  ↳ AtmosphericComponent

Constructors

• constructor

Properties

• object3D
• isDestroyed
• receiveShadow
• morphData
• instanceCount
• lodLevel
• alwaysRender
• instanceID
• drawType
• isRenderOrderChange
• needSortOnCameraZ
• isRecievePostEffectUI
• skyMaterial

Accessors

• sunX
• sunY
• eyePos
• sunRadius
• sunRadiance
• sunBrightness
• displaySun
• relativeTransform
• eventDispatcher
• isStart
• transform
• enable
• geometry
• material
• renderLayer
• rendererMask
• renderOrder
• materials
• castShadow
• castGI
• castReflection
• map
• exposure
• roughness

Methods

• init
• start
• onUpdate
• destroy
• stop
• onLateUpdate
• onBeforeUpdate
• onGraphic
• onParentChange
• onAddChild
• onRemoveChild
• cloneTo
• copyComponent
• setMorphInfluence
• setMorphInfluenceIndex
• onCompute
• attachSceneOctree
• detachSceneOctree
• addMask
• removeMask
• hasMask
• addRendererMask
• removeRendererMask
• selfCloneMaterials
• renderPass
• recordRenderPass2
• preInit
• beforeDestroy
• onEnable
• onDisable
• nodeUpdate
• renderPass2
• useSkyReflection

Constructors

constructor

• new AtmosphericComponent(): AtmosphericComponent

Returns

AtmosphericComponent

Inherited from

SkyRenderer.constructor

Defined in

src/components/renderer/MeshRenderer.ts:26

Properties

object3D

• object3D: Object3D = null

owner object3D

Inherited from

SkyRenderer.object3D

Defined in

src/components/ComponentBase.ts:17

---

isDestroyed

• Optional isDestroyed: boolean

Inherited from

SkyRenderer.isDestroyed

Defined in

src/components/ComponentBase.ts:38

---

receiveShadow

• receiveShadow: boolean

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

Inherited from

SkyRenderer.receiveShadow

Defined in

src/components/renderer/MeshRenderer.ts:23

---

morphData

• morphData: MorphTargetData

Inherited from

SkyRenderer.morphData

Defined in

src/components/renderer/MeshRenderer.ts:24

---

instanceCount

• instanceCount: number = 0

Inherited from

SkyRenderer.instanceCount

Defined in

src/components/renderer/RenderNode.ts:35

---

lodLevel

• lodLevel: number = 0

Inherited from

SkyRenderer.lodLevel

Defined in

src/components/renderer/RenderNode.ts:36

---

alwaysRender

• alwaysRender: boolean = false

Inherited from

SkyRenderer.alwaysRender

Defined in

src/components/renderer/RenderNode.ts:37

---

instanceID

• instanceID: string

Inherited from

SkyRenderer.instanceID

Defined in

src/components/renderer/RenderNode.ts:38

---

drawType

• drawType: number = 0

Inherited from

SkyRenderer.drawType

Defined in

src/components/renderer/RenderNode.ts:39

---

isRenderOrderChange

• Optional isRenderOrderChange: boolean

Inherited from

SkyRenderer.isRenderOrderChange

Defined in

src/components/renderer/RenderNode.ts:55

---

needSortOnCameraZ

• Optional needSortOnCameraZ: boolean

Inherited from

SkyRenderer.needSortOnCameraZ

Defined in

src/components/renderer/RenderNode.ts:56

---

isRecievePostEffectUI

• Optional isRecievePostEffectUI: boolean

Inherited from

SkyRenderer.isRecievePostEffectUI

Defined in

src/components/renderer/RenderNode.ts:57

---

skyMaterial

• skyMaterial: SkyMaterial

The material used in the Sky Box.

Inherited from

SkyRenderer.skyMaterial

Defined in

src/components/renderer/SkyRenderer.ts:27

Accessors

sunX

• get sunX(): number

Returns

number

Defined in

src/components/AtmosphericComponent.ts:50

• set sunX(value): void

Parameters

Name	Type
value	number

Returns

void

Defined in

src/components/AtmosphericComponent.ts:54

---

sunY

• get sunY(): number

Returns

number

Defined in

src/components/AtmosphericComponent.ts:61

• set sunY(value): void

Parameters

Name	Type
value	number

Returns

void

Defined in

src/components/AtmosphericComponent.ts:65

---

eyePos

• get eyePos(): number

Returns

number

Defined in

src/components/AtmosphericComponent.ts:72

• set eyePos(value): void

Parameters

Name	Type
value	number

Returns

void

Defined in

src/components/AtmosphericComponent.ts:76

---

sunRadius

• get sunRadius(): number

Returns

number

Defined in

src/components/AtmosphericComponent.ts:83

• set sunRadius(value): void

Parameters

Name	Type
value	number

Returns

void

Defined in

src/components/AtmosphericComponent.ts:87

---

sunRadiance

• get sunRadiance(): number

Returns

number

Defined in

src/components/AtmosphericComponent.ts:94

• set sunRadiance(value): void

Parameters

Name	Type
value	number

Returns

void

Defined in

src/components/AtmosphericComponent.ts:98

---

sunBrightness

• get sunBrightness(): number

Returns

number

Defined in

src/components/AtmosphericComponent.ts:105

• set sunBrightness(value): void

Parameters

Name	Type
value	number

Returns

void

Defined in

src/components/AtmosphericComponent.ts:109

---

displaySun

• get displaySun(): boolean

Returns

boolean

Defined in

src/components/AtmosphericComponent.ts:116

• set displaySun(value): void

Parameters

Name	Type
value	boolean

Returns

void

Defined in

src/components/AtmosphericComponent.ts:120

---

relativeTransform

• get relativeTransform(): Transform

Returns

Transform

Defined in

src/components/AtmosphericComponent.ts:147

• set relativeTransform(value): void

Parameters

Name	Type
value	Transform

Returns

void

Defined in

src/components/AtmosphericComponent.ts:151

---

eventDispatcher

• get eventDispatcher(): CEventDispatcher

Returns

CEventDispatcher

Inherited from

SkyRenderer.eventDispatcher

Defined in

src/components/ComponentBase.ts:23

• set eventDispatcher(value): void

Parameters

Name	Type
value	CEventDispatcher

Returns

void

Inherited from

SkyRenderer.eventDispatcher

Defined in

src/components/ComponentBase.ts:28

---

isStart

• get isStart(): boolean

Returns

boolean

Inherited from

SkyRenderer.isStart

Defined in

src/components/ComponentBase.ts:40

---

transform

• get transform(): Transform

Return the Transform component attached to the Object3D.

Returns

Transform

Inherited from

SkyRenderer.transform

Defined in

src/components/ComponentBase.ts:47

---

enable

• get enable(): boolean

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

Returns

boolean

Inherited from

SkyRenderer.enable

Defined in

src/components/ComponentBase.ts:68

• set enable(value): void

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

Parameters

Name	Type
value	boolean

Returns

void

Inherited from

SkyRenderer.enable

Defined in

src/components/ComponentBase.ts:54

---

geometry

• get geometry(): GeometryBase

The geometry of the mesh determines its shape

Returns

GeometryBase

Inherited from

SkyRenderer.geometry

Defined in

src/components/renderer/MeshRenderer.ts:53

• set geometry(value): void

Parameters

Name	Type
value	GeometryBase

Returns

void

Inherited from

SkyRenderer.geometry

Defined in

src/components/renderer/MeshRenderer.ts:57

---

material

• get material(): Material

material

Returns

Material

Inherited from

SkyRenderer.material

Defined in

src/components/renderer/MeshRenderer.ts:99

• set material(value): void

Parameters

Name	Type
value	Material

Returns

void

Inherited from

SkyRenderer.material

Defined in

src/components/renderer/MeshRenderer.ts:103

---

renderLayer

• get renderLayer(): RenderLayer

Returns

RenderLayer

Inherited from

SkyRenderer.renderLayer

Defined in

src/components/renderer/RenderNode.ts:110

• set renderLayer(value): void

Parameters

Name	Type
value	RenderLayer

Returns

void

Inherited from

SkyRenderer.renderLayer

Defined in

src/components/renderer/RenderNode.ts:114

---

rendererMask

• get rendererMask(): number

Returns

number

Inherited from

SkyRenderer.rendererMask

Defined in

src/components/renderer/RenderNode.ts:152

• set rendererMask(value): void

Parameters

Name	Type
value	number

Returns

void

Inherited from

SkyRenderer.rendererMask

Defined in

src/components/renderer/RenderNode.ts:156

---

renderOrder

• get renderOrder(): number

Returns

number

Inherited from

SkyRenderer.renderOrder

Defined in

src/components/renderer/RenderNode.ts:160

• set renderOrder(value): void

Parameters

Name	Type
value	number

Returns

void

Inherited from

SkyRenderer.renderOrder

Defined in

src/components/renderer/RenderNode.ts:164

---

materials

• get materials(): Material[]

Returns

Material[]

Inherited from

SkyRenderer.materials

Defined in

src/components/renderer/RenderNode.ts:173

• set materials(value): void

Parameters

Name	Type
value	Material[]

Returns

void

Inherited from

SkyRenderer.materials

Defined in

src/components/renderer/RenderNode.ts:177

---

castShadow

• get castShadow(): boolean

Returns

boolean

Inherited from

SkyRenderer.castShadow

Defined in

src/components/renderer/RenderNode.ts:345

• set castShadow(value): void

Parameters

Name	Type
value	boolean

Returns

void

Inherited from

SkyRenderer.castShadow

Defined in

src/components/renderer/RenderNode.ts:349

---

castGI

• get castGI(): boolean

Returns

boolean

Inherited from

SkyRenderer.castGI

Defined in

src/components/renderer/RenderNode.ts:354

• set castGI(value): void

Parameters

Name	Type
value	boolean

Returns

void

Inherited from

SkyRenderer.castGI

Defined in

src/components/renderer/RenderNode.ts:358

---

castReflection

• get castReflection(): boolean

Returns

boolean

Inherited from

SkyRenderer.castReflection

Defined in

src/components/renderer/RenderNode.ts:362

• set castReflection(value): void

Parameters

Name	Type
value	boolean

Returns

void

Inherited from

SkyRenderer.castReflection

Defined in

src/components/renderer/RenderNode.ts:366

---

map

• get map(): Texture

get environment texture

Returns

Texture

Inherited from

SkyRenderer.map

Defined in

src/components/renderer/SkyRenderer.ts:87

• set map(texture): void

set environment texture

Parameters

Name	Type
texture	Texture

Returns

void

Inherited from

SkyRenderer.map

Defined in

src/components/renderer/SkyRenderer.ts:75

---

exposure

• get exposure(): number

Returns

number

Inherited from

SkyRenderer.exposure

Defined in

src/components/renderer/SkyRenderer.ts:91

• set exposure(value): void

Parameters

Name	Type
value	number

Returns

void

Inherited from

SkyRenderer.exposure

Defined in

src/components/renderer/SkyRenderer.ts:95

---

roughness

• get roughness(): number

Returns

number

Inherited from

SkyRenderer.roughness

Defined in

src/components/renderer/SkyRenderer.ts:100

• set roughness(value): void

Parameters

Name	Type
value	number

Returns

void

Inherited from

SkyRenderer.roughness

Defined in

src/components/renderer/SkyRenderer.ts:104

Methods

init

▸ init(): void

Returns

void

Overrides

SkyRenderer.init

Defined in

src/components/AtmosphericComponent.ts:128

---

start

▸ start(view?): void

Parameters

Name	Type
view?	any

Returns

void

Overrides

SkyRenderer.start

Defined in

src/components/AtmosphericComponent.ts:140

---

onUpdate

▸ onUpdate(view?): void

Parameters

Name	Type
view?	any

Returns

void

Overrides

SkyRenderer.onUpdate

Defined in

src/components/AtmosphericComponent.ts:156

---

destroy

▸ destroy(force?): void

Parameters

Name	Type
force?	boolean

Returns

void

Overrides

SkyRenderer.destroy

Defined in

src/components/AtmosphericComponent.ts:176

---

stop

▸ stop(): void

Returns

void

Inherited from

SkyRenderer.stop

Defined in

src/components/ComponentBase.ts:114

---

onLateUpdate

▸ onLateUpdate(view?): any

Parameters

Name	Type
view?	View3D

Returns

any

Inherited from

SkyRenderer.onLateUpdate

Defined in

src/components/ComponentBase.ts:118

---

onBeforeUpdate

▸ onBeforeUpdate(view?): any

Parameters

Name	Type
view?	View3D

Returns

any

Inherited from

SkyRenderer.onBeforeUpdate

Defined in

src/components/ComponentBase.ts:119

---

onGraphic

▸ onGraphic(view?): any

Parameters

Name	Type
view?	View3D

Returns

any

Inherited from

SkyRenderer.onGraphic

Defined in

src/components/ComponentBase.ts:121

---

onParentChange

▸ onParentChange(lastParent?, currentParent?): any

Parameters

Name	Type
lastParent?	Object3D
currentParent?	Object3D

Returns

any

Inherited from

SkyRenderer.onParentChange

Defined in

src/components/ComponentBase.ts:122

---

onAddChild

▸ onAddChild(child): any

Parameters

Name	Type
child	Object3D

Returns

any

Inherited from

SkyRenderer.onAddChild

Defined in

src/components/ComponentBase.ts:123

---

onRemoveChild

▸ onRemoveChild(child): any

Parameters

Name	Type
child	Object3D

Returns

any

Inherited from

SkyRenderer.onRemoveChild

Defined in

src/components/ComponentBase.ts:124

---

cloneTo

▸ cloneTo(obj): void

Parameters

Name	Type
obj	Object3D

Returns

void

Inherited from

SkyRenderer.cloneTo

Defined in

src/components/renderer/MeshRenderer.ts:38

---

copyComponent

▸ copyComponent(from): this

Parameters

Name	Type
from	this

Returns

this

Inherited from

SkyRenderer.copyComponent

Defined in

src/components/renderer/MeshRenderer.ts:43

---

setMorphInfluence

▸ setMorphInfluence(key, value): void

Set deformation animation parameters

Parameters

Name	Type
key	string
value	number

Returns

void

Inherited from

SkyRenderer.setMorphInfluence

Defined in

src/components/renderer/MeshRenderer.ts:110

---

setMorphInfluenceIndex

▸ setMorphInfluenceIndex(index, value): void

Parameters

Name	Type
index	number
value	number

Returns

void

Inherited from

SkyRenderer.setMorphInfluenceIndex

Defined in

src/components/renderer/MeshRenderer.ts:119

---

onCompute

▸ onCompute(view, command): void

Parameters

Name	Type
view	View3D
command	GPUCommandEncoder

Returns

void

Inherited from

SkyRenderer.onCompute

Defined in

src/components/renderer/MeshRenderer.ts:128

---

attachSceneOctree

▸ attachSceneOctree(octree): void

Parameters

Name	Type
octree	Octree

Returns

void

Inherited from

SkyRenderer.attachSceneOctree

Defined in

src/components/renderer/RenderNode.ts:78

---

detachSceneOctree

▸ detachSceneOctree(): void

Returns

void

Inherited from

SkyRenderer.detachSceneOctree

Defined in

src/components/renderer/RenderNode.ts:83

---

addMask

▸ addMask(mask): void

Parameters

Name	Type
mask	RendererMask

Returns

void

Inherited from

SkyRenderer.addMask

Defined in

src/components/renderer/RenderNode.ts:140

---

removeMask

▸ removeMask(mask): void

Parameters

Name	Type
mask	RendererMask

Returns

void

Inherited from

SkyRenderer.removeMask

Defined in

src/components/renderer/RenderNode.ts:144

---

hasMask

▸ hasMask(mask): boolean

Parameters

Name	Type
mask	RendererMask

Returns

boolean

Inherited from

SkyRenderer.hasMask

Defined in

src/components/renderer/RenderNode.ts:148

---

addRendererMask

▸ addRendererMask(tag): void

Parameters

Name	Type
tag	RendererMask

Returns

void

Inherited from

SkyRenderer.addRendererMask

Defined in

src/components/renderer/RenderNode.ts:228

---

removeRendererMask

▸ removeRendererMask(tag): void

Parameters

Name	Type
tag	RendererMask

Returns

void

Inherited from

SkyRenderer.removeRendererMask

Defined in

src/components/renderer/RenderNode.ts:232

---

selfCloneMaterials

▸ selfCloneMaterials(key): this

Parameters

Name	Type
key	string

Returns

this

Inherited from

SkyRenderer.selfCloneMaterials

Defined in

src/components/renderer/RenderNode.ts:252

---

renderPass

▸ renderPass(view, passType, renderContext): void

Parameters

Name	Type
view	View3D
passType	PassType
renderContext	RenderContext

Returns

void

Inherited from

SkyRenderer.renderPass

Defined in

src/components/renderer/RenderNode.ts:370

---

recordRenderPass2

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

Parameters

Name	Type	Default value
view	View3D	undefined
passType	PassType	undefined
rendererPassState	RendererPassState	undefined
clusterLightingBuffer	ClusterLightingBuffer	undefined
encoder	GPURenderPassEncoder	undefined
useBundle	boolean	false

Returns

void

Inherited from

SkyRenderer.recordRenderPass2

Defined in

src/components/renderer/RenderNode.ts:486

---

preInit

▸ preInit(_rendererType): boolean

Parameters

Name	Type
_rendererType	PassType

Returns

boolean

Inherited from

SkyRenderer.preInit

Defined in

src/components/renderer/RenderNode.ts:519

---

beforeDestroy

▸ beforeDestroy(force?): void

Parameters

Name	Type
force?	boolean

Returns

void

Inherited from

SkyRenderer.beforeDestroy

Defined in

src/components/renderer/RenderNode.ts:609

---

onEnable

▸ onEnable(): void

Returns

void

Inherited from

SkyRenderer.onEnable

Defined in

src/components/renderer/SkyRenderer.ts:41

---

onDisable

▸ onDisable(): void

Returns

void

Inherited from

SkyRenderer.onDisable

Defined in

src/components/renderer/SkyRenderer.ts:54

---

nodeUpdate

▸ nodeUpdate(view, passType, renderPassState, clusterLightingBuffer?): void

Parameters

Name	Type
view	View3D
passType	PassType
renderPassState	RendererPassState
clusterLightingBuffer?	ClusterLightingBuffer

Returns

void

Inherited from

SkyRenderer.nodeUpdate

Defined in

src/components/renderer/SkyRenderer.ts:62

---

renderPass2

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

render pass at passType

Parameters

Name	Type	Default value
view	View3D	undefined
passType	PassType	undefined
rendererPassState	RendererPassState	undefined
clusterLightingBuffer	ClusterLightingBuffer	undefined
encoder	GPURenderPassEncoder	undefined
useBundle	boolean	false

Returns

void

Inherited from

SkyRenderer.renderPass2

Defined in

src/components/renderer/SkyRenderer.ts:66

---

useSkyReflection

▸ useSkyReflection(): void

Returns

void

Inherited from

SkyRenderer.useSkyReflection

Defined in

src/components/renderer/SkyRenderer.ts:109