Class MoveInteractiveGizmo

The MoveInteractiveGizmo implements a BuiltInInteractiveGizmo that allows an object to be translated along the three primary axes.

When a drag is started the onDrag event is fired. The rotation of the target must be manually synchronized using the delta when the onDrag even is called. Once a drag completes, the onDragFinished event is called.

Hierarchy (view full)

Constructors

Properties

_autoUpdateIsDraggingPreInput: boolean
_axesMeshData: MeshData
_delta: Vector3
_gridDelta: Vector3
_initialDragPosition: Vector3
_isDragActive: boolean
_position: Vector3
_rotation: Quaternion
centerHandleRadius = 0.15
gizmoLayer: rsx.LayerMask
planeRectOffset = 0.7
planeSliderRectSize = 0.3

Accessors

  • get delta(): Vector3
  • Returns the amount of translation from the initial position. Only valid while the handle is being dragged.

    Returns Vector3

  • get gridDelta(): Vector3
  • Returns the amount of translation from the initial position, rounded to grid increment. Only valid while the handle is being dragged and grid snapping is enabled.

    Returns Vector3

  • get isAxisDragged(): boolean
  • Checks whether an axis of the handle is dragged.

    Returns boolean

  • get isDragging(): boolean
  • Determines if the gizmo currently being interacted with (clicking, or dragging).

    Returns boolean

  • get isEnabled(): boolean
  • Determines the active state of the gizmo. If disabled, the gizmo will not render or receive input.

    Returns boolean

  • get isFreeMoveDragged(): boolean
  • Check whether the current active slider if the free move slider (camera aligned movement).

    Returns boolean

  • get isHovering(): boolean
  • Determines if the gizmo currently being hovered.

    Returns boolean

  • get worldPosition(): Vector3
  • World position of the gizmo.

    Returns Vector3

  • set worldPosition(value): void
  • Parameters

    Returns void

  • get worldRotation(): Quaternion
  • World rotation of the gizmo.

    Returns Quaternion

  • set worldRotation(value): void
  • Parameters

    Returns void

Methods

  • Returns the direction of the handle's x axis in world space.

    Returns Vector3

    Direction of the handle's x axis in world space

  • Returns the direction of the handle's y axis in world space.

    Returns Vector3

    Direction of the handle's y axis in world space

  • Returns the direction of the handle's z axis in world space.

    Returns Vector3

    Direction of the handle's z axis in world space

  • Virtual

    Called every frame after handle input is processed. Active handle sliders should contain values signals if and how much they were dragged.

    Parameters

    Returns void

    Implementing classes must call super

Events

onDragStart: Event<any[], void>

Invoked when a drag is started and a new delta is available.

The onDrag event is invoked right after this event. Do not integrate the current delta during this event.

onDrag: Event<any[], void>

Invoked when a drag is performed and a new delta is available.

onDragFinished: Event<any[], void>

Invoked when the drag finished.