Class ParticleOrbitOptions

Structure used for initializing a ParticleOrbit object.

Index

Constructors

Properties

_center _isWorldSpace _radial _velocity

Accessors

center isWorldSpace radial velocity

Methods

assign clone isEqual isEqual

Constructors

constructor

new ParticleOrbitOptions(center?, velocity?, radial?, isWorldSpace?): ParticleOrbitOptions
Parameters
- Optionalcenter: Vector3Distribution
- Optionalvelocity: Vector3Distribution
- Optionalradial: FloatDistribution
- OptionalisWorldSpace: boolean
Returns ParticleOrbitOptions

Properties

`Protected`_center

_center: Vector3Distribution

`Protected`_isWorldSpace

_isWorldSpace: boolean

`Protected`_radial

_radial: FloatDistribution

`Protected`_velocity

_velocity: Vector3Distribution

Accessors

center

get center(): Vector3Distribution
Position of the center around which to orbit. Evaluated over particle system lifetime.

Returns Vector3Distribution
set center(value): void
Parameters
- value: Vector3Distribution
Returns void

isWorldSpace

get isWorldSpace(): boolean
True if the properties provided are in world space, false if in local space.

Returns boolean
set isWorldSpace(value): void
Parameters
- value: boolean
Returns void

radial

get radial(): FloatDistribution
Speed at which to push or pull the particles towards/away from the center. Evaluated over particle lifetime.

Returns FloatDistribution
set radial(value): void
Parameters
- value: FloatDistribution
Returns void

velocity

get velocity(): Vector3Distribution
Determines the speed of rotation around each axis. The speed is specified in "turns" where 0 = no rotation, 0.5 = 180 degree rotation and 1 = 360 degree rotation. Evaluated over particle lifetime.

Returns Vector3Distribution
set velocity(value): void
Parameters
- value: Vector3Distribution
Returns void

Methods

assign

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

clone

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

Returns ParticleOrbitOptions

isEqual

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

`Static`isEqual

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