Class Rotate

Behaviour that rotates particles.

Hierarchy (View Summary)

Behaviour
- Rotate

Index

Constructors

Properties

_life _rotationType age dead easing energy id isEnabled type x y z

Accessors

life rotationType

Methods

_setRotation applyBehaviour destroy energize fromJSON initialize mutate normalizeForce normalizeValue reset fromJSON

Constructors

constructor

new Rotate(
    x: number,
    y: number,
    z: number,
    life?: number,
    easing?: EasingFunction,
    isEnabled?: boolean,
): Rotate
Constructs a Rotate behaviour instance.
Parameters
- x: number
  X axis rotation
- y: number
  Y axis rotation
- z: number
  Z axis rotation
- 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 Rotate
Overrides Behaviour.constructor
- Defined in src/behaviour/Rotate.ts:38

Properties

_life

_life: number

_rotationType

_rotationType: string

age

age: number

dead

dead: boolean

easing

easing: EasingFunction

energy

energy: number

id

id: string

isEnabled

isEnabled: boolean

type

type: string

x

x: number | Span<number>

y

y: number | Span<number>

z

z: number | Span<number>

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

rotationType

get rotationType(): string
Gets the rotation type.

Returns string
- Defined in src/behaviour/Rotate.ts:54
set rotationType(rotationType: string): void
Sets the rotation type.
Parameters
- rotationType: string
Returns void
- Defined in src/behaviour/Rotate.ts:61

Methods

_setRotation

_setRotation(
particleRotation: Vector3D,
value: string | number | Span<number>,
): void
Sets the particle's rotation prior to the behaviour being applied.

NOTE It's hard to see here, but this is mutating the particle's rotation even though the particle is not being passed in directly.

NOTE the else if below will never be reached because the value being passed in will never be of type Vector3D.
Parameters
- particleRotation: Vector3D
  the particle's rotation vector
- value: string | number | Span<number>
  the value to set the rotation value to, if 'random' rotation is randomised
Returns void
- Defined in src/behaviour/Rotate.ts:159

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/Rotate.ts:120

mutate

mutate(particle: Particle, time: number, index?: number): void
Mutates the particle.rotation property.
Parameters
- particle: Particle
  the particle to apply the behaviour to
- time: number
  engine time
- Optionalindex: number
  the particle index
Returns void

See
http://stackoverflow.com/questions/21622956/how-to-convert-direction-vector-to-euler-angles
Overrides Behaviour.mutate
- Defined in src/behaviour/Rotate.ts:187

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(
    x: number,
    y?: number,
    z?: number,
    life?: number,
    easing?: EasingFunction,
): void
Resets the behaviour properties.
Parameters
- x: number
  X axis rotation
- Optionaly: number
  Y axis rotation
- Optionalz: number
  Z axis rotation
- 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/Rotate.ts:77

`Static`fromJSON

fromJSON(json: RotateJSON): Rotate
Parameters
- json: RotateJSON
Returns Rotate
- Defined in src/behaviour/Rotate.ts:228