import BoxZone from 'three-nebula/src/zone/BoxZone.js'

public class | source

BoxZone

Extends:

Zone → BoxZone

Constructor Summary

Public Constructor
public	constructor(x: Number \| Vector3D, y: Number, z: Number, w: Number, h: Number, d: Number) BoxZone is a box zone

Member Summary

Public Members
public	depth: *
public	friction: number
public	height: *
public	max: number
public	width: *
public	x: *
public	y: *
public	z: *

Method Summary

Public Methods
public	getPosition(): *
public	isBoxZone(): boolean Returns true to indicate this is a BoxZone.

Private Methods
private	_bound(particle: *)
private	_cross(particle: *)
private	_dead(particle: *)
private	_static(particle: , axis: )

Inherited Summary

From class Zone
public	crossType: string
public	log: boolean
public	random: number
public	supportsCrossing: boolean
public	type: *
public	vector: *
public	crossing(particle: ):
public	getPosition(): *
public	isBoxZone(): boolean Determines if this zone is a BoxZone.
public	isLineZone(): boolean Determines if this zone is a LineZone.
public	isMeshZone(): boolean Determines if this zone is a MeshZone.
public	isPointZone(): boolean Determines if this zone is a PointZone.
public	isScreenZone(): boolean Determines if this zone is a ScreenZone.
public	isSphereZone(): boolean Determines if this zone is a SphereZone.
private abstract	_bound(particle: *)
private abstract	_cross(particle: *)
private abstract	_dead(particle: Particle) Sets the particle's dead property to true if required.

Public Constructors

public constructor(x: Number | Vector3D, y: Number, z: Number, w: Number, h: Number, d: Number) source

BoxZone is a box zone

Override:

Zone#constructor

Params:

Name	Type	Attribute	Description
x	Number \| Vector3D		the position's x value or a Vector3D Object
y	Number		the position's y value
z	Number		the position's z value
w	Number		the Box's width
h	Number		the Box's height
d	Number		the Box's depth

Example:

var boxZone = new BoxZone(0,0,0,50,50,50);
or
var boxZone = new BoxZone(new Vector3D(0,0,0), 50, 50, 50);

Public Members

public depth: * source

public friction: number source

public height: * source

public max: number source

public width: * source

public x: * source

public y: * source

public z: * source

Public Methods

public getPosition(): * source

Override:

Zone#getPosition

Return:

public isBoxZone(): boolean source

Returns true to indicate this is a BoxZone.

Override:

Zone#isBoxZone

Return:

boolean

Private Methods

private _bound(particle: *) source

Override:

Zone#_bound

Params:

Name	Type	Attribute	Description
particle	*

private _cross(particle: *) source

Override:

Zone#_cross

Params:

Name	Type	Attribute	Description
particle	*

private _dead(particle: *) source

Sets the particle's dead property to true if required.

Override:

Zone#_dead

Params:

Name	Type	Attribute	Description
particle	*

private _static(particle: , axis: ) source

Params:

Name	Type	Attribute	Description
particle	*
axis	*

BoxZone

Extends:

Constructor Summary

Member Summary

Method Summary

Inherited Summary

Public Constructors

public constructor(x: Number | Vector3D, y: Number, z: Number, w: Number, h: Number, d: Number) source

Override:

Params:

Example:

Public Members

public depth: * source

public friction: number source

public height: * source

public max: number source

public width: * source

public x: * source

public y: * source

public z: * source

Public Methods

public getPosition(): * source

Override:

Return:

public isBoxZone(): boolean source

Override:

Return:

Private Methods

private _bound(particle: *) source

Override:

Params:

private _cross(particle: *) source

Override:

Params:

private _dead(particle: *) source

Override:

Params:

private _static(particle: *, axis: *) source

Params:

private _static(particle: , axis: ) source