Class ParticleLineShapeOptions

Information describing a ParticleEmitterLineShape.

Index

Constructors

Properties

Accessors

Methods

assign clone isEqual isEqual

Constructors

constructor

new ParticleLineShapeOptions(length?, mode?): ParticleLineShapeOptions
Parameters
- Optionallength: number
- Optionalmode: Immutable<ParticleEmissionMode>
Returns ParticleLineShapeOptions

Properties

`Protected`_length

_length: number

`Protected`_mode

_mode: ParticleEmissionMode

Accessors

length

get length(): number
Length of the line.

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

mode

get mode(): ParticleEmissionMode
Determines how will particle positions on the shape be generated.

Returns ParticleEmissionMode
set mode(value): void
Parameters
- value: Immutable<ParticleEmissionMode>
Returns void

Methods

assign

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

clone

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

Returns ParticleLineShapeOptions

isEqual

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

`Static`isEqual

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