Class ParticleVelocityOptions

Structure used for initializing a ParticleVelocity object.

Index

Constructors

Properties

_isWorldSpace _velocity

Accessors

isWorldSpace velocity

Methods

assign clone isEqual isEqual

Constructors

constructor

new ParticleVelocityOptions(velocity?, isWorldSpace?): ParticleVelocityOptions
Parameters
- Optionalvelocity: Vector3Distribution
- OptionalisWorldSpace: boolean
Returns ParticleVelocityOptions

Properties

`Protected`_isWorldSpace

_isWorldSpace: boolean

`Protected`_velocity

_velocity: Vector3Distribution

Accessors

isWorldSpace

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

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

velocity

get velocity(): Vector3Distribution
Determines the velocity of the particles evaluated over particle lifetime.

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

Methods

assign

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

clone

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

Returns ParticleVelocityOptions

isEqual

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

`Static`isEqual

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