Class ParticleCircleShapeOptions

Information describing a ParticleEmitterCircleShape.

Index

Constructors

Properties

_arc _mode _radius _thickness

Accessors

arc mode radius thickness

Methods

assign clone isEqual isEqual

Constructors

constructor

new ParticleCircleShapeOptions(radius?, thickness?, arc?, mode?): ParticleCircleShapeOptions
Parameters
- Optionalradius: number
- Optionalthickness: number
- Optionalarc: rsx.Degree
- Optionalmode: Immutable<ParticleEmissionMode>
Returns ParticleCircleShapeOptions

Properties

`Protected`_arc

_arc: rsx.Degree

`Protected`_mode

_mode: ParticleEmissionMode

`Protected`_radius

_radius: number

`Protected`_thickness

_thickness: number

Accessors

arc

get arc(): rsx.Degree
Angular portion of the cone from which to emit particles from, in degrees.

Returns rsx.Degree
set arc(value): void
Parameters
- value: rsx.Degree
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

radius

get radius(): number
Radius of the circle.

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

thickness

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

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

Methods

assign

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

clone

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

Returns ParticleCircleShapeOptions

isEqual

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

`Static`isEqual

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