Class Force

Behaviour that forces particles along a specific axis.

Hierarchy (View Summary)

Behaviour
- Force
  - Gravity

Index

Constructors

Properties

_life age dead easing energy force id isEnabled type

Accessors

Methods

applyBehaviour destroy energize fromJSON initialize mutate normalizeForce normalizeValue reset fromJSON

Constructors

constructor

new Force(
    fx?: number,
    fy?: number,
    fz?: number,
    life?: number,
    easing?: EasingFunction,
    isEnabled?: boolean,
): Force
Constructs a Force behaviour instance.
Parameters
- Optionalfx: number
  the x axis force
- Optionalfy: number
  the y axis force
- Optionalfz: number
  the z axis force
- Optionallife: number
  the life of the particle
- Optionaleasing: EasingFunction
  The behaviour's decaying trend
- isEnabled: boolean = true
  Determines if the behaviour will be applied or not
Returns Force
Overrides Behaviour.constructor
- Defined in src/behaviour/Force.ts:34

Properties

_life

_life: number

age

age: number

dead

dead: boolean

easing

easing: EasingFunction

energy

energy: number

force

force: Vector3D & { id: number }

id

id: string

isEnabled

isEnabled: boolean

type

type: string

Accessors

life

get life(): number
Gets the behaviour's life.

Returns number
Inherited from Behaviour.life
- Defined in src/behaviour/Behaviour.ts:65
set life(life: number): void
Ensures that life is infinity if an invalid value is supplied.
Parameters
- life: number
Returns void
Inherited from Behaviour.life
- Defined in src/behaviour/Behaviour.ts:58

Methods

applyBehaviour

applyBehaviour(target: Particle | Emitter, time: number, index?: number): void
Apply behaviour to the target as a factor of time.
Parameters
- target: Particle | Emitter
- time: number
- Optionalindex: number
Returns void
Inherited from Behaviour.applyBehaviour
- Defined in src/behaviour/Behaviour.ts:93

`Abstract`destroy

destroy(): void
Destroy this behaviour.

Returns void
Inherited from Behaviour.destroy
- Defined in src/behaviour/Behaviour.ts:140

energize

energize(particle: Particle, time: number, index?: number): void
Compares the age of the behaviour vs integration time and determines if the behaviour should be set to dead or not.
Parameters
- particle: Particle
- time: number
- Optionalindex: number
Returns void
Inherited from Behaviour.energize
- Defined in src/behaviour/Behaviour.ts:116

`Abstract`fromJSON

fromJSON(json: Record<string, unknown>): void
Returns a new instance of the behaviour from the JSON object passed.
Parameters
- json: Record<string, unknown>
Returns void
Inherited from Behaviour.fromJSON
- Defined in src/behaviour/Behaviour.ts:147

`Abstract`initialize

initialize(particle: Particle): void
Set the behaviour's initial properties on the particle.
Parameters
- particle: Particle
Returns void
Inherited from Behaviour.initialize
- Defined in src/behaviour/Behaviour.ts:88

mutate

mutate(particle: Particle, time: number, index?: number): void
Mutates the particle.acceleration property.
Parameters
- particle: Particle
  the particle to apply the behaviour to
- time: number
  engine time
- Optionalindex: number
  the particle index
Returns void
Overrides Behaviour.mutate
- Defined in src/behaviour/Force.ts:75

normalizeForce

normalizeForce(force: Vector3D): Vector3D
Normalize a force by 1:100.
Parameters
- force: Vector3D
Returns Vector3D
Inherited from Behaviour.normalizeForce
- Defined in src/behaviour/Behaviour.ts:72

normalizeValue

normalizeValue(value: number): number
Normalize a value by 1:100.
Parameters
- value: number
Returns number
Inherited from Behaviour.normalizeValue
- Defined in src/behaviour/Behaviour.ts:79

reset

reset(fx?: number, fy?: number, fz?: number): void
Resets the behaviour properties.
Parameters
- Optionalfx: number
  the x axis force
- Optionalfy: number
  the y axis force
- Optionalfz: number
  the z axis force
Returns void
Overrides Behaviour.reset
- Defined in src/behaviour/Force.ts:54

`Static`fromJSON

fromJSON(json: ForceJSON): Force
Creates a Force initializer from JSON.
Parameters
- json: ForceJSON
  The JSON to construct the instance from.
Returns Force
- Defined in src/behaviour/Force.ts:86