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

public class | source

Force

Extends:

Behaviour → Force

Direct Subclass:

Gravity

Behaviour that forces particles along a specific axis.

Static Method Summary

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

Constructor Summary

Public Constructor
public	constructor(fx: number, fy: number, fz: number, life: number, easing: function, isEnabled: boolean): * Constructs a Force behaviour instance.

Member Summary

Public Members
public	force: Vector3D The normalized force to exert on the particle in

Method Summary

Public Methods
public	mutate(particle: object, time: number, index: integer): * Mutates the particle.acceleration property.
public	reset(fx: number, fy: number, fz: number) 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): Force source

Creates a Force initializer from JSON.

Override:

Behaviour#fromJSON

Params:

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

Return:

Force

Public Constructors

public constructor(fx: number, fy: number, fz: number, life: number, easing: function, isEnabled: boolean): * source

Constructs a Force behaviour instance.

Override:

Behaviour#constructor

Params:

Name	Type	Attribute	Description
fx	number		the x axis force
fy	number		the y axis force
fz	number		the z axis force
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 force: Vector3D source

The normalized force to exert on the particle in

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(fx: number, fy: number, fz: number) source

Resets the behaviour properties.

Override:

Behaviour#reset

Params:

Name	Type	Attribute	Description
fx	number		the x axis force
fy	number		the y axis force
fz	number		the z axis force