Class InteractiveGizmoSliderDisc

Interactive gizmo that returns a delta value as you drag the pointer along a disc. For intersection purposes the disc is internally represented by a torus.

Hierarchy (view full)

Constructors

constructor

Accessors

color delta isCustomDrawingEnabled isDrawingWireframe isEnabled isFixedScale layer position rotation scale startAngle state

Methods

setCutoffPlane

Constructors

constructor

  • new InteractiveGizmoSliderDisc(parentGizmo, normal, radius, innerRadius, layer, fixedScale?, isInternalConstructor?): InteractiveGizmoSliderDisc

  • Constructs a new disc slider.

    Parameters

    • parentGizmo: InteractiveGizmo

      Parent gizmo that is responsible for the slider lifetime.

    • normal: Vector3

      Normal that determines the orientation of the disc. Default: 1.0

    • radius: number

      Radius of the disc. Default: 0.1

    • innerRadius: number

      Inner radius of the disc, relative to radius.

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

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

  • get delta(): rsx.Radian

  • Returns a delta value that is the result of dragging/sliding the pointer along the disc. This changes every frame and will be zero unless the slider is active.

    Returns rsx.Radian

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

startAngle

  • get startAngle(): rsx.Radian

  • Gets the initial angle at which the drag/slide operation started. This is only valid when the slider is active.

    Returns rsx.Radian

state

Methods

setCutoffPlane

  • setCutoffPlane(angle, enabled): void

  • Enables or disables a cut-off plane that can allow the disc to be intersected with only in an 180 degree arc.

    Parameters

    • angle: rsx.Degree

      Angle at which to start the cut-off. Points on the dist at the specified angle and the next 180 degrees won't be interactable.

    • enabled: boolean

      True to enable the cutoff plane, false otherwise.

    Returns void

Settings

Member Visibility

On This Page

Constructors
Accessors
Methods