three-nebula API
    Preparing search index...

    Class Radius

    Sets the radius property on initialized particles.

    Hierarchy

    • default
      • Radius
    Index
    • Constructs a Radius initializer instance.

      Parameters

      • Optionalwidth: number

        The width of the particle radius

      • Optionalheight: number

        The height of the particle radius

      • center: boolean = false

        Determines whether to average the radius value

      • isEnabled: boolean = true

      Returns Radius

    isEnabled: boolean
    radius: Span<number>
    type: string
    • Sets the particle's initial radius.

      Parameters

      • particle: Particle

        the particle to initialize the property on

      Returns void

    • Resets the initializer properties. Clears all previously set zones and resets the zones according to args passed.

      Parameters

      • Optionalwidth: number

        The width of the particle radius

      • Optionalheight: number

        The height of the particle radius

      • center: boolean = false

        Determines whether to average the radius value

      Returns void

    • Creates a Radius initializer from JSON.

      Parameters

      • json: RadiusJSON

        The JSON to construct the instance from.

      Returns Radius

    • Determines if the initializer requires a WebGL API to be provided to its constructor.

      Returns boolean