# Class Particle

#### Hierarchy

- Points<THREE.BufferGeometry, THREE.ShaderMaterial>
  - Particle

- Defined in lib/vfx/particle/particle.ts:112

##### Index

### Constructors

constructor

### Properties

accelerationBase
accelerationSpread
angleAccelerationBase
angleAccelerationSpread
angleBase
angleSpread
angleVelocityBase
angleVelocitySpread
colorBase
colorSpread
colorTween
needsRender
opacityBase
opacitySpread
opacityTween
particleDeathAge
particlesPerSecond
paused
positionBase
positionCubeSpread
positionSphereSpread
positionStyle
sizeBase
sizeSpread
sizeTween
velocityCubeBase
velocityCubeSpread
velocitySphereBase
velocitySphereSpread
velocityStyle

### Accessors

blending
texture

### Methods

dispose
pause
play
setTime

## Constructors

### constructor

- new Particle(args: Partial<ParticleArgs>): Particle

  #### Parameters

  - args: Partial<ParticleArgs>

  #### Returns Particle

  Overrides THREE.Points<THREE.BufferGeometry, THREE.ShaderMaterial>.constructor

  - Defined in lib/vfx/particle/particle.ts:214

## Properties

### accelerationBase

accelerationBase: Vector3

粒子加速度

- Defined in lib/vfx/particle/particle.ts:157

### accelerationSpread

accelerationSpread: Vector3

粒子加速度扩散值

- Defined in lib/vfx/particle/particle.ts:159

### angleAccelerationBase

angleAccelerationBase: number

旋转角度加速度值

- Defined in lib/vfx/particle/particle.ts:170

### angleAccelerationSpread

angleAccelerationSpread: number

旋转角度加速度值扩散值

- Defined in lib/vfx/particle/particle.ts:172

### angleBase

angleBase: number

旋转角度初始值

- Defined in lib/vfx/particle/particle.ts:162

### angleSpread

angleSpread: number

旋转角度初始值的扩散值

- Defined in lib/vfx/particle/particle.ts:164

### angleVelocityBase

angleVelocityBase: number

旋转角度速度值

- Defined in lib/vfx/particle/particle.ts:166

### angleVelocitySpread

angleVelocitySpread: number

旋转角度速度值的扩散值

- Defined in lib/vfx/particle/particle.ts:168

### colorBase

colorBase: Vector3

颜色（hsl）

#### Description

http://en.wikipedia.org/wiki/HSL_and_HSV `{ x: h, y: s, z: l }`

- Defined in lib/vfx/particle/particle.ts:187

### colorSpread

colorSpread: Vector3

颜色（hsl）的扩散值

#### Description

http://en.wikipedia.org/wiki/HSL_and_HSV `{ x: h, y: s, z: l }`

- Defined in lib/vfx/particle/particle.ts:193

### colorTween

colorTween: ParticleTweenKeyframe<Vector3> | null

颜色（hsl）随时间分布的增益

#### Description

http://en.wikipedia.org/wiki/HSL_and_HSV `{ x: h, y: s, z: l }`

- Defined in lib/vfx/particle/particle.ts:200

### needsRender

needsRender: boolean

- Defined in lib/vfx/particle/particle.ts:114

### opacityBase

opacityBase: number

透明度

- Defined in lib/vfx/particle/particle.ts:203

### opacitySpread

opacitySpread: number

透明度的扩散值

- Defined in lib/vfx/particle/particle.ts:205

### opacityTween

opacityTween: ParticleTweenKeyframe<number> | null

透明度随时间分布的增益

- Defined in lib/vfx/particle/particle.ts:207

### particleDeathAge

particleDeathAge: number

粒子存活时长

- Defined in lib/vfx/particle/particle.ts:212

### particlesPerSecond

particlesPerSecond: number

一秒产生多少粒子

- Defined in lib/vfx/particle/particle.ts:210

### paused

paused: boolean

是否暂停

- Defined in lib/vfx/particle/particle.ts:117

### positionBase

positionBase: Vector3

粒子的初始位置坐标

- Defined in lib/vfx/particle/particle.ts:124

### positionCubeSpread

positionCubeSpread: Vector3

粒子坐标的抖动`CUBE`计算形式下的扩散值

- Defined in lib/vfx/particle/particle.ts:135

### positionSphereSpread

positionSphereSpread: number

粒子坐标的抖动`SPHERE`计算形式下的扩散值

- Defined in lib/vfx/particle/particle.ts:137

### positionStyle

positionStyle: ParticleType

粒子坐标的抖动计算形式

#### Description

粒子坐标的抖动计算形式，分 `CUBE` 和 `SPHERE` 形式。 `CUBE` 形式通过一个 三维向量 的扩散值 positionCubeSpread，乘上一个 [0, 1] 的随机三维向量 计算。 `SPHERE` 形式通过一个 数字 的扩散值 positionSphereSpread，乘上一个随机单位向量 计算。

- Defined in lib/vfx/particle/particle.ts:133

### sizeBase

sizeBase: number

粒子大小

- Defined in lib/vfx/particle/particle.ts:175

### sizeSpread

sizeSpread: number

粒子大小的扩散值

- Defined in lib/vfx/particle/particle.ts:177

### sizeTween

sizeTween: ParticleTweenKeyframe<number> | null

粒子大小随时间分布的增益

- Defined in lib/vfx/particle/particle.ts:179

### velocityCubeBase

velocityCubeBase: Vector3

粒子速度的`CUBE`计算形式下的速度值

- Defined in lib/vfx/particle/particle.ts:148

### velocityCubeSpread

velocityCubeSpread: Vector3

粒子速度的`CUBE`计算形式下的扩散值

- Defined in lib/vfx/particle/particle.ts:150

### velocitySphereBase

velocitySphereBase: number

粒子速度的`SPHERE`计算形式下的速度值

- Defined in lib/vfx/particle/particle.ts:152

### velocitySphereSpread

velocitySphereSpread: number

粒子速度的`SPHERE`计算形式下的扩散值

- Defined in lib/vfx/particle/particle.ts:154

### velocityStyle

velocityStyle: ParticleType

粒子速度的抖动计算形式

#### Description

粒子速度的抖动计算形式，分 `CUBE` 和 `SPHERE` 形式。 `CUBE` 形式通过一个 三维向量 的速度值 velocityCubeBase 加上 三维向量 的扩散值 velocityCubeSpread 乘上一个 [0, 1] 的随机三维向量 计算。 `SPHERE` 形式通过一个 数字 的速度值 velocitySphereBase 加上 数字 的扩散值 velocitySphereSpread 乘上 粒子坐标与粒子的初始位置坐标方向的单位向量 计算。

- Defined in lib/vfx/particle/particle.ts:146

## Accessors

### blending

- get blending(): Blending

  材质混合方式

  #### Returns Blending

  - Defined in lib/vfx/particle/particle.ts:293
- set blending(value: Blending): void

  #### Parameters

  - value: Blending

  #### Returns void

  - Defined in lib/vfx/particle/particle.ts:296

### texture

- get texture(): Texture | null

  贴图素材

  #### Returns Texture | null

  - Defined in lib/vfx/particle/particle.ts:273
- set texture(value: Texture | null): void

  #### Parameters

  - value: Texture | null

  #### Returns void

  - Defined in lib/vfx/particle/particle.ts:277

## Methods

### dispose

- dispose(): void

  析构

  #### Returns void

  - Defined in lib/vfx/particle/particle.ts:475

### pause

- pause(): void

  暂停

  #### Returns void

  - Defined in lib/vfx/particle/particle.ts:354

### play

- play(): void

  开始

  #### Returns void

  - Defined in lib/vfx/particle/particle.ts:363

### setTime

- setTime(time: number): void

  通过 Five 默认调用的 setTime 方法

  #### Parameters

  - time: number

    毫秒

  #### Returns void

  - Defined in lib/vfx/particle/particle.ts:375