Class: PlumParticle

Defined in: packages/core/sdk/src/particle/Particle.ts:83

把 babylon 粒子系统的配置 按相关性分类

Extended by

• SmokeParticle
• RainParticle
• FireParticle

Constructors

Constructor

new PlumParticle(options): PlumParticle

Defined in: packages/core/sdk/src/particle/Particle.ts:88

Parameters

options

IPlumParticle

Returns

PlumParticle

Properties

noiseTexture?

optional noiseTexture: NoiseProceduralTexture

Defined in: packages/core/sdk/src/particle/Particle.ts:85

---

options

options: IPlumParticle

Defined in: packages/core/sdk/src/particle/Particle.ts:86

---

particleSystem

particleSystem: GPUParticleSystem | ParticleSystem

Defined in: packages/core/sdk/src/particle/Particle.ts:84

Methods

addColorGradients()

addColorGradients(gradients): PlumParticle

Defined in: packages/core/sdk/src/particle/Particle.ts:308

为粒子系统添加颜色渐变

Parameters

gradients

[number, number[] | Color4, (number[] | Color4)?][]

颜色渐变数组，每个元素是一个包含两个元素的数组，第一个元素是渐变位置（0 - 1之间），第二个元素是 Color4 对象或颜色数组（RGBA）

Returns

PlumParticle

---

addColorRemapGradients()

addColorRemapGradients(gradients): PlumParticle

Defined in: packages/core/sdk/src/particle/Particle.ts:357

设置粒子颜色重映射渐变

Parameters

gradients

[number, number, number][]

Returns

PlumParticle

---

addRampGradients()

addRampGradients(gradients): PlumParticle

Defined in: packages/core/sdk/src/particle/Particle.ts:341

设置粒子渐变

Parameters

gradients

[number, number[]][]

Returns

PlumParticle

---

addSizeGradients()

addSizeGradients(gradients): PlumParticle

Defined in: packages/core/sdk/src/particle/Particle.ts:323

为粒子系统添加大小渐变

Parameters

gradients

[number, number, number?][]

Returns

PlumParticle

---

build()

build(): PlumParticle

Defined in: packages/core/sdk/src/particle/Particle.ts:479

组装粒子

Returns

PlumParticle

---

createNoiseTexture()

createNoiseTexture(options): PlumParticle

Defined in: packages/core/sdk/src/particle/Particle.ts:239

创建并配置噪声纹理

Parameters

options

INoiseTextureOptions

Returns

PlumParticle

---

isGpu()

isGpu(): boolean

Defined in: packages/core/sdk/src/particle/Particle.ts:102

Returns

boolean

---

setAngularSpeed()

setAngularSpeed(minAngularSpeed, maxAngularSpeed): PlumParticle

Defined in: packages/core/sdk/src/particle/Particle.ts:408

角速度相关设置

Parameters

minAngularSpeed

number = 0

最小角速度，默认为 0

maxAngularSpeed

number = 0

最大角速度，默认为 0

Returns

PlumParticle

---

setAnimation()

setAnimation(beginAnimationOnStart, beginAnimationFrom, beginAnimationTo, beginAnimationLoop): void

Defined in: packages/core/sdk/src/particle/Particle.ts:468

Parameters

beginAnimationOnStart

boolean = false

beginAnimationFrom

number = 0

beginAnimationTo

number = 60

beginAnimationLoop

boolean = false

Returns

void

---

setBillboardOptions()

setBillboardOptions(billboardMode, isBillboardBased): PlumParticle

Defined in: packages/core/sdk/src/particle/Particle.ts:460

设置广告牌选项

Parameters

billboardMode

number = Constants.PARTICLES_BILLBOARDMODE_ALL

广告牌模式，默认为 1

isBillboardBased

boolean = true

是否基于广告牌，默认为 true

Returns

PlumParticle

---

setBoxEmitter()

setBoxEmitter(options): PlumParticle

Defined in: packages/core/sdk/src/particle/Particle.ts:287

设置正方形发射器

Parameters

options

ISetBoxEmitter

Returns

PlumParticle

---

setColor()

setColor(color1, color2, colorDead): PlumParticle

Defined in: packages/core/sdk/src/particle/Particle.ts:185

颜色相关设置

Parameters

color1

Color4Type = ...

起始颜色，可以是 Color4 对象或数组，默认为 [1, 1, 1, 1]

color2

Color4Type = ...

中间颜色，可以是 Color4 对象或数组，默认为 [1, 1, 1, 1]

colorDead

Color4Type = ...

消亡颜色，可以是 Color4 对象或数组，默认为 [0, 0, 0, 1]

Returns

PlumParticle

---

setConeEmitter()

setConeEmitter(radius, angle, directionRandomizer): PlumParticle

Defined in: packages/core/sdk/src/particle/Particle.ts:274

设置圆锥发射器

Parameters

radius

number = 1

圆锥发射器的半径，默认为 0.1

angle

number = Math.PI

圆锥发射器的角度，默认为 0.6

directionRandomizer

number = 0

圆锥发射器的方向随机化因子，默认为 0

Returns

PlumParticle

---

setEmitPower()

setEmitPower(minEmitPower, maxEmitPower): PlumParticle

Defined in: packages/core/sdk/src/particle/Particle.ts:397

发射功率相关设置

Parameters

minEmitPower

number = 1

最小发射功率，默认为 1

maxEmitPower

number = 1

最大发射功率，默认为 1

Returns

PlumParticle

---

setEmitRate()

setEmitRate(emitRate): PlumParticle

Defined in: packages/core/sdk/src/particle/Particle.ts:375

设置粒子的发射速率

Parameters

emitRate

number = 10

每秒发射的粒子数量，默认为 10。 如果不传递该参数，将使用默认值。

Returns

PlumParticle

---

setGravity()

setGravity(gravity): PlumParticle

Defined in: packages/core/sdk/src/particle/Particle.ts:220

设置重力

Parameters

gravity

Vector3Type = ...

重力，可以是 Vector3 对象或数组，默认为 Vector3.Zero()

Returns

PlumParticle

---

setInitialRotation()

setInitialRotation(minInitialRotation, maxInitialRotation): PlumParticle

Defined in: packages/core/sdk/src/particle/Particle.ts:419

初始旋转相关设置

Parameters

minInitialRotation

number = 0

最小初始旋转角度，默认为 0

maxInitialRotation

number = 0

最大初始旋转角度，默认为 0

Returns

PlumParticle

---

setLifeTime()

setLifeTime(minLifeTime, maxLifeTime): PlumParticle

Defined in: packages/core/sdk/src/particle/Particle.ts:385

生命周期相关设置

Parameters

minLifeTime

number = 1

最小生命周期，默认为 1

maxLifeTime

number = 1

最大生命周期，默认为 1

Returns

PlumParticle

---

setNoiseStrength()

setNoiseStrength(noiseStrength): PlumParticle

Defined in: packages/core/sdk/src/particle/Particle.ts:229

设置噪声强度

Parameters

noiseStrength

Vector3Type = ...

噪声强度，可以是 Vector3 对象或数组，默认为 new Vector3(10, 10, 10)

Returns

PlumParticle

---

setPosition()

setPosition(emitterPosition): PlumParticle

Defined in: packages/core/sdk/src/particle/Particle.ts:263

设置发射器位置

Parameters

emitterPosition

Vector3Type = ...

发射器的位置，类型为 Vector3，默认为 Vector3.Zero()

Returns

PlumParticle

---

setPreventAutoStart()

setPreventAutoStart(preventAutoStart): PlumParticle

Defined in: packages/core/sdk/src/particle/Particle.ts:156

设置粒子系统是否阻止自动启动

Parameters

preventAutoStart

boolean = false

一个布尔值，指示是否阻止粒子系统自动启动，默认为 false

Returns

PlumParticle

---

setPreWarm()

setPreWarm(preWarmCycles, preWarmStepOffset): PlumParticle

Defined in: packages/core/sdk/src/particle/Particle.ts:146

预热相关设置

Parameters

preWarmCycles

number = 0

预热周期数，默认为 0

preWarmStepOffset

number = 0

预热步长偏移量，默认为 0

Returns

PlumParticle

---

setRender()

setRender(blendMode, forceDepthWrite): PlumParticle

Defined in: packages/core/sdk/src/particle/Particle.ts:449

设置混合模式和深度写入选项

Parameters

blendMode

number = BaseParticleSystem.BLENDMODE_ONEONE

混合模式，默认为 BaseParticleSystem.BLENDMODE_ONEONE

forceDepthWrite

boolean = false

是否强制深度写入，默认为 false

Returns

PlumParticle

---

setScaleX()

setScaleX(minScaleX, maxScaleX): PlumParticle

Defined in: packages/core/sdk/src/particle/Particle.ts:123

设置粒子系统的 X 轴缩放范围

Parameters

minScaleX

number = 1

X 轴最小缩放比例，默认为 1

maxScaleX

number = 1

X 轴最大缩放比例，默认为 1

Returns

PlumParticle

---

setScaleY()

setScaleY(minScaleY, maxScaleY): PlumParticle

Defined in: packages/core/sdk/src/particle/Particle.ts:134

设置粒子系统的 Y 轴缩放范围

Parameters

minScaleY

number = 1

Y 轴最小缩放比例，默认为 1

maxScaleY

number = 1

Y 轴最大缩放比例，默认为 1

Returns

PlumParticle

---

setSize()

setSize(minSize, maxSize): PlumParticle

Defined in: packages/core/sdk/src/particle/Particle.ts:112

设置粒子系统的大小范围

Parameters

minSize

number = 1

最小尺寸，默认为 1

maxSize

number = 1

最大尺寸，默认为 1

Returns

PlumParticle

---

setSprite()

setSprite(options): PlumParticle

Defined in: packages/core/sdk/src/particle/Particle.ts:195

序列动画相关设置

Parameters

options

ISetSprite

Returns

PlumParticle

---

setTexture()

setTexture(url, invertY): PlumParticle

Defined in: packages/core/sdk/src/particle/Particle.ts:169

设置粒子纹理

Parameters

url

string

invertY

boolean = false

Returns

PlumParticle

---

setTextureMask()

setTextureMask(value): PlumParticle

Defined in: packages/core/sdk/src/particle/Particle.ts:174

Parameters

value

Color4 = ...

Returns

PlumParticle

---

setUpdateOptions()

setUpdateOptions(options): PlumParticle

Defined in: packages/core/sdk/src/particle/Particle.ts:431

设置更新选项

Parameters

options

IUpdateOptions

Returns

PlumParticle

---

start()

start(delay): PlumParticle

Defined in: packages/core/sdk/src/particle/Particle.ts:486

开始发射粒子

Parameters

delay

number = 0

Returns

PlumParticle