xr-frame / Exports / Particle

# Class: Particle

# Hierarchy

• BasicParticle

  ↳ Particle

# Table of contents

# Constructors

• constructor

# Events

• onAdd
• onRelease
• onRemove
• onTick
• onUpdate

# Properties

• priority
• schema
• subEmitters
• EVENTS

# Accessors

• billboardMode
• data
• el
• emitterPosition
• id
• material
• particleEmitter
• scene
• spriteChangeSpeed
• useBillboard
• useRampGradients
• useRandomSpriteCellIndex
• useSpriteCellLoop
• useSpriteSheet
• version

# Methods

• addAlphaGradient
• addColorGradient
• addColorRemapGradient
• addDragGradient
• addLimitSpeedGradient
• addRampGradient
• addSizeGradient
• addSpeedScaleGradient
• clone
• createBoxEmitter
• createPointEmitter
• createSphereEmitter
• createSubEmitter
• getData
• initParticle
• resetParticle
• setData
• setDataOne
• start
• stop

# Constructors

# constructor

• new Particle()

# Inherited from

BasicParticle.constructor

# Events

# onAdd

• onAdd:

---

# onRelease

• onRelease:

---

# onRemove

• onRemove:

---

# onTick

• onTick:

---

# onUpdate

• onUpdate:

# Properties

# priority

• Readonly priority: number = 300

# Overrides

BasicParticle.priority

---

# schema

• Readonly schema: IComponentSchema

详见ParticleSchema。

# Inherited from

BasicParticle.schema

---

# subEmitters

• subEmitters: any = null

---

# EVENTS

▪ Static EVENTS: string[]

# Overrides

BasicParticle.EVENTS

# Accessors

# billboardMode

• get billboardMode(): number

# Returns

number

• set billboardMode(value): void

# Parameters

# Returns

void

---

# data

• get data(): IParticleData

# Returns

IParticleData

• set data(value): void

# Parameters

# Returns

void

---

# el

• get el(): Element

挂载的元素。

# Returns

Element

---

# emitterPosition

• get emitterPosition(): Vector3

# Returns

Vector3

• set emitterPosition(value): void

# Parameters

# Returns

void

---

# id

• get id(): number

# Returns

number

---

# material

• get material(): Material

# Returns

Material

• set material(value): void

# Parameters

# Returns

void

---

# particleEmitter

• get particleEmitter(): BasicShapeEmitter

# Returns

BasicShapeEmitter

---

# scene

• get scene(): Scene

当前场景。

# Returns

Scene

---

# spriteChangeSpeed

• get spriteChangeSpeed(): number

# Returns

number

---

# useBillboard

• get useBillboard(): boolean

# Returns

boolean

• set useBillboard(value): void

# Parameters

# Returns

void

---

# useRampGradients

• get useRampGradients(): boolean

# Returns

boolean

• set useRampGradients(value): void

# Parameters

# Returns

void

---

# useRandomSpriteCellIndex

• get useRandomSpriteCellIndex(): boolean

# Returns

boolean

---

# useSpriteCellLoop

• get useSpriteCellLoop(): boolean

# Returns

boolean

---

# useSpriteSheet

• get useSpriteSheet(): boolean

# Returns

boolean

• set useSpriteSheet(value): void

# Parameters

# Returns

void

---

# version

• get version(): number

当前版本，每次有数据更新都会增加，可以用作和其他组件合作的依据。

# Returns

number

# Methods

# addAlphaGradient

▸ addAlphaGradient(gradient, alpha, alpha2?): void

添加粒子运动过程中的透明度变化规则。

# Parameters

# Returns

void

# Inherited from

BasicParticle.addAlphaGradient

---

# addColorGradient

▸ addColorGradient(gradient, color1, color2?): void

添加粒子运动过程中的颜色变化规则。

# Parameters

# Returns

void

# Inherited from

BasicParticle.addColorGradient

---

# addColorRemapGradient

▸ addColorRemapGradient(gradient, min, max?): void

添加粒子运动过程中的透明度变化范围。

# Parameters

# Returns

void

# Inherited from

BasicParticle.addColorRemapGradient

---

# addDragGradient

▸ addDragGradient(gradient, drag, drag2?): void

添加粒子运动过程中的阻力规则。

# Parameters

# Returns

void

# Inherited from

BasicParticle.addDragGradient

---

# addLimitSpeedGradient

▸ addLimitSpeedGradient(gradient, limitSpeed, limitSpeed2?): void

添加粒子运动过程中的速度限制规则。

# Parameters

# Returns

void

# Inherited from

BasicParticle.addLimitSpeedGradient

---

# addRampGradient

▸ addRampGradient(gradient, color): void

添加粒子运动过程中的根据透明度影响的颜色变化规则，将通过颜色变化图纹理进行采样。

# Parameters

# Returns

void

# Inherited from

BasicParticle.addRampGradient

---

# addSizeGradient

▸ addSizeGradient(gradient, size, size2?): void

添加粒子运动过程中的尺寸变化规则。

# Parameters

# Returns

void

# Inherited from

BasicParticle.addSizeGradient

---

# addSpeedScaleGradient

▸ addSpeedScaleGradient(gradient, speed, speed2?): void

添加粒子运动过程中的速度变化规则。

# Parameters

# Returns

void

# Inherited from

BasicParticle.addSpeedScaleGradient

---

# clone

▸ clone(): Particle

获取一个拷贝的粒子系统。

# Returns

Particle

# Inherited from

BasicParticle.clone

---

# createBoxEmitter

▸ createBoxEmitter(direction1, direction2, minEmitBox, maxEmitBox): default

创建一个箱形发射器。

# Parameters

# Returns

default

箱形发射器

# Inherited from

BasicParticle.createBoxEmitter

---

# createPointEmitter

▸ createPointEmitter(direction1, direction2): default

创建一个点发射器。

# Parameters

# Returns

default

点发射器

# Inherited from

BasicParticle.createPointEmitter

---

# createSphereEmitter

▸ createSphereEmitter(radius, radiusRange, arc, randomizeDirection): default

创建一个球形发射器。

# Parameters

# Returns

default

球形发射器

# Inherited from

BasicParticle.createSphereEmitter

---

# createSubEmitter

▸ createSubEmitter(data): SubEmitter

获取一个粒子子发射器。

# Parameters

# Returns

SubEmitter

# Inherited from

BasicParticle.createSubEmitter

---

# getData

▸ getData<T>(key): IParticleData[T]

获取一个当前值。

# Type parameters

# Parameters

# Returns

IParticleData[T]

# Inherited from

BasicParticle.getData

---

# initParticle

▸ initParticle(data): void

初始化粒子系统的状态。

# Parameters

# Returns

void

---

# resetParticle

▸ resetParticle(): void

重置粒子系统的状态。

# Returns

void

---

# setData

▸ setData(data): void

不通过xml而是直接设置data，注意值的类型需要和schema中一致。

# Parameters

# Returns

void

# Inherited from

BasicParticle.setData

---

# setDataOne

▸ setDataOne<T>(key, value): void

设置一个数据。

# Type parameters

# Parameters

# Returns

void

# Inherited from

BasicParticle.setDataOne

---

# start

▸ start(delay?): void

粒子系统开始播放。

# Parameters

# Returns

void

---

# stop

▸ stop(): void

停止粒子系统与其子发射器的播放。

# Returns

void