Class Position

Sets the starting position property for initialized particles. This is derived from a zone randomly chosen from those supplied to the constructor.

Hierarchy

default
- Position

Index

Constructors

Properties

isEnabled type zones

Methods

addZone init initialize reset fromJSON requiresWebGlApi

Constructors

constructor

new Position(...zones: Zone[]): Position
Constructs a Position initializer instance.
Parameters
- ...zones: Zone[]
  The zones to use as bounds for the particle's starting position
Returns Position
Overrides Initializer.constructor
- Defined in src/initializer/Position.ts:28

Properties

isEnabled

isEnabled: boolean

type

type: string

zones

zones: Zone[]

Methods

addZone

addZone(...zones: Zone[]): void
Adds a zone or zones to this.zones.
Parameters
- ...zones: Zone[]
  The zones to add
Returns void
- Defined in src/initializer/Position.ts:58

init

init(emitter: Emitter, particle?: Particle): void
Initializes the property on the emitter or particle.
Parameters
- emitter: Emitter
- Optionalparticle: Particle
Returns void
Inherited from Initializer.init
- Defined in src/initializer/Initializer.ts:25

initialize

initialize(target: Particle | Emitter): void
Sets the particle's initial position.
Parameters
- target: Particle | Emitter
  the particle to initialize the property on
Returns void
Overrides Initializer.initialize
- Defined in src/initializer/Position.ts:67

reset

reset(...zones: Zone[]): void
Resets the initializer properties. Clears all previously set zones and resets the zones according to args passed.
Parameters
- ...zones: Zone[]
  The zones to use as bounds for the particle's starting position
Returns void
Overrides Initializer.reset
- Defined in src/initializer/Position.ts:40

`Static`fromJSON

fromJSON(json: PositionJSON): Position
Creates a Position initializer from JSON.
Parameters
- json: PositionJSON
  The JSON to construct the instance from.
Returns Position
Overrides Initializer.fromJSON
- Defined in src/initializer/Position.ts:82

`Static`requiresWebGlApi

requiresWebGlApi(): boolean
Determines if the initializer requires a WebGL API to be provided to its constructor.

Returns boolean
Inherited from Initializer.requiresWebGlApi
- Defined in src/initializer/Initializer.ts:55