Home Reference Source 
import CrossZone from 'three-nebula/src/behaviour/CrossZone.js'
public class | source

CrossZone

Extends:

Behaviour → CrossZone

Behaviour that allows for specific functions to be called on particles when they interact with a zone.

Static Method Summary

Static Public Methods
public static

Creates a CrossZone initializer from JSON.

Constructor Summary

Public Constructor
public

constructor(zone: Zone, crossType: string, life: number, easing: function, isEnabled: boolean)

Constructs a CrossZone behaviour instance.

Member Summary

Public Members
public

The zone used to apply to particles with this behaviour

Method Summary

Public Methods
public

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

Applies the behaviour to the particle.
public

reset(zone: Zone, crossType: string, 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

The age of the behaviour
public

Determines if the behaviour is dead or not
public

The behaviour's decaying trend
public

The energy of the behaviour
public

The behaviour's id
public

Determines if the behaviour will be applied or not
public

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

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

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

Normalize a force by 1:100;
public

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

Creates a CrossZone initializer from JSON.

Override:

Behaviour#fromJSON

Params:

NameTypeAttributeDescription
json object

The JSON to construct the instance from.

Return:

CrossZone

Public Constructors

public constructor(zone: Zone, crossType: string, life: number, easing: function, isEnabled: boolean) source

Constructs a CrossZone behaviour instance.

Override:

Behaviour#constructor

Params:

NameTypeAttributeDescription
zone Zone

the zone used to apply to particles with this behaviour
crossType string
  • optional
  • default: DEFAULT_CROSS_TYPE

enum of cross types, valid strings include 'dead', 'bound', 'cross'
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

Public Members

public zone: Zone source

The zone used to apply to particles with this behaviour

Public Methods

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

Applies the behaviour to the particle.

Override:

Behaviour#mutate

Params:

NameTypeAttributeDescription
particle object

the particle to apply the behaviour to
time number

engine time
index integer

the particle index

Return:

*

void

See:

  • {@link '../zone/Zone.js'} crossing

public reset(zone: Zone, crossType: string, life: number, easing: function) source

Resets the behaviour properties.

Override:

Behaviour#reset

Params:

NameTypeAttributeDescription
zone Zone

the zone used to apply to particles with this behaviour
crossType string
  • optional
  • default: DEFAULT_CROSS_TYPE

enum of cross types, valid strings include 'dead', 'bound', 'cross'
life number

The life of the particle
easing function

The behaviour's decaying trend