Class: InstanceDrawComponent
Hierarchy
RenderNode
↳
InstanceDrawComponent
Constructors
Properties
- object3D
- isDestroyed
- instanceCount
- lodLevel
- alwaysRender
- instanceID
- drawType
- isRenderOrderChange
- needSortOnCameraZ
- preInit
Accessors
- eventDispatcher
- isStart
- transform
- enable
- renderLayer
- geometry
- rendererMask
- renderOrder
- materials
- castShadow
- castGI
- castReflection
Methods
- onUpdate
- onLateUpdate
- onBeforeUpdate
- onCompute
- onGraphic
- onParentChange
- cloneTo
- init
- start
- stop
- nodeUpdate
- renderPass
- renderItem
- attachSceneOctree
- detachSceneOctree
- copyComponent
- addMask
- removeMask
- hasMask
- addRendererMask
- removeRendererMask
- onEnable
- onDisable
- selfCloneMaterials
- renderPass2
- recordRenderPass2
- beforeDestroy
- destroy
Constructors
constructor
• new InstanceDrawComponent()
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
instanceCount
• instanceCount: number
= 0
Inherited from
RenderNode.instanceCount
Defined in
src/components/renderer/RenderNode.ts:34
lodLevel
• lodLevel: number
= 0
Inherited from
RenderNode.lodLevel
Defined in
src/components/renderer/RenderNode.ts:35
alwaysRender
• alwaysRender: boolean
= false
Inherited from
RenderNode.alwaysRender
Defined in
src/components/renderer/RenderNode.ts:36
instanceID
• instanceID: string
Inherited from
RenderNode.instanceID
Defined in
src/components/renderer/RenderNode.ts:37
drawType
• drawType: number
= 0
Inherited from
RenderNode.drawType
Defined in
src/components/renderer/RenderNode.ts:38
isRenderOrderChange
• Optional
isRenderOrderChange: boolean
Inherited from
RenderNode.isRenderOrderChange
Defined in
src/components/renderer/RenderNode.ts:53
needSortOnCameraZ
• Optional
needSortOnCameraZ: boolean
Inherited from
RenderNode.needSortOnCameraZ
Defined in
src/components/renderer/RenderNode.ts:54
preInit
• preInit: boolean
= false
Inherited from
RenderNode.preInit
Defined in
src/components/renderer/RenderNode.ts:57
Accessors
eventDispatcher
• get
eventDispatcher(): CEventDispatcher
Returns
Inherited from
RenderNode.eventDispatcher
Defined in
src/components/ComponentBase.ts:23
• set
eventDispatcher(value
): void
Parameters
Name | Type |
---|---|
value | CEventDispatcher |
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
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
Name | Type |
---|---|
value | boolean |
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:107
• set
renderLayer(value
): void
Parameters
Name | Type |
---|---|
value | RenderLayer |
Returns
void
Inherited from
RenderNode.renderLayer
Defined in
src/components/renderer/RenderNode.ts:111
geometry
• get
geometry(): GeometryBase
Returns
Inherited from
RenderNode.geometry
Defined in
src/components/renderer/RenderNode.ts:119
• set
geometry(value
): void
Parameters
Name | Type |
---|---|
value | GeometryBase |
Returns
void
Inherited from
RenderNode.geometry
Defined in
src/components/renderer/RenderNode.ts:123
rendererMask
• get
rendererMask(): number
Returns
number
Inherited from
RenderNode.rendererMask
Defined in
src/components/renderer/RenderNode.ts:145
• set
rendererMask(value
): void
Parameters
Name | Type |
---|---|
value | number |
Returns
void
Inherited from
RenderNode.rendererMask
Defined in
src/components/renderer/RenderNode.ts:149
renderOrder
• get
renderOrder(): number
Returns
number
Inherited from
RenderNode.renderOrder
Defined in
src/components/renderer/RenderNode.ts:153
• set
renderOrder(value
): void
Parameters
Name | Type |
---|---|
value | number |
Returns
void
Inherited from
RenderNode.renderOrder
Defined in
src/components/renderer/RenderNode.ts:157
materials
• get
materials(): Material
[]
Returns
Material
[]
Inherited from
RenderNode.materials
Defined in
src/components/renderer/RenderNode.ts:165
• set
materials(value
): void
Parameters
Name | Type |
---|---|
value | Material [] |
Returns
void
Inherited from
RenderNode.materials
Defined in
src/components/renderer/RenderNode.ts:170
castShadow
• get
castShadow(): boolean
Returns
boolean
Inherited from
RenderNode.castShadow
Defined in
src/components/renderer/RenderNode.ts:337
• set
castShadow(value
): void
Parameters
Name | Type |
---|---|
value | boolean |
Returns
void
Inherited from
RenderNode.castShadow
Defined in
src/components/renderer/RenderNode.ts:342
castGI
• get
castGI(): boolean
Returns
boolean
Inherited from
RenderNode.castGI
Defined in
src/components/renderer/RenderNode.ts:347
• set
castGI(value
): void
Parameters
Name | Type |
---|---|
value | boolean |
Returns
void
Inherited from
RenderNode.castGI
Defined in
src/components/renderer/RenderNode.ts:352
castReflection
• get
castReflection(): boolean
Returns
boolean
Inherited from
RenderNode.castReflection
Defined in
src/components/renderer/RenderNode.ts:357
• set
castReflection(value
): void
Parameters
Name | Type |
---|---|
value | boolean |
Returns
void
Inherited from
RenderNode.castReflection
Defined in
src/components/renderer/RenderNode.ts:361
Methods
onUpdate
▸ Optional
onUpdate(view?
): any
Parameters
Name | Type |
---|---|
view? | View3D |
Returns
any
Inherited from
RenderNode.onUpdate
Defined in
src/components/ComponentBase.ts:117
onLateUpdate
▸ Optional
onLateUpdate(view?
): any
Parameters
Name | Type |
---|---|
view? | View3D |
Returns
any
Inherited from
RenderNode.onLateUpdate
Defined in
src/components/ComponentBase.ts:118
onBeforeUpdate
▸ Optional
onBeforeUpdate(view?
): any
Parameters
Name | Type |
---|---|
view? | View3D |
Returns
any
Inherited from
RenderNode.onBeforeUpdate
Defined in
src/components/ComponentBase.ts:119
onCompute
▸ Optional
onCompute(view?
, command?
): any
Parameters
Name | Type |
---|---|
view? | View3D |
command? | GPUCommandEncoder |
Returns
any
Inherited from
RenderNode.onCompute
Defined in
src/components/ComponentBase.ts:120
onGraphic
▸ Optional
onGraphic(view?
): any
Parameters
Name | Type |
---|---|
view? | View3D |
Returns
any
Inherited from
RenderNode.onGraphic
Defined in
src/components/ComponentBase.ts:121
onParentChange
▸ Optional
onParentChange(lastParent?
, currentParent?
): any
Parameters
Name | Type |
---|---|
lastParent? | Object3D |
currentParent? | Object3D |
Returns
any
Inherited from
RenderNode.onParentChange
Defined in
src/components/ComponentBase.ts:122
cloneTo
▸ cloneTo(obj
): void
clone component data to target object3D
Parameters
Name | Type | Description |
---|---|---|
obj | Object3D | target object3D |
Returns
void
Inherited from
RenderNode.cloneTo
Defined in
src/components/ComponentBase.ts:129
init
▸ init(param?
): void
Parameters
Name | Type |
---|---|
param? | any |
Returns
void
Overrides
RenderNode.init
Defined in
src/components/renderer/InstanceDrawComponent.ts:18
start
▸ start(): void
Returns
void
Overrides
RenderNode.start
Defined in
src/components/renderer/InstanceDrawComponent.ts:24
stop
▸ stop(): void
Returns
void
Overrides
RenderNode.stop
Defined in
src/components/renderer/InstanceDrawComponent.ts:62
nodeUpdate
▸ nodeUpdate(view
, passType
, renderPassState
, clusterLightingBuffer?
): void
Parameters
Name | Type |
---|---|
view | View3D |
passType | PassType |
renderPassState | RendererPassState |
clusterLightingBuffer? | ClusterLightingBuffer |
Returns
void
Overrides
RenderNode.nodeUpdate
Defined in
src/components/renderer/InstanceDrawComponent.ts:66
renderPass
▸ renderPass(view
, passType
, renderContext
): void
Parameters
Name | Type |
---|---|
view | View3D |
passType | PassType |
renderContext | RenderContext |
Returns
void
Overrides
RenderNode.renderPass
Defined in
src/components/renderer/InstanceDrawComponent.ts:87
renderItem
▸ renderItem(view
, passType
, renderNode
, renderContext
): void
Parameters
Name | Type |
---|---|
view | View3D |
passType | PassType |
renderNode | RenderNode |
renderContext | RenderContext |
Returns
void
Defined in
src/components/renderer/InstanceDrawComponent.ts:95
attachSceneOctree
▸ attachSceneOctree(octree
): void
Parameters
Name | Type |
---|---|
octree | Octree |
Returns
void
Inherited from
RenderNode.attachSceneOctree
Defined in
src/components/renderer/RenderNode.ts:76
detachSceneOctree
▸ detachSceneOctree(): void
Returns
void
Inherited from
RenderNode.detachSceneOctree
Defined in
src/components/renderer/RenderNode.ts:81
copyComponent
▸ copyComponent(from
): InstanceDrawComponent
Parameters
Name | Type |
---|---|
from | InstanceDrawComponent |
Returns
Inherited from
RenderNode.copyComponent
Defined in
src/components/renderer/RenderNode.ts:93
addMask
▸ addMask(mask
): void
Parameters
Name | Type |
---|---|
mask | RendererMask |
Returns
void
Inherited from
RenderNode.addMask
Defined in
src/components/renderer/RenderNode.ts:133
removeMask
▸ removeMask(mask
): void
Parameters
Name | Type |
---|---|
mask | RendererMask |
Returns
void
Inherited from
RenderNode.removeMask
Defined in
src/components/renderer/RenderNode.ts:137
hasMask
▸ hasMask(mask
): boolean
Parameters
Name | Type |
---|---|
mask | RendererMask |
Returns
boolean
Inherited from
RenderNode.hasMask
Defined in
src/components/renderer/RenderNode.ts:141
addRendererMask
▸ addRendererMask(tag
): void
Parameters
Name | Type |
---|---|
tag | RendererMask |
Returns
void
Inherited from
RenderNode.addRendererMask
Defined in
src/components/renderer/RenderNode.ts:221
removeRendererMask
▸ removeRendererMask(tag
): void
Parameters
Name | Type |
---|---|
tag | RendererMask |
Returns
void
Inherited from
RenderNode.removeRendererMask
Defined in
src/components/renderer/RenderNode.ts:225
onEnable
▸ onEnable(): void
Returns
void
Inherited from
RenderNode.onEnable
Defined in
src/components/renderer/RenderNode.ts:229
onDisable
▸ onDisable(): void
Returns
void
Inherited from
RenderNode.onDisable
Defined in
src/components/renderer/RenderNode.ts:239
selfCloneMaterials
▸ selfCloneMaterials(key
): InstanceDrawComponent
Parameters
Name | Type |
---|---|
key | string |
Returns
Inherited from
RenderNode.selfCloneMaterials
Defined in
src/components/renderer/RenderNode.ts:243
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
RenderNode.renderPass2
Defined in
src/components/renderer/RenderNode.ts:419
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
RenderNode.recordRenderPass2
Defined in
src/components/renderer/RenderNode.ts:465
beforeDestroy
▸ beforeDestroy(force?
): void
Parameters
Name | Type |
---|---|
force? | boolean |
Returns
void
Inherited from
RenderNode.beforeDestroy
Defined in
src/components/renderer/RenderNode.ts:574
destroy
▸ destroy(force?
): void
Parameters
Name | Type |
---|---|
force? | boolean |
Returns
void
Inherited from
RenderNode.destroy