import Scale from 'three-nebula/src/behaviour/Scale.js'

public class | source

Scale

Extends:

Behaviour → Scale

Behaviour that scales particles.

Static Method Summary

Static Public Methods
public static	fromJSON(json: object): Spring Returns a new instance of the behaviour from the JSON object passed.

Constructor Summary

Public Constructor
public	constructor(scaleA: number, scaleB: number, life: number, easing: function, isEnabled: boolean): * Constructs a Scale behaviour instance.

Member Summary

Public Members
public get	same: boolean: * Gets the _same property which determines if the scale props are the same.
public set	same(same: boolean): boolean Sets the _same property which determines if the scale props are the same.
public	scaleA: Span The starting scale.
public	scaleB: Span The ending scale.

Private Members
private	_same: boolean

Method Summary

Public Methods
public	initialize(particle: object): * Initializes the behaviour on a particle.
public	mutate(particle: object, time: number, index: integer): * Applies the behaviour to the particle.
public	reset(scaleA: number, scaleB: number, life: number, easing: function): * Resets the behaviour properties.

Inherited Summary

From class Behaviour
public get	life: Number: * Gets the behaviour's life.
public set	life: * Ensures that life is infinity if an invalid value is supplied.
public	age: number The age of the behaviour
public	dead: boolean Determines if the behaviour is dead or not
public	easing: function The behaviour's decaying trend
public	energy: number The energy of the behaviour
public	id: string The behaviour's id
public	isEnabled: boolean Determines if the behaviour will be applied or not
public	type: string The class type.
private	_life: *
public abstract	applyBehaviour(target: Particle \| Emitter, time: Number, index: integer): * Apply behaviour to the target as a factor of time.
public abstract	destroy() Destory this behaviour.
public	energize(particle: Particle, time: Number): * Compares the age of the behaviour vs integration time and determines if the behaviour should be set to dead or not.
public abstract	fromJSON(json: object): Behaviour Returns a new instance of the behaviour from the JSON object passed.
public abstract	initialize(particle: Particle) Set the behaviour's initial properties on the particle.
public abstract	mutate(target: Particle \| Emitter, time: Number): * Change the target's properties according to specific behaviour logic.
public	normalizeForce(force: Vector3D): Vector3D Normalize a force by 1:100;
public	normalizeValue(value: number): number Normalize a value by 1:100;
public	reset(life: number, easing: function) Reset this behaviour's parameters

Static Public Methods

public static fromJSON(json: object): Spring source

Returns a new instance of the behaviour from the JSON object passed.

Override:

Behaviour#fromJSON

Params:

Name	Type	Attribute	Description
json	object		JSON object containing the required constructor properties

Return:

Spring

Public Constructors

public constructor(scaleA: number, scaleB: number, life: number, easing: function, isEnabled: boolean): * source

Constructs a Scale behaviour instance.

Override:

Behaviour#constructor

Params:

Name	Type	Attribute	Description
scaleA	number		the starting scale value
scaleB	number	nullable: true	the ending scale value
life	number		the life of the behaviour
easing	function		the easing equation to use for transforms
isEnabled	boolean	optional default: true	Determines if the behaviour will be applied or not

Return:

void

Public Members

public get same: boolean: * source

Gets the _same property which determines if the scale props are the same.

Return:

boolean

public set same(same: boolean): boolean source

Sets the _same property which determines if the scale props are the same.

Return:

boolean

public scaleA: Span source

The starting scale.

public scaleB: Span source

The ending scale.

Private Members

private _same: boolean source

Public Methods

public initialize(particle: object): * source

Initializes the behaviour on a particle. Stores initial values for comparison and mutation in the applyBehaviour method.

Override:

Behaviour#initialize

Params:

Name	Type	Attribute	Description
particle	object		the particle to initialize the behaviour on

Return:

void

public mutate(particle: object, time: number, index: integer): * source

Applies the behaviour to the particle. Mutates the particle's scale and its radius according to this scale.

Override:

Behaviour#mutate

Params:

Name	Type	Attribute	Description
particle	object		the particle to apply the behaviour to
time	number		engine time
index	integer		the particle index

Return:

void

public reset(scaleA: number, scaleB: number, life: number, easing: function): * source

Resets the behaviour properties.

Override:

Behaviour#reset

Params:

Name	Type	Attribute	Description
scaleA	number		the starting scale value
scaleB	number	nullable: true	the ending scale value
life	number		the life of the behaviour
easing	function		the easing equation to use for transforms

Return:

void