Class ParticleGroup<TParticle>

An abstract class representing a group of particles.

export
abstract
class: ParticleGroup
template: TParticle

Type parameters

TParticle: Particle

Hierarchy

ParticleGroup
- PixiParticleGroup

Index

Constructors

constructor

Properties

Accessors

individualGravityOffset

Methods

Constructors

constructor

new ParticleGroup(renderer: Renderer<any>): ParticleGroup

- Defined in base/particleGroup.ts:41
Parameters
- renderer: Renderer<any>
Returns ParticleGroup

Properties

Private _individualGravityOffset

_individualGravityOffset: number = 0

isVisible

isVisible: boolean = true

The visibility of the particles in this group.

memberof: ParticleGroup

particleHeight

particleHeight: number = 0

The default height for all particles.

memberof: ParticleGroup

particleWidth

particleWidth: number = 0

The default width for all particles.

memberof: ParticleGroup

particles

particles: TParticle[] = []

The list of particles.

type: {TParticle[]}
memberof: ParticleGroup

renderer

renderer: Renderer<any>

Accessors

individualGravityOffset

get individualGravityOffset(): number
set individualGravityOffset(val: number): void

- Defined in base/particleGroup.ts:51
Gets/sets individual gravity offset of the particles in this group.

memberof

ParticleGroup

Returns number
- Defined in base/particleGroup.ts:60
Gets/sets individual gravity offset of the particles in this group.

memberof

ParticleGroup

Parameters
- val: number
Returns void

Methods

addParticle

addParticle(particle: TParticle): void

- Defined in base/particleGroup.ts:84
Adds a particle to the group.

memberof

ParticleGroup

Parameters
- particle: TParticle
Returns void

addParticles

addParticles(particles: TParticle[]): void

- Defined in base/particleGroup.ts:106
Adds an array of particles to the group.

memberof

ParticleGroup

Parameters
- particles: TParticle[]
Returns void

createAndAddParticle

createAndAddParticle(): void

- Defined in base/particleGroup.ts:96
Creates a particle and adds it to the group.

memberof

ParticleGroup

Returns void

Abstract createParticle

createParticle(): TParticle

- Defined in base/particleGroup.ts:76
Abstract method that must be implemented to return a new instantiated particle.

abstract

memberof

ParticleGroup

Returns TParticle

destroy

destroy(): void

- Defined in base/particleGroup.ts:134
Destroys and removes all of the particles in this group.

memberof

ParticleGroup

Returns void

draw

draw(): void

- Defined in base/particleGroup.ts:148
Draws all the particles in the group.

memberof

ParticleGroup

Returns void

removeParticle

removeParticle(particle: TParticle): void

- Defined in base/particleGroup.ts:118
Removes a particle from the group.

memberof

ParticleGroup

Parameters
- particle: TParticle
Returns void

Generated using TypeDoc