Class: InstanceDrawComponent
Hierarchy
RenderNode
↳
InstanceDrawComponent
Properties
Accessors
Methods
- onUpdate
- onLateUpdate
- onBeforeUpdate
- onCompute
- onGraphic
- onParentChange
- cloneTo
- init
- start
- stop
- nodeUpdate
- renderPass
- addMask
- removeMask
- hasMask
- addRendererMask
- removeRendererMask
- onEnable
- onDisable
- selfCloneMaterials
- renderPass2
- recordRenderPass2
- destroy
Constructors
Properties
object3D
• object3D: Object3D
= null
owner object3D
Inherited from
RenderNode.object3D
Defined in
src/components/ComponentBase.ts:17
instanceCount
• instanceCount: number
= 0
Inherited from
RenderNode.instanceCount
Defined in
src/components/renderer/RenderNode.ts:28
lodLevel
• lodLevel: number
= 0
Inherited from
RenderNode.lodLevel
Defined in
src/components/renderer/RenderNode.ts:29
alwaysRender
• alwaysRender: boolean
= false
Inherited from
RenderNode.alwaysRender
Defined in
src/components/renderer/RenderNode.ts:30
instanceID
• instanceID: string
Inherited from
RenderNode.instanceID
Defined in
src/components/renderer/RenderNode.ts:31
drawType
• drawType: number
= 0
Inherited from
RenderNode.drawType
Defined in
src/components/renderer/RenderNode.ts:32
isRenderOrderChange
• Optional
isRenderOrderChange: boolean
Inherited from
RenderNode.isRenderOrderChange
Defined in
src/components/renderer/RenderNode.ts:46
needSortOnCameraZ
• Optional
needSortOnCameraZ: boolean
Inherited from
RenderNode.needSortOnCameraZ
Defined in
src/components/renderer/RenderNode.ts:47
Accessors
transform
• get
transform(): Transform
Return the Transform component attached to the Object3D.
Returns
Inherited from
RenderNode.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
RenderNode.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
Name | Type |
---|---|
value | boolean |
Returns
void
Inherited from
RenderNode.enable
Defined in
src/components/ComponentBase.ts:45
renderOrder
• get
renderOrder(): number
Returns
number
Inherited from
RenderNode.renderOrder
Defined in
src/components/renderer/RenderNode.ts:54
• set
renderOrder(value
): void
Parameters
Name | Type |
---|---|
value | number |
Returns
void
Inherited from
RenderNode.renderOrder
Defined in
src/components/renderer/RenderNode.ts:58
geometry
• get
geometry(): GeometryBase
Returns
Inherited from
RenderNode.geometry
Defined in
src/components/renderer/RenderNode.ts:65
• set
geometry(value
): void
Parameters
Name | Type |
---|---|
value | GeometryBase |
Returns
void
Inherited from
RenderNode.geometry
Defined in
src/components/renderer/RenderNode.ts:69
rendererMask
• get
rendererMask(): number
Returns
number
Inherited from
RenderNode.rendererMask
Defined in
src/components/renderer/RenderNode.ts:91
• set
rendererMask(value
): void
Parameters
Name | Type |
---|---|
value | number |
Returns
void
Inherited from
RenderNode.rendererMask
Defined in
src/components/renderer/RenderNode.ts:95
materials
• get
materials(): MaterialBase
[]
Returns
MaterialBase
[]
Inherited from
RenderNode.materials
Defined in
src/components/renderer/RenderNode.ts:99
• set
materials(value
): void
Parameters
Name | Type |
---|---|
value | MaterialBase [] |
Returns
void
Inherited from
RenderNode.materials
Defined in
src/components/renderer/RenderNode.ts:103
castShadow
• get
castShadow(): boolean
Returns
boolean
Inherited from
RenderNode.castShadow
Defined in
src/components/renderer/RenderNode.ts:248
• set
castShadow(value
): void
Parameters
Name | Type |
---|---|
value | boolean |
Returns
void
Inherited from
RenderNode.castShadow
Defined in
src/components/renderer/RenderNode.ts:252
castGI
• get
castGI(): boolean
Returns
boolean
Inherited from
RenderNode.castGI
Defined in
src/components/renderer/RenderNode.ts:256
• set
castGI(value
): void
Parameters
Name | Type |
---|---|
value | boolean |
Returns
void
Inherited from
RenderNode.castGI
Defined in
src/components/renderer/RenderNode.ts:260
castReflection
• get
castReflection(): boolean
Returns
boolean
Inherited from
RenderNode.castReflection
Defined in
src/components/renderer/RenderNode.ts:264
• set
castReflection(value
): void
Parameters
Name | Type |
---|---|
value | boolean |
Returns
void
Inherited from
RenderNode.castReflection
Defined in
src/components/renderer/RenderNode.ts:268
Methods
onUpdate
▸ Optional
onUpdate(view?
): any
Parameters
Name | Type |
---|---|
view? | View3D |
Returns
any
Inherited from
RenderNode.onUpdate
Defined in
src/components/ComponentBase.ts:111
onLateUpdate
▸ Optional
onLateUpdate(view?
): any
Parameters
Name | Type |
---|---|
view? | View3D |
Returns
any
Inherited from
RenderNode.onLateUpdate
Defined in
src/components/ComponentBase.ts:112
onBeforeUpdate
▸ Optional
onBeforeUpdate(view?
): any
Parameters
Name | Type |
---|---|
view? | View3D |
Returns
any
Inherited from
RenderNode.onBeforeUpdate
Defined in
src/components/ComponentBase.ts:113
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:114
onGraphic
▸ Optional
onGraphic(view?
): any
Parameters
Name | Type |
---|---|
view? | View3D |
Returns
any
Inherited from
RenderNode.onGraphic
Defined in
src/components/ComponentBase.ts:115
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:116
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:123
init
▸ init(param?
): void
Parameters
Name | Type |
---|---|
param? | any |
Returns
void
Overrides
RenderNode.init
Defined in
src/components/renderer/InstanceDrawComponent.ts:17
start
▸ start(): void
Returns
void
Overrides
RenderNode.start
Defined in
src/components/renderer/InstanceDrawComponent.ts:21
stop
▸ stop(): void
Returns
void
Overrides
RenderNode.stop
Defined in
src/components/renderer/InstanceDrawComponent.ts:51
nodeUpdate
▸ nodeUpdate(view
, passType
, renderPassState
, clusterLightingBuffer?
): void
Parameters
Name | Type |
---|---|
view | View3D |
passType | RendererType |
renderPassState | RendererPassState |
clusterLightingBuffer? | ClusterLightingBuffer |
Returns
void
Overrides
RenderNode.nodeUpdate
Defined in
src/components/renderer/InstanceDrawComponent.ts:55
renderPass
▸ renderPass(view
, passType
, renderEncoder
): void
Parameters
Name | Type |
---|---|
view | View3D |
passType | RendererType |
renderEncoder | RenderContext |
Returns
void
Overrides
RenderNode.renderPass
Defined in
src/components/renderer/InstanceDrawComponent.ts:78
addMask
▸ addMask(mask
): void
Parameters
Name | Type |
---|---|
mask | RendererMask |
Returns
void
Inherited from
RenderNode.addMask
Defined in
src/components/renderer/RenderNode.ts:79
removeMask
▸ removeMask(mask
): void
Parameters
Name | Type |
---|---|
mask | RendererMask |
Returns
void
Inherited from
RenderNode.removeMask
Defined in
src/components/renderer/RenderNode.ts:83
hasMask
▸ hasMask(mask
): boolean
Parameters
Name | Type |
---|---|
mask | RendererMask |
Returns
boolean
Inherited from
RenderNode.hasMask
Defined in
src/components/renderer/RenderNode.ts:87
addRendererMask
▸ addRendererMask(tag
): void
Parameters
Name | Type |
---|---|
tag | RendererMask |
Returns
void
Inherited from
RenderNode.addRendererMask
Defined in
src/components/renderer/RenderNode.ts:135
removeRendererMask
▸ removeRendererMask(tag
): void
Parameters
Name | Type |
---|---|
tag | RendererMask |
Returns
void
Inherited from
RenderNode.removeRendererMask
Defined in
src/components/renderer/RenderNode.ts:139
onEnable
▸ onEnable(): void
Returns
void
Inherited from
RenderNode.onEnable
Defined in
src/components/renderer/RenderNode.ts:143
onDisable
▸ onDisable(): void
Returns
void
Inherited from
RenderNode.onDisable
Defined in
src/components/renderer/RenderNode.ts:151
selfCloneMaterials
▸ selfCloneMaterials(key
): InstanceDrawComponent
Parameters
Name | Type |
---|---|
key | string |
Returns
Inherited from
RenderNode.selfCloneMaterials
Defined in
src/components/renderer/RenderNode.ts:155
renderPass2
▸ renderPass2(view
, passType
, rendererPassState
, clusterLightingBuffer
, encoder
, useBundle?
): void
render pass at passType
Parameters
Name | Type | Default value |
---|---|---|
view | View3D | undefined |
passType | RendererType | 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:323
recordRenderPass2
▸ recordRenderPass2(view
, passType
, rendererPassState
, clusterLightingBuffer
, encoder
, useBundle?
): void
Parameters
Name | Type | Default value |
---|---|---|
view | View3D | undefined |
passType | RendererType | 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:365
destroy
▸ destroy(force?
): void
Parameters
Name | Type |
---|---|
force? | boolean |
Returns
void
Inherited from
RenderNode.destroy
Defined in
src/components/renderer/RenderNode.ts:474
Constructors
constructor
• new InstanceDrawComponent()
Inherited from
RenderNode.constructor