Class ParticleVectorFieldSettings

Settings used for controlling a vector field in a GPU simulated particle system.

Hierarchy

FrameworkObject
- ParticleVectorFieldSettings

Index

Constructors

Accessors

intensity isTilingX isTilingY isTilingZ offset rotation rotationRate scale tightness vectorField vectorFieldHandle

Constructors

`Protected`constructor

new ParticleVectorFieldSettings(isInternalConstructor?): ParticleVectorFieldSettings
Parameters
- OptionalisInternalConstructor: boolean
Returns ParticleVectorFieldSettings
Overrides FrameworkObject.constructor

Accessors

intensity

get intensity(): number
Intensity of the forces and velocities applied by the vector field.

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

isTilingX

get isTilingX(): boolean
Determines should the field influence particles outside of the field bounds. If true the field will be tiled infinitely in the X direction.

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

isTilingY

get isTilingY(): boolean
Determines should the field influence particles outside of the field bounds. If true the field will be tiled infinitely in the Y direction.

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

isTilingZ

get isTilingZ(): boolean
Determines should the field influence particles outside of the field bounds. If true the field will be tiled infinitely in the Z direction.

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

offset

get offset(): Immutable<Vector3>
Amount of to move the vector field by relative to the parent particle system. This is added to the bounds provided in the vector field resource.

Returns Immutable<Vector3>
set offset(value): void
Parameters
- value: Immutable<Vector3>
Returns void

rotation

get rotation(): Immutable<Quaternion>
Initial rotation of the vector field.

Returns Immutable<Quaternion>
set rotation(value): void
Parameters
- value: Immutable<Quaternion>
Returns void

rotationRate

get rotationRate(): Vector3Distribution
Determines the amount to rotate the vector field every second, in degrees, around XYZ axis respectively. Evaluated over the particle system lifetime.

Returns Vector3Distribution
set rotationRate(value): void
Parameters
- value: Immutable<Vector3> | Vector3Curve | Vector3Distribution
Returns void

scale

get scale(): Immutable<Vector3>
Scale to apply to the vector field bounds. This is multiplied with the bounds of the vector field resource.

Returns Immutable<Vector3>
set scale(value): void
Parameters
- value: Immutable<Vector3>
Returns void

tightness

get tightness(): number
Determines how closely does the particle velocity follow the vectors in the field. If set to 1 particles will be snapped to the exact velocity of the value in the field, and if set to 0 the field will not influence particle velocities directly.

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

vectorField

get vectorField(): VectorField
Vector field resource used for influencing the particles.

Returns VectorField
set vectorField(value): void
Vector field resource used for influencing the particles.
Parameters
- value: VectorField
Returns void

vectorFieldHandle

get vectorFieldHandle(): ResourceHandle<VectorField>
Vector field resource used for influencing the particles.

Returns ResourceHandle<VectorField>
set vectorFieldHandle(value): void
Parameters
- value: VectorField | ResourceHandle<VectorField>
Returns void