Class Repulsion

Behaviour that causes particles to be repelled from a target position.

Hierarchy (View Summary)

Attraction
- Repulsion

Index

Constructors

Properties

_life age attractionForce dead easing energy force id isEnabled lengthSq radius radiusSq targetPosition type

Accessors

Methods

applyBehaviour destroy energize fromJSON initialize mutate normalizeForce normalizeValue reset fromJSON

Constructors

constructor

new Repulsion(
    targetPosition: Vector3D,
    force: number,
    radius: number,
    life?: number,
    easing?: EasingFunction,
    isEnabled?: boolean,
): Repulsion
Constructs an Repulsion behaviour instance.
Parameters
- targetPosition: Vector3D
  The position the particles will be repelled from
- force: number
  The repulsion force scalar multiplier
- radius: number
  The repulsion radius
- Optionallife: number
  The life of the particle
- Optionaleasing: EasingFunction
  The behaviour's decaying trend
- isEnabled: boolean = true
Returns Repulsion
Overrides Attraction.constructor
- Defined in src/behaviour/Repulsion.ts:32

Properties

_life

_life: number

age

age: number

attractionForce

attractionForce: Vector3D

dead

dead: boolean

easing

easing: EasingFunction

energy

energy: number

force

force: number

id

id: string

isEnabled

isEnabled: boolean

lengthSq

lengthSq: number

radius

radius: number

radiusSq

radiusSq: number

targetPosition

targetPosition: Vector3D

type

type: string

Accessors

life

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

Returns number
Inherited from Attraction.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 Attraction.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 Attraction.applyBehaviour
- Defined in src/behaviour/Behaviour.ts:93

`Abstract`destroy

destroy(): void
Destroy this behaviour.

Returns void
Inherited from Attraction.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 Attraction.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 Attraction.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 Attraction.initialize
- Defined in src/behaviour/Behaviour.ts:88

mutate

mutate(particle: Particle, time: number, index?: number): void
Mutates particle acceleration.
Parameters
- particle: Particle
  the particle to apply the behaviour to
- time: number
  particle engine time
- Optionalindex: number
  the particle index
Returns void
Inherited from Attraction.mutate
- Defined in src/behaviour/Attraction.ts:123

normalizeForce

normalizeForce(force: Vector3D): Vector3D
Normalize a force by 1:100.
Parameters
- force: Vector3D
Returns Vector3D
Inherited from Attraction.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 Attraction.normalizeValue
- Defined in src/behaviour/Behaviour.ts:79

reset

reset(
    targetPosition: Vector3D,
    force: number,
    radius: number,
    life?: number,
    easing?: EasingFunction,
): void
Resets the behaviour properties.
Parameters
- targetPosition: Vector3D
  the position the particles will be attracted to
- force: number
  the attraction force multiplier
- radius: number
  the attraction radius
- Optionallife: number
  the life of the particle
- Optionaleasing: EasingFunction
  The behaviour's decaying trend
Returns void
Overrides Attraction.reset
- Defined in src/behaviour/Repulsion.ts:62

`Static`fromJSON

fromJSON(json: RepulsionJSON): Repulsion
Creates a Body initializer from JSON.
Parameters
- json: RepulsionJSON
  The JSON to construct the instance from.
Returns Repulsion
Overrides Attraction.fromJSON
- Defined in src/behaviour/Repulsion.ts:78