Class InteractiveGizmoSliderLine

Interactive gizmo that returns a delta value as you drag the pointer along a line. For intersection purposes the line is internally by a capsule and a sphere at its cap (assuming this will be used for arrow-like gizmos).

Hierarchy (view full)

Constructors

  • Constructs a new line slider.

    Parameters

    • handle: InteractiveGizmo

      Parent handle that is responsible for the slider lifetime.

    • direction: Immutable<Vector3>

      Direction of the line.

    • lineLength: number

      Length of the slider.

    • layer: rsx.LayerMask

      Lower-bits of 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.

    Returns InteractiveGizmoSliderLine

  • Constructs a new line slider.

    Parameters

    • parentGizmo: InteractiveGizmo
    • direction: Immutable<Vector3>

      Direction of the line.

    • pointerType: EnumValue<LineGizmoPointerType, number>

      The type of the collider at the end of the line. If any.

    • pointerSize: number

      The scale of the pointer at the end of the line. If any.

    • lineLength: number

      Length of the slider, Default: 1.0.

    • lineRadius: number

      Radius of the slider, Default: 0.08.

    • 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 InteractiveGizmoSliderLine

Accessors

  • get color(): Immutable<Color>
  • The color of the slider.

    Returns Immutable<Color>

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

  • set color(value): void
  • Parameters

    Returns void

  • get delta(): number
  • Returns a delta value that is the result of dragging/sliding the pointer along the line. This changes every frame and will be zero unless the slider is active.

    Returns number

  • 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

  • get isDrawingWireframe(): boolean
  • Determines if the slider is being drawn as wireframe mesh instead of solid.

    Returns boolean

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

  • set isDrawingWireframe(value): void
  • Parameters

    • value: boolean

    Returns void

  • get isEnabled(): boolean
  • Enables or disables the slider, making it interactable or not.

    Returns boolean

  • set isEnabled(value): void
  • Parameters

    • value: boolean

    Returns void

  • 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

  • get layer(): rsx.LayerMask
  • Returns a layer that determines which sliders are interacted with from a specific camera.

    Returns rsx.LayerMask

  • get position(): Immutable<Vector3>
  • Sets the world position of the slider.

    Returns Immutable<Vector3>

  • set position(value): void
  • Parameters

    Returns void

  • get priority(): number
  • The selection priority of this slider. Higher values beat lower when multiple sliders are under the cursor.

    Returns number

  • set priority(value): void
  • Parameters

    • value: number

    Returns void

  • get scale(): Immutable<Vector3>
  • Sets the scale of the slider.

    Returns Immutable<Vector3>

  • set scale(value): void
  • Parameters

    Returns void

  • get transform(): Immutable<Transform>
  • Sets the full transform of the slider (position, rotation, scale, and skew).

    Returns Immutable<Transform>

  • set transform(value): void
  • Parameters

    Returns void

  • get unwrappedDelta(): number
  • Return a drag delta but compensating for screen wrapping. Meaning it is a delta as if the mouse were moving in an infinite screen.

    Returns number

Methods