Class InteractiveGizmoSliderSphere

Interactive gizmo represented by a sphere collider. The slider allow dragging on the plane most orhtogonal to the camera view direction.

Hierarchy (view full)

Constructors

constructor

Accessors

color delta isCustomDrawingEnabled isDrawingWireframe isEnabled isFixedScale layer position rotation scale state

Constructors

constructor

  • new InteractiveGizmoSliderSphere(handle, radius, layer, fixedScale?, isInternalConstructor?): InteractiveGizmoSliderSphere

  • Constructs a new sphere slider.

    Parameters

    • handle: InteractiveGizmo

      Parent handle that is responsible for the slider lifetime.

    • radius: number

      Radius of the collider sphere.

    • layer: rsx.LayerMask

      The Layer that allows filtering of which sliders are interacted with from a specific camera.

    • OptionalfixedScale: boolean

      If true the interactive gizmo will always try to maintain the same visible area in the viewport regardless of distance from camera.

    • OptionalisInternalConstructor: boolean

    Returns InteractiveGizmoSliderSphere

Accessors

color

  • get color(): Immutable<Color>

  • The color of the slider.

    Returns Immutable<Color>

    Note

    This is only relevant if CustomDrawing is enabled and the default slider representation is drawn.

  • set color(value): void

  • Parameters

    Returns void

delta

isCustomDrawingEnabled

  • get isCustomDrawingEnabled(): boolean

  • Determines if custom drawing is enabled. This allows the user to draw custom gizmos for the slider in the Draw method of the parent InteractiveGizmo. If custom drawing is enabled, the built in visual representation for the slider will not be drawn.

    Returns boolean

  • set isCustomDrawingEnabled(value): void

  • Parameters

    • value: boolean

    Returns void

isDrawingWireframe

  • get isDrawingWireframe(): boolean

  • Determines if the slider is being drawn as wireframe mesh instead of solid.

    Returns boolean

    Note

    This is only relevant if CustomDrawing is enabled and the default slider representation is drawn.

  • set isDrawingWireframe(value): void

  • Parameters

    • value: boolean

    Returns void

isEnabled

  • get isEnabled(): boolean

  • Enables or disables the slider, making it interactable or not.

    Returns boolean

  • set isEnabled(value): void

  • Parameters

    • value: boolean

    Returns void

isFixedScale

  • get isFixedScale(): boolean

  • Returns if fixed scale is enabled. If enabled the interactive gizmo will always try to maintain the same visible area in the viewport regardless of distance from camera.

    Returns boolean

layer

  • get layer(): rsx.LayerMask

  • Returns a layer that determines which sliders are interacted with from a specific camera.

    Returns rsx.LayerMask

position

  • get position(): Immutable<Vector3>

  • Sets the world position of the slider.

    Returns Immutable<Vector3>

  • set position(value): void

  • Parameters

    Returns void

rotation

scale

  • get scale(): Immutable<Vector3>

  • Sets the scale of the slider.

    Returns Immutable<Vector3>

  • set scale(value): void

  • Parameters

    Returns void

state

Settings

Member Visibility

On This Page

Constructors
Accessors