Class ParticleRotationOptions

Structure used for initializing a ParticleRotation object.

Index

Constructors

Properties

_isUsing3DRotation _rotation _rotation3D

Accessors

isUsing3DRotation rotation rotation3D

Methods

assign clone isEqual isEqual

Constructors

constructor

new ParticleRotationOptions(rotation?, rotation3D?, isUsing3DRotation?): ParticleRotationOptions
Parameters
- Optionalrotation: FloatDistribution
- Optionalrotation3D: Vector3Distribution
- OptionalisUsing3DRotation: boolean
Returns ParticleRotationOptions

Properties

`Protected`_isUsing3DRotation

_isUsing3DRotation: boolean

`Protected`_rotation

_rotation: FloatDistribution

`Protected`_rotation3D

_rotation3D: Vector3Distribution

Accessors

isUsing3DRotation

get isUsing3DRotation(): boolean
Determines should the particle rotation be a single angle applied around a Z axis (if disabled), or a set of Euler angles that allow you to rotate around every axis (if enabled).

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

rotation

get rotation(): FloatDistribution
Determines the rotation of the particles in degrees, applied around the particle's local Z axis. Only used if 3D rotation is disabled.

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

rotation3D

get rotation3D(): Vector3Distribution
Determines the rotation of the particles in degrees as Euler angles. Only used if 3D rotation is enabled.

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

Methods

assign

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

clone

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

Returns ParticleRotationOptions

isEqual

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

`Static`isEqual

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