Class: GrassRenderer
Defined in: packages/graphic/renderer/GrassRenderer.ts:19
Extends
Constructors
Constructor
new GrassRenderer():
GrassRenderer
Defined in: packages/graphic/renderer/GrassRenderer.ts:22
Returns
GrassRenderer
Overrides
DynamicFaceRenderer.constructor
Properties
object3D
object3D:
Object3D=null
Defined in: src/components/ComponentBase.ts:29
owner object3D
Inherited from
isDestroyed
isDestroyed:
boolean=false
Defined in: src/components/ComponentBase.ts:77
Inherited from
DynamicFaceRenderer.isDestroyed
receiveShadow
receiveShadow:
boolean
Defined in: src/components/renderer/MeshRenderer.ts:23
Enabling this option allows the grid to display any shadows cast on the grid.
Inherited from
DynamicFaceRenderer.receiveShadow
morphData
morphData:
MorphTargetData
Defined in: src/components/renderer/MeshRenderer.ts:24
Inherited from
instanceCount
instanceCount:
number=0
Defined in: src/components/renderer/RenderNode.ts:35
Inherited from
DynamicFaceRenderer.instanceCount
lodLevel
lodLevel:
number=0
Defined in: src/components/renderer/RenderNode.ts:36
Inherited from
alwaysRender
alwaysRender:
boolean=false
Defined in: src/components/renderer/RenderNode.ts:37
Inherited from
DynamicFaceRenderer.alwaysRender
instanceID
instanceID:
string
Defined in: src/components/renderer/RenderNode.ts:38
Inherited from
DynamicFaceRenderer.instanceID
drawType
drawType:
number=0
Defined in: src/components/renderer/RenderNode.ts:39
Inherited from
isRenderOrderChange?
optionalisRenderOrderChange?:boolean
Defined in: src/components/renderer/RenderNode.ts:55
Inherited from
DynamicFaceRenderer.isRenderOrderChange
needSortOnCameraZ?
optionalneedSortOnCameraZ?:boolean
Defined in: src/components/renderer/RenderNode.ts:56
Inherited from
DynamicFaceRenderer.needSortOnCameraZ
shadowCacheMode
shadowCacheMode:
"auto"|"static"|"dynamic"='auto'
Defined in: src/components/renderer/RenderNode.ts:437
Shadow cache classification.
'auto'(default): renderer is drawn to the shadow map every frame as part of the single-pass render — matches historical behaviour.'static': renderer is drawn only to the cached static depth layer, rebuilt lazily when the light moves or the scene explicitly marks the static cache dirty. Use for buildings, terrain, prop meshes that don't move.'dynamic': renderer is drawn every frame on top of the copied-in static layer. Use for characters, physics objects, anything that moves.
Only consulted when engine.setting.shadow.enableStaticCache === true; otherwise all renderers behave as 'auto'.
Inherited from
DynamicFaceRenderer.shadowCacheMode
grassGeometryCompute
grassGeometryCompute:
ComputeShader
Defined in: packages/graphic/renderer/GrassRenderer.ts:20
texture
texture:
BitmapTexture2DArray
Defined in: packages/graphic/renderer/graphic3d/DynamicFaceRenderer.ts:6
Inherited from
transformBuffer
transformBuffer:
StorageGPUBuffer
Defined in: packages/graphic/renderer/graphic3d/DynamicFaceRenderer.ts:7
Inherited from
DynamicFaceRenderer.transformBuffer
nodeStructBuffer
nodeStructBuffer:
StructStorageGPUBuffer<DynamicDrawStruct>
Defined in: packages/graphic/renderer/graphic3d/DynamicFaceRenderer.ts:8
Inherited from
DynamicFaceRenderer.nodeStructBuffer
drawAtomicBuffer
drawAtomicBuffer:
StorageGPUBuffer
Defined in: packages/graphic/renderer/graphic3d/DynamicFaceRenderer.ts:9
Inherited from
DynamicFaceRenderer.drawAtomicBuffer
nodes
nodes:
DynamicDrawStruct[]
Defined in: packages/graphic/renderer/graphic3d/DynamicFaceRenderer.ts:12
Inherited from
Accessors
visibleLayer
Get Signature
get visibleLayer():
number
Defined in: src/components/ComponentBase.ts:46
Composition-layer membership bitmask. The pass / camera / collector filters via
(component.visibleLayer & pass.layerMask & camera.cullingMask) !== 0
Defaults to VisibleLayer.Default (bit 0) so a fresh subclass is visible to passes whose layerMask is VisibleLayer.All (which includes bit 0). Application code can assign project-specific bits (1..31) to organise the scene into composition layers.
Returns
number
Set Signature
set visibleLayer(
value):void
Defined in: src/components/ComponentBase.ts:50
Parameters
value
number
Returns
void
Inherited from
DynamicFaceRenderer.visibleLayer
eventDispatcher
Get Signature
get eventDispatcher():
CEventDispatcher
Defined in: src/components/ComponentBase.ts:63
Returns
CEventDispatcher
Set Signature
set eventDispatcher(
value):void
Defined in: src/components/ComponentBase.ts:68
Parameters
value
CEventDispatcher
Returns
void
Inherited from
DynamicFaceRenderer.eventDispatcher
isStart
Get Signature
get isStart():
boolean
Defined in: src/components/ComponentBase.ts:79
Returns
boolean
Inherited from
transform
Get Signature
get transform():
Transform
Defined in: src/components/ComponentBase.ts:89
Return the Transform component attached to the Object3D. Null before the component is attached — addComponent assigns object3D only after construction — so constructor-time callers can probe safely via this.transform?..
Returns
Transform
Inherited from
enable
Get Signature
get enable():
boolean
Defined in: src/components/ComponentBase.ts:113
Enable/disable components. The enabled components can be updated, while the disabled components cannot be updated.
Returns
boolean
Set Signature
set enable(
value):void
Defined in: src/components/ComponentBase.ts:96
Enable/disable components. The enabled components can be updated, while the disabled components cannot be updated.
Parameters
value
boolean
Returns
void
Inherited from
geometry
Get Signature
get geometry():
GeometryBase
Defined in: src/components/renderer/MeshRenderer.ts:53
The geometry of the mesh determines its shape
Returns
GeometryBase
Set Signature
set geometry(
value):void
Defined in: src/components/renderer/MeshRenderer.ts:57
Parameters
value
GeometryBase
Returns
void
Inherited from
material
Get Signature
get material():
Material
Defined in: src/components/renderer/MeshRenderer.ts:99
material
Returns
Material
Set Signature
set material(
value):void
Defined in: src/components/renderer/MeshRenderer.ts:103
Parameters
value
Material
Returns
void
Inherited from
batchMode
Get Signature
get batchMode():
BatchMode
Defined in: src/components/renderer/RenderNode.ts:118
Returns
BatchMode
Set Signature
set batchMode(
value):void
Defined in: src/components/renderer/RenderNode.ts:122
Parameters
value
BatchMode
Returns
void
Inherited from
rendererMask
Get Signature
get rendererMask():
number
Defined in: src/components/renderer/RenderNode.ts:156
Returns
number
Set Signature
set rendererMask(
value):void
Defined in: src/components/renderer/RenderNode.ts:160
Parameters
value
number
Returns
void
Inherited from
DynamicFaceRenderer.rendererMask
renderOrder
Get Signature
get renderOrder():
number
Defined in: src/components/renderer/RenderNode.ts:164
Returns
number
Set Signature
set renderOrder(
value):void
Defined in: src/components/renderer/RenderNode.ts:168
Parameters
value
number
Returns
void
Inherited from
DynamicFaceRenderer.renderOrder
materials
Get Signature
get materials():
Material[]
Defined in: src/components/renderer/RenderNode.ts:177
Returns
Material[]
Set Signature
set materials(
value):void
Defined in: src/components/renderer/RenderNode.ts:181
Parameters
value
Material[]
Returns
void
Inherited from
castShadow
Get Signature
get castShadow():
boolean
Defined in: src/components/renderer/RenderNode.ts:413
Returns
boolean
Set Signature
set castShadow(
value):void
Defined in: src/components/renderer/RenderNode.ts:417
Parameters
value
boolean
Returns
void
Inherited from
DynamicFaceRenderer.castShadow
castGI
Get Signature
get castGI():
boolean
Defined in: src/components/renderer/RenderNode.ts:440
Returns
boolean
Set Signature
set castGI(
value):void
Defined in: src/components/renderer/RenderNode.ts:444
Parameters
value
boolean
Returns
void
Inherited from
castReflection
Get Signature
get castReflection():
boolean
Defined in: src/components/renderer/RenderNode.ts:448
Returns
boolean
Set Signature
set castReflection(
value):void
Defined in: src/components/renderer/RenderNode.ts:452
Parameters
value
boolean
Returns
void
Inherited from
DynamicFaceRenderer.castReflection
Methods
start()
start():
void
Defined in: src/components/ComponentBase.ts:162
Returns
void
Inherited from
stop()
stop():
void
Defined in: src/components/ComponentBase.ts:163
Returns
void
Inherited from
onLateUpdate()?
optionalonLateUpdate(view?):any
Defined in: src/components/ComponentBase.ts:167
Parameters
view?
View3D
Returns
any
Inherited from
DynamicFaceRenderer.onLateUpdate
onBeforeUpdate()?
optionalonBeforeUpdate(view?):any
Defined in: src/components/ComponentBase.ts:168
Parameters
view?
View3D
Returns
any
Inherited from
DynamicFaceRenderer.onBeforeUpdate
onGraphic()?
optionalonGraphic(view?):any
Defined in: src/components/ComponentBase.ts:170
Parameters
view?
View3D
Returns
any
Inherited from
onParentChange()?
optionalonParentChange(lastParent?,currentParent?):any
Defined in: src/components/ComponentBase.ts:171
Parameters
lastParent?
Object3D
currentParent?
Object3D
Returns
any
Inherited from
DynamicFaceRenderer.onParentChange
onAddChild()?
optionalonAddChild(child):any
Defined in: src/components/ComponentBase.ts:172
Parameters
child
Object3D
Returns
any
Inherited from
DynamicFaceRenderer.onAddChild
onRemoveChild()?
optionalonRemoveChild(child):any
Defined in: src/components/ComponentBase.ts:173
Parameters
child
Object3D
Returns
any
Inherited from
DynamicFaceRenderer.onRemoveChild
onEnable()
onEnable():
void
Defined in: src/components/renderer/MeshRenderer.ts:30
Returns
void
Inherited from
onDisable()
onDisable():
void
Defined in: src/components/renderer/MeshRenderer.ts:34
Returns
void
Inherited from
cloneTo()
cloneTo(
obj):void
Defined in: src/components/renderer/MeshRenderer.ts:38
clone component data to target object3D
Parameters
obj
Object3D
target object3D
Returns
void
Inherited from
copyComponent()
copyComponent(
from):this
Defined in: src/components/renderer/MeshRenderer.ts:43
Parameters
from
this
Returns
this
Inherited from
DynamicFaceRenderer.copyComponent
setMorphInfluence()
setMorphInfluence(
key,value):void
Defined in: src/components/renderer/MeshRenderer.ts:110
Set deformation animation parameters
Parameters
key
string
value
number
Returns
void
Inherited from
DynamicFaceRenderer.setMorphInfluence
setMorphInfluenceIndex()
setMorphInfluenceIndex(
index,value):void
Defined in: src/components/renderer/MeshRenderer.ts:119
Parameters
index
number
value
number
Returns
void
Inherited from
DynamicFaceRenderer.setMorphInfluenceIndex
destroy()
destroy(
force?):void
Defined in: src/components/renderer/MeshRenderer.ts:157
Parameters
force?
boolean
Returns
void
Inherited from
attachSceneOctree()
attachSceneOctree(
octree):void
Defined in: src/components/renderer/RenderNode.ts:87
Parameters
octree
Octree
Returns
void
Inherited from
DynamicFaceRenderer.attachSceneOctree
detachSceneOctree()
detachSceneOctree():
void
Defined in: src/components/renderer/RenderNode.ts:92
Returns
void
Inherited from
DynamicFaceRenderer.detachSceneOctree
addMask()
addMask(
mask):void
Defined in: src/components/renderer/RenderNode.ts:144
Parameters
mask
RendererMask
Returns
void
Inherited from
removeMask()
removeMask(
mask):void
Defined in: src/components/renderer/RenderNode.ts:148
Parameters
mask
RendererMask
Returns
void
Inherited from
DynamicFaceRenderer.removeMask
hasMask()
hasMask(
mask):boolean
Defined in: src/components/renderer/RenderNode.ts:152
Parameters
mask
RendererMask
Returns
boolean
Inherited from
addRendererMask()
addRendererMask(
tag):void
Defined in: src/components/renderer/RenderNode.ts:232
Parameters
tag
RendererMask
Returns
void
Inherited from
DynamicFaceRenderer.addRendererMask
removeRendererMask()
removeRendererMask(
tag):void
Defined in: src/components/renderer/RenderNode.ts:236
Parameters
tag
RendererMask
Returns
void
Inherited from
DynamicFaceRenderer.removeRendererMask
refreshRenderClassification()
refreshRenderClassification():
void
Defined in: src/components/renderer/RenderNode.ts:270
Recompute renderOrder from current pass states and re-bucket this renderer in EntityCollect (opaque vs transparent map).
Called when a material's alphaMode flips at runtime — the pass.renderOrder changes (3000 ↔ 0), but EntityCollect classifies once at addRenderNode time. Without this nudge the renderer stays in its old list and gets drawn through the wrong pipeline (e.g. WBOIT continues drawing a HASH-toggled material).
Materials hop into this via Reference.getReference(material) to find every renderer holding them; sample code can also call it directly after manual state changes.
Returns
void
Inherited from
DynamicFaceRenderer.refreshRenderClassification
selfCloneMaterials()
selfCloneMaterials(
key):this
Defined in: src/components/renderer/RenderNode.ts:295
Parameters
key
string
Returns
this
Inherited from
DynamicFaceRenderer.selfCloneMaterials
renderPass()
renderPass(
view,passType,renderContext):void
Defined in: src/components/renderer/RenderNode.ts:456
Parameters
view
View3D
passType
PassType
renderContext
RenderContext
Returns
void
Inherited from
DynamicFaceRenderer.renderPass
renderPass2()
renderPass2(
view,passType,rendererPassState,clusterLightingBuffer,encoder,useBundle?):void
Defined in: src/components/renderer/RenderNode.ts:528
render pass at passType
Parameters
view
View3D
passType
PassType
rendererPassState
RendererPassState
clusterLightingBuffer
ClusterLightingBuffer
encoder
GPURenderPassEncoder
useBundle?
boolean = false
Returns
void
Inherited from
DynamicFaceRenderer.renderPass2
recordRenderPass2()
recordRenderPass2(
view,passType,rendererPassState,clusterLightingBuffer,encoder,useBundle?):void
Defined in: src/components/renderer/RenderNode.ts:586
Parameters
view
View3D
passType
PassType
rendererPassState
RendererPassState
clusterLightingBuffer
ClusterLightingBuffer
encoder
GPURenderPassEncoder
useBundle?
boolean = false
Returns
void
Inherited from
DynamicFaceRenderer.recordRenderPass2
preInit()
preInit(
_rendererType):boolean
Defined in: src/components/renderer/RenderNode.ts:624
Parameters
_rendererType
PassType
Returns
boolean
Inherited from
beforeDestroy()
beforeDestroy(
force?):void
Defined in: src/components/renderer/RenderNode.ts:741
before release this component, object refrences are not be set null now.
Parameters
force?
boolean
Returns
void
Inherited from
DynamicFaceRenderer.beforeDestroy
init()
init(
param?):void
Defined in: packages/graphic/renderer/GrassRenderer.ts:26
Parameters
param?
any
Returns
void
Overrides
set()
set<
T>(nodeStruct,tex,standAloneMatrix?):void
Defined in: packages/graphic/renderer/graphic3d/DynamicFaceRenderer.ts:66
Type Parameters
T
T extends DynamicDrawStruct
Parameters
nodeStruct
Ctor<T>
tex
BitmapTexture2DArray
standAloneMatrix?
boolean
Returns
void
Inherited from
setNodeStruct()
setNodeStruct(
index,shape):void
Defined in: packages/graphic/renderer/graphic3d/DynamicFaceRenderer.ts:134
Parameters
index
number
shape
Returns
void
Inherited from
DynamicFaceRenderer.setNodeStruct
updateShape()
updateShape():
void
Defined in: packages/graphic/renderer/graphic3d/DynamicFaceRenderer.ts:141
Returns
void
Inherited from
DynamicFaceRenderer.updateShape
setTextureID()
setTextureID(
i,id):void
Defined in: packages/graphic/renderer/graphic3d/DynamicFaceRenderer.ts:150
Parameters
i
number
id
number
Returns
void
Inherited from
DynamicFaceRenderer.setTextureID
setLineTextureID()
setLineTextureID(
i,id):void
Defined in: packages/graphic/renderer/graphic3d/DynamicFaceRenderer.ts:155
Parameters
i
number
id
number
Returns
void
Inherited from
DynamicFaceRenderer.setLineTextureID
setBaseColor()
setBaseColor(
i,color):void
Defined in: packages/graphic/renderer/graphic3d/DynamicFaceRenderer.ts:160
Parameters
i
number
color
Color
Returns
void
Inherited from
DynamicFaceRenderer.setBaseColor
setLineColor()
setLineColor(
index,color):void
Defined in: packages/graphic/renderer/graphic3d/DynamicFaceRenderer.ts:165
Parameters
index
number
color
Color
Returns
void
Inherited from
DynamicFaceRenderer.setLineColor
setEmissiveColor()
setEmissiveColor(
i,color):void
Defined in: packages/graphic/renderer/graphic3d/DynamicFaceRenderer.ts:170
Parameters
i
number
color
Color
Returns
void
Inherited from
DynamicFaceRenderer.setEmissiveColor
setFillRotation()
setFillRotation(
i,radians):void
Defined in: packages/graphic/renderer/graphic3d/DynamicFaceRenderer.ts:175
Parameters
i
number
radians
number
Returns
void
Inherited from
DynamicFaceRenderer.setFillRotation
setUVRect()
setUVRect(
i,v):void
Defined in: packages/graphic/renderer/graphic3d/DynamicFaceRenderer.ts:180
Parameters
i
number
v
Vector4
Returns
void
Inherited from
setUVRect2()
setUVRect2(
i,v):void
Defined in: packages/graphic/renderer/graphic3d/DynamicFaceRenderer.ts:185
Parameters
i
number
v
Vector4
Returns
void
Inherited from
DynamicFaceRenderer.setUVRect2
setUVSpeed()
setUVSpeed(
i,v):void
Defined in: packages/graphic/renderer/graphic3d/DynamicFaceRenderer.ts:196
Parameters
i
number
index
v
Vector4
{x:fill speed u, y: fill speed v, z:line speed u, w: line speed v}
Returns
void
Memberof
DynamicFaceRenderer
Inherited from
DynamicFaceRenderer.setUVSpeed
onUpdate()
onUpdate(
view?):void
Defined in: packages/graphic/renderer/graphic3d/DynamicFaceRenderer.ts:201
Parameters
view?
View3D
Returns
void
Inherited from
onCompute()
onCompute(
view,command):void
Defined in: packages/graphic/renderer/graphic3d/DynamicFaceRenderer.ts:227
Parameters
view
View3D
command
GPUCommandEncoder
Returns
void