Class ParticleForceOptions

Structure used for initializing a ParticleForce object.

Index

Constructors

Properties

_force _isWorldSpace

Accessors

force isWorldSpace

Methods

assign clone isEqual isEqual

Constructors

constructor

new ParticleForceOptions(force?, isWorldSpace?): ParticleForceOptions
Parameters
- Optionalforce: Vector3Distribution
- OptionalisWorldSpace: boolean
Returns ParticleForceOptions

Properties

`Protected`_force

_force: Vector3Distribution

`Protected`_isWorldSpace

_isWorldSpace: boolean

Accessors

force

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

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

isWorldSpace

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

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

Methods

assign

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

clone

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

Returns ParticleForceOptions

isEqual

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

`Static`isEqual

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