Class Alpha

Behaviour that applies an alpha transition effect to particles.

Hierarchy (View Summary)

Behaviour
- Alpha

Index

Constructors

Properties

_life _same age alphaA alphaB dead easing energy id isEnabled type

Accessors

Methods

applyBehaviour destroy energize fromJSON initialize mutate normalizeForce normalizeValue reset fromJSON

Constructors

constructor

new Alpha(
    alphaA?: number,
    alphaB?: number | null,
    life?: number,
    easing?: EasingFunction,
    isEnabled?: boolean,
): Alpha
Constructs an Alpha behaviour instance.
Parameters
- alphaA: number = 1
  The starting alpha value
- alphaB: number | null = null
  The ending alpha value
- Optionallife: number
  The life of the behaviour
- Optionaleasing: EasingFunction
  The easing equation to use for transforms
- isEnabled: boolean = true
  Determines if the behaviour will be applied or not
Returns Alpha
Overrides Behaviour.constructor
- Defined in src/behaviour/Alpha.ts:36

Properties

_life

_life: number

_same

_same: boolean

age

age: number

alphaA

alphaA: Span<number>

alphaB

alphaB: Span<number>

dead

dead: boolean

easing

easing: EasingFunction

energy

energy: 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

same

get same(): boolean
Gets the _same property which determines if the alpha are the same.

Returns boolean
- Defined in src/behaviour/Alpha.ts:51
set same(same: boolean): void
Sets the _same property which determines if the alpha are the same.
Parameters
- same: boolean
Returns void
- Defined in src/behaviour/Alpha.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

initialize

initialize(particle: Particle): void
Initializes the behaviour on a particle.
Parameters
- particle: Particle
  the particle to initialize the behaviour on
Returns void
Overrides Behaviour.initialize
- Defined in src/behaviour/Alpha.ts:88

mutate

mutate(particle: Particle, time: number, index?: number): void
Mutates the target's alpha/opacity 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/Alpha.ts:104

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(
    alphaA?: number,
    alphaB?: number | null,
    life?: number,
    easing?: EasingFunction,
): void
Resets the behaviour properties.
Parameters
- alphaA: number = 1
  the starting alpha value
- alphaB: number | null = null
  the ending alpha value
- Optionallife: number
  the life of the behaviour
- Optionaleasing: EasingFunction
  the easing equation to use for transforms
Returns void
Overrides Behaviour.reset
- Defined in src/behaviour/Alpha.ts:70

`Static`fromJSON

fromJSON(json: AlphaJSON): Alpha
Creates a Body initializer from JSON.
Parameters
- json: AlphaJSON
  The JSON to construct the instance from.
Returns Alpha
- Defined in src/behaviour/Alpha.ts:123