Class InteractiveGizmoSliderPlane

Interactive gizmo that returns a delta value as you drag the pointer along a plane. For intersection purposes the line is internally by a quadrilateral.

Hierarchy (view full)

Constructors

  • Constructs a new plane slider. The plane is constructed from two direction vectors.

    Parameters

    • parentGizmo: InteractiveGizmo
    • dir1: Vector3

      First direction of the plane. The x component of returned delta value will be in this direction. Should be perpendicular to dir2.

    • dir2: Vector3

      Second direction of the plane. The y component of returned delta value will be in this direction. Should be perpendicular to dir1.

    • length: number

      Determines size of the plane.

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

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(): Immutable<Vector2>
  • Returns a delta value that is the result of dragging/sliding the pointer along the plane. Returned movement is in terms of the two directions originally provided when constructing the slider. This changes every frame and will be zero unless the slider is active.

    Returns Immutable<Vector2>

  • 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 scale(): Immutable<Vector3>
  • Sets the scale of the slider.

    Returns Immutable<Vector3>

  • set scale(value): void
  • Parameters

    Returns void

  • get unwrappedDelta(): Immutable<Vector2>
  • 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 Immutable<Vector2>