Skip to content
本页内容

Class: ParticleSystem

网格渲染器组件,是用于把网格渲染出来的组件

Hierarchy

Properties

Accessors

Methods

Constructors

Properties

object3D

object3D: Object3D = null

此组件附加到的Object3D对象。

Inherited from

MeshRenderer.object3D

Defined in

src/engine/components/ComponentBase.ts:14


serializeTag

Optional serializeTag: SerializeTag

Inherited from

MeshRenderer.serializeTag

Defined in

src/engine/components/ComponentBase.ts:30


receiveShadow

receiveShadow: boolean

启用此选项可使网格显示任何投射在网格上的阴影。

Inherited from

MeshRenderer.receiveShadow

Defined in

src/engine/components/rendererComponents/MeshRenderer.ts:14


instanceCount

instanceCount: number

Inherited from

MeshRenderer.instanceCount

Defined in

src/engine/components/rendererComponents/RenderNode.ts:21


lodLevel

lodLevel: number = 0

Inherited from

MeshRenderer.lodLevel

Defined in

src/engine/components/rendererComponents/RenderNode.ts:25


alwaysRender

alwaysRender: boolean = false

Inherited from

MeshRenderer.alwaysRender

Defined in

src/engine/components/rendererComponents/RenderNode.ts:27


_geometry

_geometry: GeometryBase

Inherited from

MeshRenderer._geometry

Defined in

src/engine/components/rendererComponents/RenderNode.ts:29


renderOrder

renderOrder: number = 0

Inherited from

MeshRenderer.renderOrder

Defined in

src/engine/components/rendererComponents/RenderNode.ts:45


instanceID

instanceID: string

Inherited from

MeshRenderer.instanceID

Defined in

src/engine/components/rendererComponents/RenderNode.ts:47


useCustomDraw

useCustomDraw: any

Inherited from

MeshRenderer.useCustomDraw

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

Transform

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

NameType
valueboolean

Returns

void

Inherited from

MeshRenderer.enable

Defined in

src/engine/components/ComponentBase.ts:43


geometry

get geometry(): GeometryBase

网格的几何体,决定网格的形状

Returns

GeometryBase

Inherited from

MeshRenderer.geometry

Defined in

src/engine/components/rendererComponents/MeshRenderer.ts:28

set geometry(value): void

Parameters

NameType
valueGeometryBase

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

NameType
valueMaterialBase

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

NameType
valuenumber

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

NameType
valueMaterialBase[]

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

NameType
valueboolean

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

NameType
valueboolean

Returns

void

Inherited from

MeshRenderer.castGI

Defined in

src/engine/components/rendererComponents/RenderNode.ts:214

Methods

onVisible

onVisible(value): void

Parameters

NameType
valueboolean

Returns

void

Inherited from

MeshRenderer.onVisible

Defined in

src/engine/components/ComponentBase.ts:66


destroy

destroy(): void

移除组件时候调用

Returns

void

Inherited from

MeshRenderer.destroy

Defined in

src/engine/components/ComponentBase.ts:119


onUpdate

onUpdate(call): void

添加更新函数。会在每帧更新时执行。

Parameters

NameTypeDescription
callFunction回调函数

Returns

void

Inherited from

MeshRenderer.onUpdate

Defined in

src/engine/components/ComponentBase.ts:135


onLateUpdate

onLateUpdate(call): void

添加延迟更新函数。

Parameters

NameTypeDescription
callFunction回调函数

Returns

void

Inherited from

MeshRenderer.onLateUpdate

Defined in

src/engine/components/ComponentBase.ts:148


onBeforeUpdate

onBeforeUpdate(call): void

添加帧更新前执行的函数。

Parameters

NameTypeDescription
callFunction回调函数

Returns

void

Inherited from

MeshRenderer.onBeforeUpdate

Defined in

src/engine/components/ComponentBase.ts:161


setMorphInfluence

setMorphInfluence(key, value): void

设置变形动画参数

Parameters

NameType
keystring
valuenumber

Returns

void

Inherited from

MeshRenderer.setMorphInfluence

Defined in

src/engine/components/rendererComponents/MeshRenderer.ts:61


setMorphInfluenceIndex

setMorphInfluenceIndex(index, value): void

Parameters

NameType
indexnumber
valuenumber

Returns

void

Inherited from

MeshRenderer.setMorphInfluenceIndex

Defined in

src/engine/components/rendererComponents/MeshRenderer.ts:70


cloneTo

cloneTo(obj): void

Parameters

NameType
objObject3D

Returns

void

Inherited from

MeshRenderer.cloneTo

Defined in

src/engine/components/rendererComponents/MeshRenderer.ts:101


drawWireFrame

drawWireFrame(): void

Returns

void

Inherited from

MeshRenderer.drawWireFrame

Defined in

src/engine/components/rendererComponents/MeshRenderer.ts:111


unSerialization

unSerialization(componentData, data): void

Parameters

NameType
componentDataSerializeComponentBase
dataUnSerializeData

Returns

void

Inherited from

MeshRenderer.unSerialization

Defined in

src/engine/components/rendererComponents/MeshRenderer.ts:116


addMask

addMask(mask): void

Parameters

NameType
maskRendererMask

Returns

void

Inherited from

MeshRenderer.addMask

Defined in

src/engine/components/rendererComponents/RenderNode.ts:56


removeMask

removeMask(mask): void

Parameters

NameType
maskRendererMask

Returns

void

Inherited from

MeshRenderer.removeMask

Defined in

src/engine/components/rendererComponents/RenderNode.ts:60


hasMask

hasMask(mask): boolean

Parameters

NameType
maskRendererMask

Returns

boolean

Inherited from

MeshRenderer.hasMask

Defined in

src/engine/components/rendererComponents/RenderNode.ts:64


addRendererMask

addRendererMask(tag): void

Parameters

NameType
tagRendererMask

Returns

void

Inherited from

MeshRenderer.addRendererMask

Defined in

src/engine/components/rendererComponents/RenderNode.ts:103


removeRendererMask

removeRendererMask(tag): void

Parameters

NameType
tagRendererMask

Returns

void

Inherited from

MeshRenderer.removeRendererMask

Defined in

src/engine/components/rendererComponents/RenderNode.ts:107


selfCloneMaterials

selfCloneMaterials(key): ParticleSystem

Parameters

NameType
keystring

Returns

ParticleSystem

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

NameTypeDefault value
passTypeRendererTypeundefined
rendererPassStateRendererPassStateundefined
sceneScene3Dundefined
clusterLightingRenderClusterLightingRenderundefined
encoderGPURenderPassEncoderundefined
useBundlebooleanfalse

Returns

void

Inherited from

MeshRenderer.renderPass2

Defined in

src/engine/components/rendererComponents/RenderNode.ts:228


recordRenderPass2

recordRenderPass2(passType, rendererPassState, scene, clusterLightingRender, encoder, useBundle?): void

Parameters

NameTypeDefault value
passTypeRendererTypeundefined
rendererPassStateRendererPassStateundefined
sceneScene3Dundefined
clusterLightingRenderClusterLightingRenderundefined
encoderGPURenderPassEncoderundefined
useBundlebooleanfalse

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

NameType
assetsISerializeAssetsCollect

Returns

SerializeComponentBase

Inherited from

MeshRenderer.serialization

Defined in

src/engine/components/rendererComponents/RenderNode.ts:363


useSimulator

useSimulator<T>(c): ParticleSimulator

Type parameters

NameType
Textends ParticleSimulator<T>

Parameters

NameType
c() => T

Returns

ParticleSimulator

Defined in

src/engine/plugins/particle/ParticleSystem.ts:28


play

play(speed?, reset?): void

Parameters

NameTypeDefault value
speednumber1.0
resetbooleanfalse

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

NameType
commandGPUCommandEncoder

Returns

void

Overrides

MeshRenderer.compute

Defined in

src/engine/plugins/particle/ParticleSystem.ts:58


nodeUpdate

nodeUpdate(passType, renderPassState, scene3D, clusterLightingRender?): void

Parameters

NameType
passTypeRendererType
renderPassStateRendererPassState
scene3DScene3D
clusterLightingRender?ClusterLightingRender

Returns

void

Overrides

MeshRenderer.nodeUpdate

Defined in

src/engine/plugins/particle/ParticleSystem.ts:69

Constructors

constructor

new ParticleSystem()

Overrides

MeshRenderer.constructor

Defined in

src/engine/plugins/particle/ParticleSystem.ts:18