Class ParticleSphereShapeOptions

Information describing a ParticleEmitterSphereShape.

Index

Constructors

Properties

_radius _thickness

Accessors

radius thickness

Methods

assign clone isEqual isEqual

Constructors

constructor

new ParticleSphereShapeOptions(radius?, thickness?): ParticleSphereShapeOptions
Parameters
- Optionalradius: number
- Optionalthickness: number
Returns ParticleSphereShapeOptions

Properties

`Protected`_radius

_radius: number

`Protected`_thickness

_thickness: number

Accessors

radius

get radius(): number
Radius of the sphere.

Returns number
set radius(value): void
Parameters
- value: number
Returns void

thickness

get thickness(): number
Proportion of the volume that can emit particles. Thickness of 0 results in particles being emitted only from the edge of the volume, while thickness of 1 results in particles being emitted from the entire volume. In-between values will use a part of the volume.

Returns number
set thickness(value): void
Parameters
- value: number
Returns void

Methods

assign

assign(other): ParticleSphereShapeOptions
Copies all properties defined by the prototype of ParticleSphereShapeOptions from other to this instance.
Parameters
- other: Immutable<ParticleSphereShapeOptions>
Returns ParticleSphereShapeOptions

clone

clone(): ParticleSphereShapeOptions
Clones this instance and returns a new ParticleSphereShapeOptions with identical values.

Returns ParticleSphereShapeOptions

isEqual

isEqual(this, other): boolean
Determines if this ParticleSphereShapeOptions instance is equal to the other instance.
Parameters
- this: Immutable<ParticleSphereShapeOptions>
- other: Immutable<ParticleSphereShapeOptions>
Returns boolean

`Static`isEqual

isEqual(lhs, rhs): boolean
Determines if both ParticleSphereShapeOptions instances are equal.
Parameters
- lhs: Immutable<ParticleSphereShapeOptions>
- rhs: Immutable<ParticleSphereShapeOptions>
Returns boolean