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

public class | source

Color

Extends:

Behaviour → Color

A behaviour which mutates the color of a particle over time.

Static Method Summary

Static Public Methods
public static	fromJSON(json: object): Color Creates a Color initializer from JSON.

Constructor Summary

Public Constructor
public	constructor(colorA: number \| string, colorB: number \| string, life: number, easing: function, isEnabled: boolean): * Constructs a Color behaviour instance.

Member Summary

Public Members
public	colorA: *
public	colorB: *
public get	same: boolean: * Gets the _same property which determines if the alpha are the same.
public set	same(same: boolean): boolean Sets the _same property which determines if the alpha are the same.

Private Members
private	_same: boolean

Method Summary

Public Methods
public	initialize(particle: *)
public	mutate(particle: , time: , index: *)
public	reset(colorA: , colorB: , life: , easing: )

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): Color source

Creates a Color initializer from JSON.

Override:

Behaviour#fromJSON

Params:

Name	Type	Attribute	Description
json	object		The JSON to construct the instance from.

Return:

Color

Return Properties:

Name	Type	Attribute	Description
json.colorA	number		The starting color
json.colorB	number		The ending color
json.life	number		The life of the particle
json.easing	string		The behaviour's decaying trend

Public Constructors

public constructor(colorA: number | string, colorB: number | string, life: number, easing: function, isEnabled: boolean): * source

Constructs a Color behaviour instance.

Override:

Behaviour#constructor

Params:

Name	Type	Attribute	Description
colorA	number \| string		the starting color
colorB	number \| string		the ending color
life	number		the life of the particle
easing	function		The behaviour's decaying trend
isEnabled	boolean	optional default: true	Determines if the behaviour will be applied or not

Return:

void

Public Members

public colorA: * source

public colorB: * source

public get same: boolean: * source

Gets the _same property which determines if the alpha are the same.

Return:

boolean

public set same(same: boolean): boolean source

Sets the _same property which determines if the alpha are the same.

Return:

boolean

Private Members

private _same: boolean source

Public Methods

public initialize(particle: *) source

Set the behaviour's initial properties on the particle.

Override:

Behaviour#initialize

Params:

Name	Type	Attribute	Description
particle	*

public mutate(particle: , time: , index: *) source

Change the target's properties according to specific behaviour logic.

Override:

Behaviour#mutate

Params:

Name	Type	Attribute	Description
particle	*
time	*
index	*

public reset(colorA: , colorB: , life: , easing: ) source

Reset this behaviour's parameters

Override:

Behaviour#reset

Params:

Name	Type	Attribute	Description
colorA	*
colorB	*
life	*
easing	*

Color

Extends:

Static Method Summary

Constructor Summary

Member Summary

Method Summary

Inherited Summary

Static Public Methods

public static fromJSON(json: object): Color source

Override:

Params:

Return:

Return Properties:

Public Constructors

public constructor(colorA: number | string, colorB: number | string, life: number, easing: function, isEnabled: boolean): * source

Override:

Params:

Return:

Public Members

public colorA: * source

public colorB: * source

public get same: boolean: * source

Return:

public set same(same: boolean): boolean source

Return:

Private Members

private _same: boolean source

Public Methods

public initialize(particle: *) source

Override:

Params:

public mutate(particle: *, time: *, index: *) source

Override:

Params:

public reset(colorA: *, colorB: *, life: *, easing: *) source

Override:

Params:

public mutate(particle: , time: , index: *) source

public reset(colorA: , colorB: , life: , easing: ) source