Class ParticleBoxShapeOptions

Information describing a ParticleEmitterBoxShape.

Index

Constructors

Properties

Accessors

Methods

assign clone isEqual isEqual

Constructors

constructor

new ParticleBoxShapeOptions(type?, extents?): ParticleBoxShapeOptions
Parameters
- Optionaltype: EnumValue<ParticleEmitterBoxType, number>
- Optionalextents: Immutable<Vector3>
Returns ParticleBoxShapeOptions

Properties

`Protected`_extents

_extents: Vector3

`Protected`_type

_type: EnumValue<ParticleEmitterBoxType, number>

Accessors

extents

get extents(): Vector3
Extends of the box.

Returns Vector3
set extents(value): void
Parameters
- value: Immutable<Vector3>
Returns void

type

get type(): EnumValue<ParticleEmitterBoxType, number>
Determines from which portion of the box should particles be emitted from.

Returns EnumValue<ParticleEmitterBoxType, number>
set type(value): void
Parameters
- value: EnumValue<ParticleEmitterBoxType, number>
Returns void

Methods

assign

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

clone

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

Returns ParticleBoxShapeOptions

isEqual

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

`Static`isEqual

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