Class SpriteParticleRenderer

精灵粒子渲染器

Export

Date

2022.4.8

Author

lyx

Hierarchy

ParticleRenderer
- SpriteParticleRenderer

Constructors

constructor

new SpriteParticleRenderer(parameters?): SpriteParticleRenderer
Parameters
- parameters: SpriteParticleRendererParameters = {}
Returns SpriteParticleRenderer

Overrides ParticleRenderer.constructor

Properties

`Protected` _emitters

_emitters: ParticleEmitter[] = []

`Protected` _renderOrder

_renderOrder: RenderOrder = RenderOrder.Default

`Protected` _renderer

_renderer: Object3D<Object3DEventMap> = null

`Protected` _system

_system: ParticleSystem = null

`Protected` _total

_total: number = 2000

bounds

bounds: Box3 = ...

外包范围（本地空间）

Memberof

ParticleRenderer

immutableWorldMatrix

immutableWorldMatrix: boolean = false

粒子渲染器世界矩阵是否不可变

Memberof

ParticleRenderer

inheritRotation

inheritRotation: boolean = false

是否继承父旋转

Memberof

ParticleRenderer

inheritScale

inheritScale: boolean = false

是否继承父缩放

Memberof

ParticleRenderer

invertMatrix

invertMatrix: Matrix4 = ...

粒子渲染器旋转缩放世界矩阵逆矩阵

Memberof

ParticleRenderer

`Readonly` isParticleRenderer

isParticleRenderer: boolean = true

粒子渲染器标识

Memberof

ParticleRenderer

worldInvertMatrix

worldInvertMatrix: Matrix4 = ...

粒子渲染器世界矩阵逆矩阵

Memberof

ParticleRenderer

worldMatrix

worldMatrix: Matrix4 = ...

粒子渲染器世界矩阵

Memberof

ParticleRenderer

`Static` `Protected` _tempPosition

_tempPosition: Vector3 = ...

`Static` `Protected` _tempQuaternion

_tempQuaternion: Quaternion = ...

`Static` `Protected` _tempScale

_tempScale: Vector3 = ...

Accessors

alphaTest

set alphaTest(value): void
设置Alpha测试值
Parameters
- value: number
Returns void

Memberof
SpriteParticleRenderer

billboardMode

set billboardMode(value): void
设置公告板模式
Parameters
- value: BillboardMode
Returns void

Memberof
SpriteParticleRenderer

blendDst

set blendDst(value): void
设置目标混合因子
Parameters
- value: BlendingDstFactor
Returns void

Memberof
SpriteParticleRenderer

blendDstAlpha

set blendDstAlpha(value): void
设置目标透明混合因子
Parameters
- value: BlendingDstFactor
Returns void

Memberof
SpriteParticleRenderer

blendEquation

set blendEquation(value): void
设置混合方程
Parameters
- value: BlendingEquation
Returns void

Memberof
SpriteParticleRenderer

blendEquationAlpha

set blendEquationAlpha(value): void
设置透明混合方程
Parameters
- value: BlendingEquation
Returns void

Memberof
SpriteParticleRenderer

blendSrc

set blendSrc(value): void
设置源混合因子
Parameters
- value: 200 | 201 | 202 | 203 | 204 | 205 | 206 | 207 | 208 | 209 | 211 | 212 | 213 | 214 | 210
Returns void

Memberof
SpriteParticleRenderer

blendSrcAlpha

set blendSrcAlpha(value): void
设置源透明混合因子
Parameters
- value: 200 | 201 | 202 | 203 | 204 | 205 | 206 | 207 | 208 | 209 | 211 | 212 | 213 | 214 | 210
Returns void

Memberof
SpriteParticleRenderer

blending

set blending(value): void
设置混合方式
Parameters
- value: Blending
Returns void

Memberof
SpriteParticleRenderer

map

set map(value): void
设置纹理
Parameters
- value: string
Returns void

Memberof
SpriteParticleRenderer

occluded

set occluded(value): void
设置是否可遮挡
Parameters
- value: boolean
Returns void

Memberof
SpriteParticleRenderer

position

get position(): Vector3
获取粒子渲染器的本地位置

Returns Vector3

Memberof
ParticleRenderer

Inherited from ParticleRenderer.position

quaternion

get quaternion(): Quaternion
获取粒子渲染器的本地旋转四元数

Returns Quaternion

Memberof
ParticleRenderer

Inherited from ParticleRenderer.quaternion

renderOrder

get renderOrder(): RenderOrder
获取渲染顺序

Returns RenderOrder

Memberof
ParticleRenderer

Inherited from ParticleRenderer.renderOrder
set renderOrder(value): void
设置渲染顺序
Parameters
- value: RenderOrder
Returns void

Memberof
ParticleRenderer

Inherited from ParticleRenderer.renderOrder

renderer

get renderer(): Group<Object3DEventMap> | Object3D<Object3DEventMap> | Mesh<BufferGeometry<NormalBufferAttributes>, Material | Material[], Object3DEventMap> | SkinnedMesh<BufferGeometry<NormalBufferAttributes>, Material | Material[], Object3DEventMap> | InstancedMesh<BufferGeometry<NormalBufferAttributes>, Material | Material[], InstancedMeshEventMap>
获取粒子渲染对象

Returns Group<Object3DEventMap> | Object3D<Object3DEventMap> | Mesh<BufferGeometry<NormalBufferAttributes>, Material | Material[], Object3DEventMap> | SkinnedMesh<BufferGeometry<NormalBufferAttributes>, Material | Material[], Object3DEventMap> | InstancedMesh<BufferGeometry<NormalBufferAttributes>, Material | Material[], InstancedMeshEventMap>

Memberof
ParticleRenderer

Inherited from ParticleRenderer.renderer

rotation

get rotation(): Euler
获取粒子渲染器的本地渲染角度（单位：弧度）

Returns Euler

Memberof
ParticleRenderer

Inherited from ParticleRenderer.rotation

scale

get scale(): Vector3
获取粒子渲染器的本地缩放

Returns Vector3

Memberof
ParticleRenderer

Inherited from ParticleRenderer.scale

system

get system(): ParticleSystem
获取所属粒子系统

Returns ParticleSystem

Memberof
ParticleRenderer

Inherited from ParticleRenderer.system
set system(value): void
设置所属粒子系统
Parameters
- value: ParticleSystem
Returns void

Memberof
ParticleRenderer

Inherited from ParticleRenderer.system

total

get total(): number
获取可以渲染的最大粒子总数

Returns number

Memberof
ParticleRenderer

Inherited from ParticleRenderer.total
set total(value): void
设置可以渲染的最大粒子总数
Parameters
- value: number
Returns void

Memberof
ParticleRenderer

Inherited from ParticleRenderer.total

verticalOrigin

set verticalOrigin(value): void
设置垂直方向原点
Parameters
- value: VerticalOrigin
Returns void

Memberof
SpriteParticleRenderer

visible

set visible(value): void
设置是否可见
Parameters
- value: boolean
Returns void

Memberof
ParticleRenderer

Inherited from ParticleRenderer.visible

worldPosition

get worldPosition(): Vector3
获取粒子渲染器世界位置

Returns Vector3

Memberof
ParticleRenderer

Inherited from ParticleRenderer.worldPosition

worldQuaternion

get worldQuaternion(): Quaternion
获取粒子渲染器的世界旋转四元数

Returns Quaternion

Memberof
ParticleRenderer

Inherited from ParticleRenderer.worldQuaternion

worldScale

get worldScale(): Vector3
获取粒子渲染器的世界缩放

Returns Vector3

Memberof
ParticleRenderer

Inherited from ParticleRenderer.worldScale

Methods

`Protected` _attachToSystem

_attachToSystem(): void
Protected
将渲染器关联到粒子系统

Returns void

Memberof
ParticleRenderer

Inherited from ParticleRenderer._attachToSystem

`Protected` _destroyRenderer

_destroyRenderer(): void
Protected
销毁粒子渲染器

Returns void

Memberof
SpriteParticleRenderer

Overrides ParticleRenderer._destroyRenderer

`Protected` _detachFromSystem

_detachFromSystem(): void
Protected
与粒子系统分离渲染器

Returns void

Memberof
ParticleRenderer

Inherited from ParticleRenderer._detachFromSystem

`Protected` _expandMemoryCapacity

_expandMemoryCapacity(): void
Protected
扩增渲染器内存容量

Returns void

Memberof
SpriteParticleRenderer

Overrides ParticleRenderer._expandMemoryCapacity

`Protected` _serialize

_serialize(meta): void
Protected
序列化私有属性
Parameters
- meta: {
  type: string;
  [key: string]: any;
  }
  
  元数据（包含类型），所有的私有属性需要写入元数据中
  - [key: string]: any
  - type: string
Returns void

Memberof
SpriteParticleRenderer

Overrides ParticleRenderer._serialize

`Protected` _setRenderOrder

_setRenderOrder(renderOrder): void
Protected
设置渲染顺序
Parameters
- renderOrder: RenderOrder
Returns void

Memberof
ParticleRenderer

Inherited from ParticleRenderer._setRenderOrder

`Protected` _sortParticles

_sortParticles(particles): void
Protected
排序粒子
Parameters
- particles: Particle[]
  
  粒子数组
Returns void

Memberof
ParticleRenderer

Inherited from ParticleRenderer._sortParticles

`Protected` _sortParticlesByCamera

_sortParticlesByCamera(particles, descending): void
Protected
按照到相机距离排序粒子
Parameters
- particles: Particle[]
  
  粒子数组
- descending: boolean
  
  是否降序
Returns void

Memberof
ParticleRenderer

Inherited from ParticleRenderer._sortParticlesByCamera

`Protected` _updateRenderer

_updateRenderer(particles): void
Protected
更新粒子渲染器
Parameters
- particles: Particle[]
  
  待更新粒子数组
Returns void

Memberof
SpriteParticleRenderer

Overrides ParticleRenderer._updateRenderer

addEmitter

addEmitter(emitter, preEmitAmounts?): void
添加一个粒子发射器
Parameters
- emitter: ParticleEmitter
  
  粒子发射器
- Optional preEmitAmounts: number
  
  预发射粒子数目
Returns void

Memberof
ParticleRenderer

Inherited from ParticleRenderer.addEmitter

destroy

destroy(): void
销毁粒子渲染器

Returns void

Abstract

Memberof
ParticleRenderer

Inherited from ParticleRenderer.destroy

getEmitter

getEmitter(index): ParticleEmitter
通过索引获取粒子发射器
Parameters
- index: number
  
  发射器索引
Returns ParticleEmitter

Memberof
ParticleRenderer

Inherited from ParticleRenderer.getEmitter

getType

getType(): string
获取类型

Returns string

Memberof
SpriteParticleRenderer

Overrides ParticleRenderer.getType

removeAllEmitters

removeAllEmitters(destroy?): void
移除所有粒子发射器
Parameters
- Optional destroy: boolean = true
  
  是否销毁粒子发射器
Returns void

Memberof
ParticleRenderer

Inherited from ParticleRenderer.removeAllEmitters

removeEmitter

removeEmitter(emitter, destroy?): void
移除一个粒子发射器
Parameters
- emitter: ParticleEmitter
  
  粒子发射器
- Optional destroy: boolean = true
  
  是否销毁粒子发射器
Returns void

Memberof
ParticleRenderer

Inherited from ParticleRenderer.removeEmitter

toJSON

toJSON(): {
type: string;
[key: string]: any;
}
属性转JSON

Returns {
type: string;
[key: string]: any;
}
- [key: string]: any
- type: string
Memberof
ParticleRenderer

Inherited from ParticleRenderer.toJSON

update

update(timeSinceLastFrame): void
更新粒子
Parameters
- timeSinceLastFrame: number
  
  距离上一帧更新的时长（单位：毫秒）
Returns void

Memberof
ParticleRenderer

Inherited from ParticleRenderer.update

updateMatrix

updateMatrix(): void
更新粒子渲染器世界矩阵、世界矩阵逆矩阵、旋转缩放世界矩阵逆矩阵

Returns void

Memberof
ParticleRenderer

Inherited from ParticleRenderer.updateMatrix

Class SpriteParticleRenderer

Export

Date

Author

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

parameters: SpriteParticleRendererParameters = {}

Returns SpriteParticleRenderer

Properties

Protected _emitters

Protected _renderOrder

Protected _renderer

Protected _system

Protected _total

bounds

Memberof

immutableWorldMatrix

Memberof

inheritRotation

Memberof

inheritScale

Memberof

invertMatrix

Memberof

Readonly isParticleRenderer

Memberof

worldInvertMatrix

Memberof

worldMatrix

Memberof

Static Protected _tempPosition

Static Protected _tempQuaternion

Static Protected _tempScale

Accessors

alphaTest

Parameters

value: number

Returns void

Memberof

billboardMode

Parameters

value: BillboardMode

Returns void

Memberof

blendDst

Parameters

value: BlendingDstFactor

Returns void

Memberof

blendDstAlpha

Parameters

value: BlendingDstFactor

Returns void

Memberof

blendEquation

Parameters

value: BlendingEquation

Returns void

Memberof

blendEquationAlpha

Parameters

value: BlendingEquation

Returns void

Memberof

blendSrc

Parameters

value: 200 | 201 | 202 | 203 | 204 | 205 | 206 | 207 | 208 | 209 | 211 | 212 | 213 | 214 | 210

Returns void

Memberof

blendSrcAlpha

Parameters

value: 200 | 201 | 202 | 203 | 204 | 205 | 206 | 207 | 208 | 209 | 211 | 212 | 213 | 214 | 210

Returns void

`Protected` _emitters

`Protected` _renderOrder

`Protected` _renderer

`Protected` _system

`Protected` _total

`Readonly` isParticleRenderer

`Static` `Protected` _tempPosition

`Static` `Protected` _tempQuaternion

`Static` `Protected` _tempScale