Skip to content
本页内容

Class: AtmosphericComponent

Atmospheric Sky Box Component

Hierarchy

Accessors

Methods

Properties

Constructors

Accessors

sunX

get sunX(): number

Returns

number

Defined in

src/components/AtmosphericComponent.ts:15

set sunX(value): void

Parameters

NameType
valuenumber

Returns

void

Defined in

src/components/AtmosphericComponent.ts:19


sunY

get sunY(): number

Returns

number

Defined in

src/components/AtmosphericComponent.ts:26

set sunY(value): void

Parameters

NameType
valuenumber

Returns

void

Defined in

src/components/AtmosphericComponent.ts:30


eyePos

get eyePos(): number

Returns

number

Defined in

src/components/AtmosphericComponent.ts:37

set eyePos(value): void

Parameters

NameType
valuenumber

Returns

void

Defined in

src/components/AtmosphericComponent.ts:41


sunRadius

get sunRadius(): number

Returns

number

Defined in

src/components/AtmosphericComponent.ts:48

set sunRadius(value): void

Parameters

NameType
valuenumber

Returns

void

Defined in

src/components/AtmosphericComponent.ts:52


sunRadiance

get sunRadiance(): number

Returns

number

Defined in

src/components/AtmosphericComponent.ts:59

set sunRadiance(value): void

Parameters

NameType
valuenumber

Returns

void

Defined in

src/components/AtmosphericComponent.ts:63


sunBrightness

get sunBrightness(): number

Returns

number

Defined in

src/components/AtmosphericComponent.ts:70

set sunBrightness(value): void

Parameters

NameType
valuenumber

Returns

void

Defined in

src/components/AtmosphericComponent.ts:74


displaySun

get displaySun(): boolean

Returns

boolean

Defined in

src/components/AtmosphericComponent.ts:81

set displaySun(value): void

Parameters

NameType
valueboolean

Returns

void

Defined in

src/components/AtmosphericComponent.ts:85


transform

get transform(): Transform

Return the Transform component attached to the Object3D.

Returns

Transform

Inherited from

SkyRenderer.transform

Defined in

src/components/ComponentBase.ts:38


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:59

set enable(value): void

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

Parameters

NameType
valueboolean

Returns

void

Inherited from

SkyRenderer.enable

Defined in

src/components/ComponentBase.ts:45


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:39

set geometry(value): void

Parameters

NameType
valueGeometryBase

Returns

void

Inherited from

SkyRenderer.geometry

Defined in

src/components/renderer/MeshRenderer.ts:43


material

get material(): MaterialBase

material

Returns

MaterialBase

Inherited from

SkyRenderer.material

Defined in

src/components/renderer/MeshRenderer.ts:69

set material(value): void

Parameters

NameType
valueMaterialBase

Returns

void

Inherited from

SkyRenderer.material

Defined in

src/components/renderer/MeshRenderer.ts:73


renderOrder

get renderOrder(): number

Returns

number

Inherited from

SkyRenderer.renderOrder

Defined in

src/components/renderer/RenderNode.ts:54

set renderOrder(value): void

Parameters

NameType
valuenumber

Returns

void

Inherited from

SkyRenderer.renderOrder

Defined in

src/components/renderer/RenderNode.ts:58


rendererMask

get rendererMask(): number

Returns

number

Inherited from

SkyRenderer.rendererMask

Defined in

src/components/renderer/RenderNode.ts:91

set rendererMask(value): void

Parameters

NameType
valuenumber

Returns

void

Inherited from

SkyRenderer.rendererMask

Defined in

src/components/renderer/RenderNode.ts:95


materials

get materials(): MaterialBase[]

Returns

MaterialBase[]

Inherited from

SkyRenderer.materials

Defined in

src/components/renderer/RenderNode.ts:99

set materials(value): void

Parameters

NameType
valueMaterialBase[]

Returns

void

Inherited from

SkyRenderer.materials

Defined in

src/components/renderer/RenderNode.ts:103


castShadow

get castShadow(): boolean

Returns

boolean

Inherited from

SkyRenderer.castShadow

Defined in

src/components/renderer/RenderNode.ts:248

set castShadow(value): void

Parameters

NameType
valueboolean

Returns

void

Inherited from

SkyRenderer.castShadow

Defined in

src/components/renderer/RenderNode.ts:252


castGI

get castGI(): boolean

Returns

boolean

Inherited from

SkyRenderer.castGI

Defined in

src/components/renderer/RenderNode.ts:256

set castGI(value): void

Parameters

NameType
valueboolean

Returns

void

Inherited from

SkyRenderer.castGI

Defined in

src/components/renderer/RenderNode.ts:260


castReflection

get castReflection(): boolean

Returns

boolean

Inherited from

SkyRenderer.castReflection

Defined in

src/components/renderer/RenderNode.ts:264

set castReflection(value): void

Parameters

NameType
valueboolean

Returns

void

Inherited from

SkyRenderer.castReflection

Defined in

src/components/renderer/RenderNode.ts:268


map

get map(): Texture

get environment texture

Returns

Texture

Inherited from

SkyRenderer.map

Defined in

src/components/renderer/SkyRenderer.ts:82

set map(texture): void

set environment texture

Parameters

NameType
textureTexture

Returns

void

Inherited from

SkyRenderer.map

Defined in

src/components/renderer/SkyRenderer.ts:71


exposure

get exposure(): number

Returns

number

Inherited from

SkyRenderer.exposure

Defined in

src/components/renderer/SkyRenderer.ts:86

set exposure(value): void

Parameters

NameType
valuenumber

Returns

void

Inherited from

SkyRenderer.exposure

Defined in

src/components/renderer/SkyRenderer.ts:90


roughness

get roughness(): number

Returns

number

Inherited from

SkyRenderer.roughness

Defined in

src/components/renderer/SkyRenderer.ts:95

set roughness(value): void

Parameters

NameType
valuenumber

Returns

void

Inherited from

SkyRenderer.roughness

Defined in

src/components/renderer/SkyRenderer.ts:99

Methods

init

init(): void

Returns

void

Overrides

SkyRenderer.init

Defined in

src/components/AtmosphericComponent.ts:101


start

start(): void

Returns

void

Overrides

SkyRenderer.start

Defined in

src/components/AtmosphericComponent.ts:106


onUpdate

onUpdate(view?): void

Parameters

NameType
view?View3D

Returns

void

Overrides

SkyRenderer.onUpdate

Defined in

src/components/AtmosphericComponent.ts:113


stop

stop(): void

Returns

void

Inherited from

SkyRenderer.stop

Defined in

src/components/ComponentBase.ts:108


onLateUpdate

Optional onLateUpdate(view?): any

Parameters

NameType
view?View3D

Returns

any

Inherited from

SkyRenderer.onLateUpdate

Defined in

src/components/ComponentBase.ts:112


onBeforeUpdate

Optional onBeforeUpdate(view?): any

Parameters

NameType
view?View3D

Returns

any

Inherited from

SkyRenderer.onBeforeUpdate

Defined in

src/components/ComponentBase.ts:113


onGraphic

Optional onGraphic(view?): any

Parameters

NameType
view?View3D

Returns

any

Inherited from

SkyRenderer.onGraphic

Defined in

src/components/ComponentBase.ts:115


onParentChange

Optional onParentChange(lastParent?, currentParent?): any

Parameters

NameType
lastParent?Object3D
currentParent?Object3D

Returns

any

Inherited from

SkyRenderer.onParentChange

Defined in

src/components/ComponentBase.ts:116


setMorphInfluence

setMorphInfluence(key, value): void

Set deformation animation parameters

Parameters

NameType
keystring
valuenumber

Returns

void

Inherited from

SkyRenderer.setMorphInfluence

Defined in

src/components/renderer/MeshRenderer.ts:80


setMorphInfluenceIndex

setMorphInfluenceIndex(index, value): void

Parameters

NameType
indexnumber
valuenumber

Returns

void

Inherited from

SkyRenderer.setMorphInfluenceIndex

Defined in

src/components/renderer/MeshRenderer.ts:89


onCompute

onCompute(view, command): void

Parameters

NameType
viewView3D
commandGPUCommandEncoder

Returns

void

Inherited from

SkyRenderer.onCompute

Defined in

src/components/renderer/MeshRenderer.ts:98


destroy

destroy(force?): void

Parameters

NameType
force?boolean

Returns

void

Inherited from

SkyRenderer.destroy

Defined in

src/components/renderer/MeshRenderer.ts:128


cloneTo

cloneTo(obj): void

Parameters

NameType
objObject3D

Returns

void

Inherited from

SkyRenderer.cloneTo

Defined in

src/components/renderer/MeshRenderer.ts:132


addMask

addMask(mask): void

Parameters

NameType
maskRendererMask

Returns

void

Inherited from

SkyRenderer.addMask

Defined in

src/components/renderer/RenderNode.ts:79


removeMask

removeMask(mask): void

Parameters

NameType
maskRendererMask

Returns

void

Inherited from

SkyRenderer.removeMask

Defined in

src/components/renderer/RenderNode.ts:83


hasMask

hasMask(mask): boolean

Parameters

NameType
maskRendererMask

Returns

boolean

Inherited from

SkyRenderer.hasMask

Defined in

src/components/renderer/RenderNode.ts:87


addRendererMask

addRendererMask(tag): void

Parameters

NameType
tagRendererMask

Returns

void

Inherited from

SkyRenderer.addRendererMask

Defined in

src/components/renderer/RenderNode.ts:135


removeRendererMask

removeRendererMask(tag): void

Parameters

NameType
tagRendererMask

Returns

void

Inherited from

SkyRenderer.removeRendererMask

Defined in

src/components/renderer/RenderNode.ts:139


selfCloneMaterials

selfCloneMaterials(key): AtmosphericComponent

Parameters

NameType
keystring

Returns

AtmosphericComponent

Inherited from

SkyRenderer.selfCloneMaterials

Defined in

src/components/renderer/RenderNode.ts:155


renderPass

renderPass(view, passType, renderContext): void

Parameters

NameType
viewView3D
passTypeRendererType
renderContextRenderContext

Returns

void

Inherited from

SkyRenderer.renderPass

Defined in

src/components/renderer/RenderNode.ts:272


recordRenderPass2

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

Parameters

NameTypeDefault value
viewView3Dundefined
passTypeRendererTypeundefined
rendererPassStateRendererPassStateundefined
clusterLightingBufferClusterLightingBufferundefined
encoderGPURenderPassEncoderundefined
useBundlebooleanfalse

Returns

void

Inherited from

SkyRenderer.recordRenderPass2

Defined in

src/components/renderer/RenderNode.ts:365


onEnable

onEnable(): void

Returns

void

Inherited from

SkyRenderer.onEnable

Defined in

src/components/renderer/SkyRenderer.ts:42


onDisable

onDisable(): void

Returns

void

Inherited from

SkyRenderer.onDisable

Defined in

src/components/renderer/SkyRenderer.ts:55


renderPass2

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

render pass at passType

Parameters

NameTypeDefault value
viewView3Dundefined
passTypeRendererTypeundefined
rendererPassStateRendererPassStateundefined
clusterLightingBufferClusterLightingBufferundefined
encoderGPURenderPassEncoderundefined
useBundlebooleanfalse

Returns

void

Inherited from

SkyRenderer.renderPass2

Defined in

src/components/renderer/SkyRenderer.ts:62

Properties

object3D

object3D: Object3D = null

owner object3D

Inherited from

SkyRenderer.object3D

Defined in

src/components/ComponentBase.ts:17


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:21


instanceCount

instanceCount: number = 0

Inherited from

SkyRenderer.instanceCount

Defined in

src/components/renderer/RenderNode.ts:28


lodLevel

lodLevel: number = 0

Inherited from

SkyRenderer.lodLevel

Defined in

src/components/renderer/RenderNode.ts:29


alwaysRender

alwaysRender: boolean = false

Inherited from

SkyRenderer.alwaysRender

Defined in

src/components/renderer/RenderNode.ts:30


instanceID

instanceID: string

Inherited from

SkyRenderer.instanceID

Defined in

src/components/renderer/RenderNode.ts:31


drawType

drawType: number = 0

Inherited from

SkyRenderer.drawType

Defined in

src/components/renderer/RenderNode.ts:32


isRenderOrderChange

Optional isRenderOrderChange: boolean

Inherited from

SkyRenderer.isRenderOrderChange

Defined in

src/components/renderer/RenderNode.ts:46


needSortOnCameraZ

Optional needSortOnCameraZ: boolean

Inherited from

SkyRenderer.needSortOnCameraZ

Defined in

src/components/renderer/RenderNode.ts:47


skyMaterial

skyMaterial: SkyMaterial

The material used in the Sky Box.

Inherited from

SkyRenderer.skyMaterial

Defined in

src/components/renderer/SkyRenderer.ts:25

Constructors

constructor

new AtmosphericComponent()

Inherited from

SkyRenderer.constructor

Defined in

src/components/renderer/SkyRenderer.ts:27