RSX Code Reference
    Preparing search index...
    • rsx
    • ParticleVectorFieldSettings

    Class ParticleVectorFieldSettings

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

    Index
    • get intensity(): number

      Intensity of the forces and velocities applied by the vector field.

      Returns number

    • set intensity(value: number): void

      Parameters

      • value: number

      Returns void

    • 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: boolean): void

      Parameters

      • value: boolean

      Returns void

    • 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: boolean): void

      Parameters

      • value: boolean

      Returns void

    • 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: boolean): void

      Parameters

      • value: boolean

      Returns void

    • 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: number): void

      Parameters

      • value: number

      Returns void

    • get vectorField(): VectorField

      Represents a three dimensional field of vectors. It is represented by spatial bounds which are split into a grid of values with user-defined density, where each grid cell is assigned a vector.

      Returns VectorField

    • set vectorField(value: VectorField): void

      Represents a three dimensional field of vectors. It is represented by spatial bounds which are split into a grid of values with user-defined density, where each grid cell is assigned a vector.

      Parameters

      Returns void

    • Allows modifying this object multiple times in a row in a scope, without marking the object dirty immediately. Dirty flags are accumulated and the object is marked dirty at the end.

      Parameters

      • action: () => void

        The scope where the object is modified.

      Returns void