Class: GUIRenderer
GUI Renderer Used to update Geometry and Buffer.
Hierarchy
↳
GUIRenderer
Constructors
Properties
- object3D
- isDestroyed
- receiveShadow
- instanceCount
- lodLevel
- alwaysRender
- instanceID
- drawType
- isRenderOrderChange
- needSortOnCameraZ
- preInit
Accessors
- eventDispatcher
- isStart
- transform
- enable
- geometry
- material
- renderLayer
- rendererMask
- renderOrder
- materials
- castShadow
- castGI
- castReflection
Methods
- start
- stop
- onLateUpdate
- onBeforeUpdate
- onGraphic
- onParentChange
- init
- onUpdate
- onEnable
- onDisable
- cloneTo
- copyComponent
- setMorphInfluence
- setMorphInfluenceIndex
- onCompute
- destroy
- attachSceneOctree
- detachSceneOctree
- addMask
- removeMask
- hasMask
- addRendererMask
- removeRendererMask
- selfCloneMaterials
- renderPass
- renderPass2
- recordRenderPass2
- beforeDestroy
Constructors
constructor
• new GUIRenderer()
Inherited from
Defined in
src/components/renderer/MeshRenderer.ts:24
Properties
object3D
• object3D: Object3D
= null
owner object3D
Inherited from
Defined in
src/components/ComponentBase.ts:17
isDestroyed
• Optional
isDestroyed: boolean
Inherited from
Defined in
src/components/ComponentBase.ts:38
receiveShadow
• receiveShadow: boolean
Enabling this option allows the grid to display any shadows cast on the grid.
Inherited from
Defined in
src/components/renderer/MeshRenderer.ts:21
instanceCount
• instanceCount: number
= 0
Inherited from
Defined in
src/components/renderer/RenderNode.ts:33
lodLevel
• lodLevel: number
= 0
Inherited from
Defined in
src/components/renderer/RenderNode.ts:34
alwaysRender
• alwaysRender: boolean
= false
Inherited from
Defined in
src/components/renderer/RenderNode.ts:35
instanceID
• instanceID: string
Inherited from
Defined in
src/components/renderer/RenderNode.ts:36
drawType
• drawType: number
= 0
Inherited from
Defined in
src/components/renderer/RenderNode.ts:37
isRenderOrderChange
• Optional
isRenderOrderChange: boolean
Inherited from
MeshRenderer.isRenderOrderChange
Defined in
src/components/renderer/RenderNode.ts:52
needSortOnCameraZ
• Optional
needSortOnCameraZ: boolean
Inherited from
MeshRenderer.needSortOnCameraZ
Defined in
src/components/renderer/RenderNode.ts:53
preInit
• preInit: boolean
= false
Inherited from
Defined in
src/components/renderer/RenderNode.ts:56
Accessors
eventDispatcher
• get
eventDispatcher(): CEventDispatcher
Returns
Inherited from
MeshRenderer.eventDispatcher
Defined in
src/components/ComponentBase.ts:23
• set
eventDispatcher(value
): void
Parameters
Name | Type |
---|---|
value | CEventDispatcher |
Returns
void
Inherited from
MeshRenderer.eventDispatcher
Defined in
src/components/ComponentBase.ts:28
isStart
• get
isStart(): boolean
Returns
boolean
Inherited from
MeshRenderer.isStart
Defined in
src/components/ComponentBase.ts:40
transform
• get
transform(): Transform
Return the Transform component attached to the Object3D.
Returns
Inherited from
MeshRenderer.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
MeshRenderer.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
MeshRenderer.enable
Defined in
src/components/ComponentBase.ts:54
geometry
• get
geometry(): GeometryBase
The geometry of the mesh determines its shape
Returns
Overrides
MeshRenderer.geometry
Defined in
src/components/gui/core/GUIRenderer.ts:36
• set
geometry(value
): void
Parameters
Name | Type |
---|---|
value | GeometryBase |
Returns
void
Overrides
MeshRenderer.geometry
Defined in
src/components/gui/core/GUIRenderer.ts:39
material
• get
material(): Material
material
Returns
Inherited from
MeshRenderer.material
Defined in
src/components/renderer/MeshRenderer.ts:82
• set
material(value
): void
Parameters
Name | Type |
---|---|
value | Material |
Returns
void
Inherited from
MeshRenderer.material
Defined in
src/components/renderer/MeshRenderer.ts:87
renderLayer
• get
renderLayer(): RenderLayer
Returns
RenderLayer
Inherited from
MeshRenderer.renderLayer
Defined in
src/components/renderer/RenderNode.ts:103
• set
renderLayer(value
): void
Parameters
Name | Type |
---|---|
value | RenderLayer |
Returns
void
Inherited from
MeshRenderer.renderLayer
Defined in
src/components/renderer/RenderNode.ts:107
rendererMask
• get
rendererMask(): number
Returns
number
Inherited from
MeshRenderer.rendererMask
Defined in
src/components/renderer/RenderNode.ts:141
• set
rendererMask(value
): void
Parameters
Name | Type |
---|---|
value | number |
Returns
void
Inherited from
MeshRenderer.rendererMask
Defined in
src/components/renderer/RenderNode.ts:145
renderOrder
• get
renderOrder(): number
Returns
number
Inherited from
MeshRenderer.renderOrder
Defined in
src/components/renderer/RenderNode.ts:149
• set
renderOrder(value
): void
Parameters
Name | Type |
---|---|
value | number |
Returns
void
Inherited from
MeshRenderer.renderOrder
Defined in
src/components/renderer/RenderNode.ts:153
materials
• get
materials(): Material
[]
Returns
Material
[]
Inherited from
MeshRenderer.materials
Defined in
src/components/renderer/RenderNode.ts:161
• set
materials(value
): void
Parameters
Name | Type |
---|---|
value | Material [] |
Returns
void
Inherited from
MeshRenderer.materials
Defined in
src/components/renderer/RenderNode.ts:166
castShadow
• get
castShadow(): boolean
Returns
boolean
Inherited from
MeshRenderer.castShadow
Defined in
src/components/renderer/RenderNode.ts:315
• set
castShadow(value
): void
Parameters
Name | Type |
---|---|
value | boolean |
Returns
void
Inherited from
MeshRenderer.castShadow
Defined in
src/components/renderer/RenderNode.ts:320
castGI
• get
castGI(): boolean
Returns
boolean
Inherited from
MeshRenderer.castGI
Defined in
src/components/renderer/RenderNode.ts:325
• set
castGI(value
): void
Parameters
Name | Type |
---|---|
value | boolean |
Returns
void
Inherited from
MeshRenderer.castGI
Defined in
src/components/renderer/RenderNode.ts:330
castReflection
• get
castReflection(): boolean
Returns
boolean
Inherited from
MeshRenderer.castReflection
Defined in
src/components/renderer/RenderNode.ts:335
• set
castReflection(value
): void
Parameters
Name | Type |
---|---|
value | boolean |
Returns
void
Inherited from
MeshRenderer.castReflection
Defined in
src/components/renderer/RenderNode.ts:339
Methods
start
▸ start(): void
Returns
void
Inherited from
Defined in
src/components/ComponentBase.ts:113
stop
▸ stop(): void
Returns
void
Inherited from
Defined in
src/components/ComponentBase.ts:114
onLateUpdate
▸ Optional
onLateUpdate(view?
): any
Parameters
Name | Type |
---|---|
view? | View3D |
Returns
any
Inherited from
Defined in
src/components/ComponentBase.ts:118
onBeforeUpdate
▸ Optional
onBeforeUpdate(view?
): any
Parameters
Name | Type |
---|---|
view? | View3D |
Returns
any
Inherited from
Defined in
src/components/ComponentBase.ts:119
onGraphic
▸ Optional
onGraphic(view?
): any
Parameters
Name | Type |
---|---|
view? | View3D |
Returns
any
Inherited from
Defined in
src/components/ComponentBase.ts:121
onParentChange
▸ Optional
onParentChange(lastParent?
, currentParent?
): any
Parameters
Name | Type |
---|---|
lastParent? | Object3D |
currentParent? | Object3D |
Returns
any
Inherited from
Defined in
src/components/ComponentBase.ts:122
init
▸ init(param?
): void
init renderer
Parameters
Name | Type |
---|---|
param? | any |
Returns
void
Overrides
Defined in
src/components/gui/core/GUIRenderer.ts:23
onUpdate
▸ onUpdate(view?
): void
Parameters
Name | Type |
---|---|
view? | View3D |
Returns
void
Overrides
Defined in
src/components/gui/core/GUIRenderer.ts:72
onEnable
▸ onEnable(): void
Returns
void
Inherited from
Defined in
src/components/renderer/MeshRenderer.ts:28
onDisable
▸ onDisable(): void
Returns
void
Inherited from
Defined in
src/components/renderer/MeshRenderer.ts:32
cloneTo
▸ cloneTo(obj
): void
Parameters
Name | Type |
---|---|
obj | Object3D |
Returns
void
Inherited from
Defined in
src/components/renderer/MeshRenderer.ts:36
copyComponent
▸ copyComponent(from
): GUIRenderer
Parameters
Name | Type |
---|---|
from | GUIRenderer |
Returns
Inherited from
Defined in
src/components/renderer/MeshRenderer.ts:41
setMorphInfluence
▸ setMorphInfluence(key
, value
): void
Set deformation animation parameters
Parameters
Name | Type |
---|---|
key | string |
value | number |
Returns
void
Inherited from
MeshRenderer.setMorphInfluence
Defined in
src/components/renderer/MeshRenderer.ts:95
setMorphInfluenceIndex
▸ setMorphInfluenceIndex(index
, value
): void
Parameters
Name | Type |
---|---|
index | number |
value | number |
Returns
void
Inherited from
MeshRenderer.setMorphInfluenceIndex
Defined in
src/components/renderer/MeshRenderer.ts:104
onCompute
▸ onCompute(view
, command
): void
Parameters
Name | Type |
---|---|
view | View3D |
command | GPUCommandEncoder |
Returns
void
Inherited from
Defined in
src/components/renderer/MeshRenderer.ts:113
destroy
▸ destroy(force?
): void
Parameters
Name | Type |
---|---|
force? | boolean |
Returns
void
Inherited from
Defined in
src/components/renderer/MeshRenderer.ts:142
attachSceneOctree
▸ attachSceneOctree(octree
): void
Parameters
Name | Type |
---|---|
octree | Octree |
Returns
void
Inherited from
MeshRenderer.attachSceneOctree
Defined in
src/components/renderer/RenderNode.ts:72
detachSceneOctree
▸ detachSceneOctree(): void
Returns
void
Inherited from
MeshRenderer.detachSceneOctree
Defined in
src/components/renderer/RenderNode.ts:77
addMask
▸ addMask(mask
): void
Parameters
Name | Type |
---|---|
mask | RendererMask |
Returns
void
Inherited from
Defined in
src/components/renderer/RenderNode.ts:129
removeMask
▸ removeMask(mask
): void
Parameters
Name | Type |
---|---|
mask | RendererMask |
Returns
void
Inherited from
Defined in
src/components/renderer/RenderNode.ts:133
hasMask
▸ hasMask(mask
): boolean
Parameters
Name | Type |
---|---|
mask | RendererMask |
Returns
boolean
Inherited from
Defined in
src/components/renderer/RenderNode.ts:137
addRendererMask
▸ addRendererMask(tag
): void
Parameters
Name | Type |
---|---|
tag | RendererMask |
Returns
void
Inherited from
Defined in
src/components/renderer/RenderNode.ts:201
removeRendererMask
▸ removeRendererMask(tag
): void
Parameters
Name | Type |
---|---|
tag | RendererMask |
Returns
void
Inherited from
MeshRenderer.removeRendererMask
Defined in
src/components/renderer/RenderNode.ts:205
selfCloneMaterials
▸ selfCloneMaterials(key
): GUIRenderer
Parameters
Name | Type |
---|---|
key | string |
Returns
Inherited from
MeshRenderer.selfCloneMaterials
Defined in
src/components/renderer/RenderNode.ts:221
renderPass
▸ renderPass(view
, passType
, renderContext
): void
Parameters
Name | Type |
---|---|
view | View3D |
passType | RendererType |
renderContext | RenderContext |
Returns
void
Inherited from
Defined in
src/components/renderer/RenderNode.ts:343
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
Defined in
src/components/renderer/RenderNode.ts:399
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
MeshRenderer.recordRenderPass2
Defined in
src/components/renderer/RenderNode.ts:444
beforeDestroy
▸ beforeDestroy(force?
): void
Parameters
Name | Type |
---|---|
force? | boolean |
Returns
void