Skip to content

Class: Reflection

Sky Box Renderer Component

Hierarchy

Constructors

Properties

Accessors

Methods

Constructors

constructor

new Reflection(): Reflection

Returns

Reflection

Inherited from

RenderNode.constructor

Properties

object3D

object3D: Object3D = null

owner object3D

Inherited from

RenderNode.object3D

Defined in

src/components/ComponentBase.ts:17


isDestroyed

Optional isDestroyed: boolean

Inherited from

RenderNode.isDestroyed

Defined in

src/components/ComponentBase.ts:38


gid

gid: number = 0

Defined in

src/components/renderer/Reflection.ts:19


needUpdate

needUpdate: boolean = true

Defined in

src/components/renderer/Reflection.ts:20


autoUpdate

autoUpdate: boolean = false

Defined in

src/components/renderer/Reflection.ts:21


radius

radius: number = 500

Defined in

src/components/renderer/Reflection.ts:22


instanceCount

instanceCount: number = 0

Inherited from

RenderNode.instanceCount

Defined in

src/components/renderer/RenderNode.ts:35


lodLevel

lodLevel: number = 0

Inherited from

RenderNode.lodLevel

Defined in

src/components/renderer/RenderNode.ts:36


alwaysRender

alwaysRender: boolean = false

Inherited from

RenderNode.alwaysRender

Defined in

src/components/renderer/RenderNode.ts:37


instanceID

instanceID: string

Inherited from

RenderNode.instanceID

Defined in

src/components/renderer/RenderNode.ts:38


drawType

drawType: number = 0

Inherited from

RenderNode.drawType

Defined in

src/components/renderer/RenderNode.ts:39


isRenderOrderChange

Optional isRenderOrderChange: boolean

Inherited from

RenderNode.isRenderOrderChange

Defined in

src/components/renderer/RenderNode.ts:55


needSortOnCameraZ

Optional needSortOnCameraZ: boolean

Inherited from

RenderNode.needSortOnCameraZ

Defined in

src/components/renderer/RenderNode.ts:56


isRecievePostEffectUI

Optional isRecievePostEffectUI: boolean

Inherited from

RenderNode.isRecievePostEffectUI

Defined in

src/components/renderer/RenderNode.ts:57

Accessors

eventDispatcher

get eventDispatcher(): CEventDispatcher

Returns

CEventDispatcher

Inherited from

RenderNode.eventDispatcher

Defined in

src/components/ComponentBase.ts:23

set eventDispatcher(value): void

Parameters

NameType
valueCEventDispatcher

Returns

void

Inherited from

RenderNode.eventDispatcher

Defined in

src/components/ComponentBase.ts:28


isStart

get isStart(): boolean

Returns

boolean

Inherited from

RenderNode.isStart

Defined in

src/components/ComponentBase.ts:40


transform

get transform(): Transform

Return the Transform component attached to the Object3D.

Returns

Transform

Inherited from

RenderNode.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

RenderNode.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

NameType
valueboolean

Returns

void

Inherited from

RenderNode.enable

Defined in

src/components/ComponentBase.ts:54


renderLayer

get renderLayer(): RenderLayer

Returns

RenderLayer

Inherited from

RenderNode.renderLayer

Defined in

src/components/renderer/RenderNode.ts:110

set renderLayer(value): void

Parameters

NameType
valueRenderLayer

Returns

void

Inherited from

RenderNode.renderLayer

Defined in

src/components/renderer/RenderNode.ts:114


geometry

get geometry(): GeometryBase

Returns

GeometryBase

Inherited from

RenderNode.geometry

Defined in

src/components/renderer/RenderNode.ts:122

set geometry(value): void

Parameters

NameType
valueGeometryBase

Returns

void

Inherited from

RenderNode.geometry

Defined in

src/components/renderer/RenderNode.ts:126


rendererMask

get rendererMask(): number

Returns

number

Inherited from

RenderNode.rendererMask

Defined in

src/components/renderer/RenderNode.ts:152

set rendererMask(value): void

Parameters

NameType
valuenumber

Returns

void

Inherited from

RenderNode.rendererMask

Defined in

src/components/renderer/RenderNode.ts:156


renderOrder

get renderOrder(): number

Returns

number

Inherited from

RenderNode.renderOrder

Defined in

src/components/renderer/RenderNode.ts:160

set renderOrder(value): void

Parameters

NameType
valuenumber

Returns

void

Inherited from

RenderNode.renderOrder

Defined in

src/components/renderer/RenderNode.ts:164


materials

get materials(): Material[]

Returns

Material[]

Inherited from

RenderNode.materials

Defined in

src/components/renderer/RenderNode.ts:173

set materials(value): void

Parameters

NameType
valueMaterial[]

Returns

void

Inherited from

RenderNode.materials

Defined in

src/components/renderer/RenderNode.ts:177


castShadow

get castShadow(): boolean

Returns

boolean

Inherited from

RenderNode.castShadow

Defined in

src/components/renderer/RenderNode.ts:345

set castShadow(value): void

Parameters

NameType
valueboolean

Returns

void

Inherited from

RenderNode.castShadow

Defined in

src/components/renderer/RenderNode.ts:349


castGI

get castGI(): boolean

Returns

boolean

Inherited from

RenderNode.castGI

Defined in

src/components/renderer/RenderNode.ts:354

set castGI(value): void

Parameters

NameType
valueboolean

Returns

void

Inherited from

RenderNode.castGI

Defined in

src/components/renderer/RenderNode.ts:358


castReflection

get castReflection(): boolean

Returns

boolean

Inherited from

RenderNode.castReflection

Defined in

src/components/renderer/RenderNode.ts:362

set castReflection(value): void

Parameters

NameType
valueboolean

Returns

void

Inherited from

RenderNode.castReflection

Defined in

src/components/renderer/RenderNode.ts:366

Methods

start

start(): void

Returns

void

Inherited from

RenderNode.start

Defined in

src/components/ComponentBase.ts:113


stop

stop(): void

Returns

void

Inherited from

RenderNode.stop

Defined in

src/components/ComponentBase.ts:114


onUpdate

onUpdate(view?): any

Parameters

NameType
view?View3D

Returns

any

Inherited from

RenderNode.onUpdate

Defined in

src/components/ComponentBase.ts:117


onLateUpdate

onLateUpdate(view?): any

Parameters

NameType
view?View3D

Returns

any

Inherited from

RenderNode.onLateUpdate

Defined in

src/components/ComponentBase.ts:118


onBeforeUpdate

onBeforeUpdate(view?): any

Parameters

NameType
view?View3D

Returns

any

Inherited from

RenderNode.onBeforeUpdate

Defined in

src/components/ComponentBase.ts:119


onCompute

onCompute(view?, command?): any

Parameters

NameType
view?View3D
command?GPUCommandEncoder

Returns

any

Inherited from

RenderNode.onCompute

Defined in

src/components/ComponentBase.ts:120


onGraphic

onGraphic(view?): any

Parameters

NameType
view?View3D

Returns

any

Inherited from

RenderNode.onGraphic

Defined in

src/components/ComponentBase.ts:121


onParentChange

onParentChange(lastParent?, currentParent?): any

Parameters

NameType
lastParent?Object3D
currentParent?Object3D

Returns

any

Inherited from

RenderNode.onParentChange

Defined in

src/components/ComponentBase.ts:122


onAddChild

onAddChild(child): any

Parameters

NameType
childObject3D

Returns

any

Inherited from

RenderNode.onAddChild

Defined in

src/components/ComponentBase.ts:123


onRemoveChild

onRemoveChild(child): any

Parameters

NameType
childObject3D

Returns

any

Inherited from

RenderNode.onRemoveChild

Defined in

src/components/ComponentBase.ts:124


cloneTo

cloneTo(obj): void

clone component data to target object3D

Parameters

NameTypeDescription
objObject3Dtarget object3D

Returns

void

Inherited from

RenderNode.cloneTo

Defined in

src/components/ComponentBase.ts:131


init

init(): void

Returns

void

Overrides

RenderNode.init

Defined in

src/components/renderer/Reflection.ts:23


onEnable

onEnable(): void

Returns

void

Overrides

RenderNode.onEnable

Defined in

src/components/renderer/Reflection.ts:34


onDisable

onDisable(): void

Returns

void

Overrides

RenderNode.onDisable

Defined in

src/components/renderer/Reflection.ts:38


renderPass2

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

Parameters

NameTypeDefault value
viewView3Dundefined
passTypePassTypeundefined
rendererPassStateRendererPassStateundefined
clusterLightingBufferClusterLightingBufferundefined
encoderGPURenderPassEncoderundefined
useBundlebooleanfalse

Returns

void

Overrides

RenderNode.renderPass2

Defined in

src/components/renderer/Reflection.ts:42


attachSceneOctree

attachSceneOctree(octree): void

Parameters

NameType
octreeOctree

Returns

void

Inherited from

RenderNode.attachSceneOctree

Defined in

src/components/renderer/RenderNode.ts:78


detachSceneOctree

detachSceneOctree(): void

Returns

void

Inherited from

RenderNode.detachSceneOctree

Defined in

src/components/renderer/RenderNode.ts:83


copyComponent

copyComponent(from): this

Parameters

NameType
fromthis

Returns

this

Inherited from

RenderNode.copyComponent

Defined in

src/components/renderer/RenderNode.ts:95


addMask

addMask(mask): void

Parameters

NameType
maskRendererMask

Returns

void

Inherited from

RenderNode.addMask

Defined in

src/components/renderer/RenderNode.ts:140


removeMask

removeMask(mask): void

Parameters

NameType
maskRendererMask

Returns

void

Inherited from

RenderNode.removeMask

Defined in

src/components/renderer/RenderNode.ts:144


hasMask

hasMask(mask): boolean

Parameters

NameType
maskRendererMask

Returns

boolean

Inherited from

RenderNode.hasMask

Defined in

src/components/renderer/RenderNode.ts:148


addRendererMask

addRendererMask(tag): void

Parameters

NameType
tagRendererMask

Returns

void

Inherited from

RenderNode.addRendererMask

Defined in

src/components/renderer/RenderNode.ts:228


removeRendererMask

removeRendererMask(tag): void

Parameters

NameType
tagRendererMask

Returns

void

Inherited from

RenderNode.removeRendererMask

Defined in

src/components/renderer/RenderNode.ts:232


selfCloneMaterials

selfCloneMaterials(key): this

Parameters

NameType
keystring

Returns

this

Inherited from

RenderNode.selfCloneMaterials

Defined in

src/components/renderer/RenderNode.ts:252


renderPass

renderPass(view, passType, renderContext): void

Parameters

NameType
viewView3D
passTypePassType
renderContextRenderContext

Returns

void

Inherited from

RenderNode.renderPass

Defined in

src/components/renderer/RenderNode.ts:370


recordRenderPass2

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

Parameters

NameTypeDefault value
viewView3Dundefined
passTypePassTypeundefined
rendererPassStateRendererPassStateundefined
clusterLightingBufferClusterLightingBufferundefined
encoderGPURenderPassEncoderundefined
useBundlebooleanfalse

Returns

void

Inherited from

RenderNode.recordRenderPass2

Defined in

src/components/renderer/RenderNode.ts:486


preInit

preInit(_rendererType): boolean

Parameters

NameType
_rendererTypePassType

Returns

boolean

Inherited from

RenderNode.preInit

Defined in

src/components/renderer/RenderNode.ts:519


nodeUpdate

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

Parameters

NameType
viewView3D
passTypePassType
renderPassStateRendererPassState
clusterLightingBuffer?ClusterLightingBuffer

Returns

void

Inherited from

RenderNode.nodeUpdate

Defined in

src/components/renderer/RenderNode.ts:523


beforeDestroy

beforeDestroy(force?): void

Parameters

NameType
force?boolean

Returns

void

Inherited from

RenderNode.beforeDestroy

Defined in

src/components/renderer/RenderNode.ts:609


destroy

destroy(force?): void

Parameters

NameType
force?boolean

Returns

void

Inherited from

RenderNode.destroy

Defined in

src/components/renderer/RenderNode.ts:625

Released under the MIT License