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

public class | source

RandomDrift

Extends:

Behaviour → RandomDrift

Behaviour that causes particles to drift to random coordinates in 3D space.

Static Method Summary

Static Public Methods
public static	fromJSON(json: ):

Constructor Summary

Public Constructor
public	constructor(driftX: number, driftY: number, driftZ: number, delay: number, life: number, easing: function): * Constructs a RandomDrift behaviour instance.

Member Summary

Public Members
public	delayPan: Span A Span containing the delay supplied.
public	randomForce: Vector3D A Vector3D that stores the drift properties.
public	time: number Internal time used for calculating drift vs internal delay.

Method Summary

Public Methods
public	mutate(particle: object, time: number, index: integer): * Mutates the particle.acceleration property.
public	reset(driftX: number, driftY: number, driftZ: number, delay: 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: ): source

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

Override:

Behaviour#fromJSON

Params:

Name	Type	Attribute	Description
json	*

Return:

Public Constructors

public constructor(driftX: number, driftY: number, driftZ: number, delay: number, life: number, easing: function): * source

Constructs a RandomDrift behaviour instance.

Override:

Behaviour#constructor

Params:

Name	Type	Attribute	Description
driftX	number		x axis drift
driftY	number		y axis drift
driftZ	number		z axis drift
delay	number	optional default: DEFAULT_RANDOM_DRIFT_DELAY	drift delay
life	number		The life of the particle
easing	function		The behaviour's decaying trend

Return:

void

Public Members

public delayPan: Span source

A Span containing the delay supplied.

public randomForce: Vector3D source

A Vector3D that stores the drift properties.

public time: number source

Internal time used for calculating drift vs internal delay.

Public Methods

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

Mutates the particle.acceleration property.

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(driftX: number, driftY: number, driftZ: number, delay: number, life: number, easing: function) source

Resets the behaviour properties.

Override:

Behaviour#reset

Params:

Name	Type	Attribute	Description
driftX	number		x axis drift
driftY	number		y axis drift
driftZ	number		z axis drift
delay	number	optional default: DEFAULT_RANDOM_DRIFT_DELAY	drift delay
life	number		The life of the particle
easing	function		The behaviour's decaying trend

RandomDrift

Extends:

Static Method Summary

Constructor Summary

Member Summary

Method Summary

Inherited Summary

Static Public Methods

public static fromJSON(json: *): * source

Override:

Params:

Return:

Public Constructors

public constructor(driftX: number, driftY: number, driftZ: number, delay: number, life: number, easing: function): * source

Override:

Params:

Return:

Public Members

public delayPan: Span source

public randomForce: Vector3D source

public time: number source

Public Methods

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

Override:

Params:

Return:

public reset(driftX: number, driftY: number, driftZ: number, delay: number, life: number, easing: function) source

Override:

Params:

public static fromJSON(json: ): source