Class: ParticleSystem
网格渲染器组件,是用于把网格渲染出来的组件
Hierarchy
↳
ParticleSystem
Properties
- object3D
- serializeTag
- receiveShadow
- instanceCount
- lodLevel
- alwaysRender
- _geometry
- renderOrder
- instanceID
- useCustomDraw
- autoPlay
- particleSimulator
Accessors
Methods
- onVisible
- destroy
- onUpdate
- onLateUpdate
- onBeforeUpdate
- setMorphInfluence
- setMorphInfluenceIndex
- cloneTo
- drawWireFrame
- unSerialization
- addMask
- removeMask
- hasMask
- addRendererMask
- removeRendererMask
- selfCloneMaterials
- renderPass2
- recordRenderPass2
- noticeShaderChange
- serialization
- useSimulator
- play
- stop
- compute
- nodeUpdate
Constructors
Properties
object3D
• object3D: Object3D
= null
此组件附加到的Object3D对象。
Inherited from
Defined in
src/engine/components/ComponentBase.ts:14
serializeTag
• Optional
serializeTag: SerializeTag
Inherited from
Defined in
src/engine/components/ComponentBase.ts:30
receiveShadow
• receiveShadow: boolean
启用此选项可使网格显示任何投射在网格上的阴影。
Inherited from
Defined in
src/engine/components/rendererComponents/MeshRenderer.ts:14
instanceCount
• instanceCount: number
Inherited from
Defined in
src/engine/components/rendererComponents/RenderNode.ts:21
lodLevel
• lodLevel: number
= 0
Inherited from
Defined in
src/engine/components/rendererComponents/RenderNode.ts:25
alwaysRender
• alwaysRender: boolean
= false
Inherited from
Defined in
src/engine/components/rendererComponents/RenderNode.ts:27
_geometry
• _geometry: GeometryBase
Inherited from
Defined in
src/engine/components/rendererComponents/RenderNode.ts:29
renderOrder
• renderOrder: number
= 0
Inherited from
Defined in
src/engine/components/rendererComponents/RenderNode.ts:45
instanceID
• instanceID: string
Inherited from
Defined in
src/engine/components/rendererComponents/RenderNode.ts:47
useCustomDraw
• useCustomDraw: any
Inherited from
Defined in
src/engine/components/rendererComponents/RenderNode.ts:48
autoPlay
• autoPlay: boolean
Defined in
src/engine/plugins/particle/ParticleSystem.ts:15
particleSimulator
• particleSimulator: ParticleSimulator
Defined in
src/engine/plugins/particle/ParticleSystem.ts:16
Accessors
transform
• get
transform(): Transform
附加到此 Object3D对象 的 Transform组件。
Returns
Inherited from
MeshRenderer.transform
Defined in
src/engine/components/ComponentBase.ts:39
enable
• get
enable(): boolean
启用/禁用 组件。启用的组件可更新,禁用的组件不可更新。
Returns
boolean
Inherited from
MeshRenderer.enable
Defined in
src/engine/components/ComponentBase.ts:62
• set
enable(value
): void
Parameters
Name | Type |
---|---|
value | boolean |
Returns
void
Inherited from
MeshRenderer.enable
Defined in
src/engine/components/ComponentBase.ts:43
geometry
• get
geometry(): GeometryBase
网格的几何体,决定网格的形状
Returns
Inherited from
MeshRenderer.geometry
Defined in
src/engine/components/rendererComponents/MeshRenderer.ts:28
• set
geometry(value
): void
Parameters
Name | Type |
---|---|
value | GeometryBase |
Returns
void
Inherited from
MeshRenderer.geometry
Defined in
src/engine/components/rendererComponents/MeshRenderer.ts:32
material
• get
material(): MaterialBase
网格的材质
Returns
MaterialBase
Inherited from
MeshRenderer.material
Defined in
src/engine/components/rendererComponents/MeshRenderer.ts:51
• set
material(value
): void
Parameters
Name | Type |
---|---|
value | MaterialBase |
Returns
void
Inherited from
MeshRenderer.material
Defined in
src/engine/components/rendererComponents/MeshRenderer.ts:54
rendererMask
• get
rendererMask(): number
Returns
number
Inherited from
MeshRenderer.rendererMask
Defined in
src/engine/components/rendererComponents/RenderNode.ts:68
• set
rendererMask(value
): void
Parameters
Name | Type |
---|---|
value | number |
Returns
void
Inherited from
MeshRenderer.rendererMask
Defined in
src/engine/components/rendererComponents/RenderNode.ts:72
materials
• get
materials(): MaterialBase
[]
Returns
MaterialBase
[]
Inherited from
MeshRenderer.materials
Defined in
src/engine/components/rendererComponents/RenderNode.ts:76
• set
materials(value
): void
Parameters
Name | Type |
---|---|
value | MaterialBase [] |
Returns
void
Inherited from
MeshRenderer.materials
Defined in
src/engine/components/rendererComponents/RenderNode.ts:80
castShadow
• get
castShadow(): boolean
Returns
boolean
Inherited from
MeshRenderer.castShadow
Defined in
src/engine/components/rendererComponents/RenderNode.ts:202
• set
castShadow(value
): void
Parameters
Name | Type |
---|---|
value | boolean |
Returns
void
Inherited from
MeshRenderer.castShadow
Defined in
src/engine/components/rendererComponents/RenderNode.ts:206
castGI
• get
castGI(): boolean
Returns
boolean
Inherited from
MeshRenderer.castGI
Defined in
src/engine/components/rendererComponents/RenderNode.ts:210
• set
castGI(value
): void
Parameters
Name | Type |
---|---|
value | boolean |
Returns
void
Inherited from
MeshRenderer.castGI
Defined in
src/engine/components/rendererComponents/RenderNode.ts:214
Methods
onVisible
▸ onVisible(value
): void
Parameters
Name | Type |
---|---|
value | boolean |
Returns
void
Inherited from
Defined in
src/engine/components/ComponentBase.ts:66
destroy
▸ destroy(): void
移除组件时候调用
Returns
void
Inherited from
Defined in
src/engine/components/ComponentBase.ts:119
onUpdate
▸ onUpdate(call
): void
添加更新函数。会在每帧更新时执行。
Parameters
Name | Type | Description |
---|---|---|
call | Function | 回调函数 |
Returns
void
Inherited from
Defined in
src/engine/components/ComponentBase.ts:135
onLateUpdate
▸ onLateUpdate(call
): void
添加延迟更新函数。
Parameters
Name | Type | Description |
---|---|---|
call | Function | 回调函数 |
Returns
void
Inherited from
Defined in
src/engine/components/ComponentBase.ts:148
onBeforeUpdate
▸ onBeforeUpdate(call
): void
添加帧更新前执行的函数。
Parameters
Name | Type | Description |
---|---|---|
call | Function | 回调函数 |
Returns
void
Inherited from
Defined in
src/engine/components/ComponentBase.ts:161
setMorphInfluence
▸ setMorphInfluence(key
, value
): void
设置变形动画参数
Parameters
Name | Type |
---|---|
key | string |
value | number |
Returns
void
Inherited from
MeshRenderer.setMorphInfluence
Defined in
src/engine/components/rendererComponents/MeshRenderer.ts:61
setMorphInfluenceIndex
▸ setMorphInfluenceIndex(index
, value
): void
Parameters
Name | Type |
---|---|
index | number |
value | number |
Returns
void
Inherited from
MeshRenderer.setMorphInfluenceIndex
Defined in
src/engine/components/rendererComponents/MeshRenderer.ts:70
cloneTo
▸ cloneTo(obj
): void
Parameters
Name | Type |
---|---|
obj | Object3D |
Returns
void
Inherited from
Defined in
src/engine/components/rendererComponents/MeshRenderer.ts:101
drawWireFrame
▸ drawWireFrame(): void
Returns
void
Inherited from
Defined in
src/engine/components/rendererComponents/MeshRenderer.ts:111
unSerialization
▸ unSerialization(componentData
, data
): void
Parameters
Name | Type |
---|---|
componentData | SerializeComponentBase |
data | UnSerializeData |
Returns
void
Inherited from
Defined in
src/engine/components/rendererComponents/MeshRenderer.ts:116
addMask
▸ addMask(mask
): void
Parameters
Name | Type |
---|---|
mask | RendererMask |
Returns
void
Inherited from
Defined in
src/engine/components/rendererComponents/RenderNode.ts:56
removeMask
▸ removeMask(mask
): void
Parameters
Name | Type |
---|---|
mask | RendererMask |
Returns
void
Inherited from
Defined in
src/engine/components/rendererComponents/RenderNode.ts:60
hasMask
▸ hasMask(mask
): boolean
Parameters
Name | Type |
---|---|
mask | RendererMask |
Returns
boolean
Inherited from
Defined in
src/engine/components/rendererComponents/RenderNode.ts:64
addRendererMask
▸ addRendererMask(tag
): void
Parameters
Name | Type |
---|---|
tag | RendererMask |
Returns
void
Inherited from
Defined in
src/engine/components/rendererComponents/RenderNode.ts:103
removeRendererMask
▸ removeRendererMask(tag
): void
Parameters
Name | Type |
---|---|
tag | RendererMask |
Returns
void
Inherited from
MeshRenderer.removeRendererMask
Defined in
src/engine/components/rendererComponents/RenderNode.ts:107
selfCloneMaterials
▸ selfCloneMaterials(key
): ParticleSystem
Parameters
Name | Type |
---|---|
key | string |
Returns
Inherited from
MeshRenderer.selfCloneMaterials
Defined in
src/engine/components/rendererComponents/RenderNode.ts:141
renderPass2
▸ renderPass2(passType
, rendererPassState
, scene
, clusterLightingRender
, encoder
, useBundle?
): void
render pass at passType
Parameters
Name | Type | Default value |
---|---|---|
passType | RendererType | undefined |
rendererPassState | RendererPassState | undefined |
scene | Scene3D | undefined |
clusterLightingRender | ClusterLightingRender | undefined |
encoder | GPURenderPassEncoder | undefined |
useBundle | boolean | false |
Returns
void
Inherited from
Defined in
src/engine/components/rendererComponents/RenderNode.ts:228
recordRenderPass2
▸ recordRenderPass2(passType
, rendererPassState
, scene
, clusterLightingRender
, encoder
, useBundle?
): void
Parameters
Name | Type | Default value |
---|---|---|
passType | RendererType | undefined |
rendererPassState | RendererPassState | undefined |
scene | Scene3D | undefined |
clusterLightingRender | ClusterLightingRender | undefined |
encoder | GPURenderPassEncoder | undefined |
useBundle | boolean | false |
Returns
void
Inherited from
MeshRenderer.recordRenderPass2
Defined in
src/engine/components/rendererComponents/RenderNode.ts:259
noticeShaderChange
▸ noticeShaderChange(): void
Returns
void
Inherited from
MeshRenderer.noticeShaderChange
Defined in
src/engine/components/rendererComponents/RenderNode.ts:287
serialization
▸ serialization(assets
): SerializeComponentBase
Parameters
Name | Type |
---|---|
assets | ISerializeAssetsCollect |
Returns
Inherited from
Defined in
src/engine/components/rendererComponents/RenderNode.ts:363
useSimulator
▸ useSimulator<T
>(c
): ParticleSimulator
Type parameters
Name | Type |
---|---|
T | extends ParticleSimulator <T > |
Parameters
Name | Type |
---|---|
c | () => T |
Returns
ParticleSimulator
Defined in
src/engine/plugins/particle/ParticleSystem.ts:28
play
▸ play(speed?
, reset?
): void
Parameters
Name | Type | Default value |
---|---|---|
speed | number | 1.0 |
reset | boolean | false |
Returns
void
Defined in
src/engine/plugins/particle/ParticleSystem.ts:34
stop
▸ stop(): void
Returns
void
Overrides
MeshRenderer.stop
Defined in
src/engine/plugins/particle/ParticleSystem.ts:37
compute
▸ compute(command
): void
Parameters
Name | Type |
---|---|
command | GPUCommandEncoder |
Returns
void
Overrides
Defined in
src/engine/plugins/particle/ParticleSystem.ts:58
nodeUpdate
▸ nodeUpdate(passType
, renderPassState
, scene3D
, clusterLightingRender?
): void
Parameters
Name | Type |
---|---|
passType | RendererType |
renderPassState | RendererPassState |
scene3D | Scene3D |
clusterLightingRender? | ClusterLightingRender |
Returns
void
Overrides
MeshRenderer.nodeUpdate
Defined in
src/engine/plugins/particle/ParticleSystem.ts:69
Constructors
constructor
• new ParticleSystem()