Class SphereZone

A spherical zone for particles to be emitted within.

Hierarchy

default
- SphereZone

Index

Constructors

Properties

crossType log phi radius random supportsCrossing the type vector x y z

Methods

_bound _cross _dead crossing getPosition isBoxZone isLineZone isMeshZone isPointZone isScreenZone isSphereZone

Constructors

constructor

new SphereZone(
    centerX?: number,
    centerY?: number,
    centerZ?: number,
    radius?: number,
): SphereZone
Parameters
- OptionalcenterX: number
- OptionalcenterY: number
- OptionalcenterZ: number
- Optionalradius: number
Returns SphereZone
Overrides Zone.constructor
- Defined in src/zone/SphereZone.ts:23

Properties

crossType

crossType: string

log

log: boolean

phi

phi: number

radius

radius: number

random

random: number

supportsCrossing

supportsCrossing: boolean

the

the: number

type

type: string

vector

vector: Vector3D

x

x: number

y

y: number

z

z: number

Methods

`Abstract`_bound

_bound(particle: Particle): void
Parameters
- particle: Particle
Returns void
Overrides Zone._bound
- Defined in src/zone/SphereZone.ts:76

`Abstract`_cross

_cross(): void
Returns void
Overrides Zone._cross
- Defined in src/zone/SphereZone.ts:87

`Abstract`_dead

_dead(particle: Particle): void
Sets the particle's dead property to true if required.
Parameters
- particle: Particle
Returns void
Overrides Zone._dead
- Defined in src/zone/SphereZone.ts:70

crossing

crossing(particle: Particle): void
Parameters
- particle: Particle
Returns void
Inherited from Zone.crossing
- Defined in src/zone/Zone.ts:33

getPosition

getPosition(): Vector3D
Returns Vector3D
Overrides Zone.getPosition
- Defined in src/zone/SphereZone.ts:56

isBoxZone

isBoxZone(): boolean
Returns boolean
Inherited from Zone.isBoxZone
- Defined in src/zone/Zone.ts:57

isLineZone

isLineZone(): boolean
Returns boolean
Inherited from Zone.isLineZone
- Defined in src/zone/Zone.ts:61

isMeshZone

isMeshZone(): boolean
Returns boolean
Inherited from Zone.isMeshZone
- Defined in src/zone/Zone.ts:65

isPointZone

isPointZone(): boolean
Returns boolean
Inherited from Zone.isPointZone
- Defined in src/zone/Zone.ts:69

isScreenZone

isScreenZone(): boolean
Returns boolean
Inherited from Zone.isScreenZone
- Defined in src/zone/Zone.ts:73

isSphereZone

isSphereZone(): boolean
Returns boolean
Overrides Zone.isSphereZone
- Defined in src/zone/SphereZone.ts:52