RSX Code Reference
    Preparing search index...

    Class RotateInteractiveGizmo

    The RotateInteractiveGizmo implements a BuiltInInteractiveGizmo that allows an object to be rotated around the three primary axes facing the camera.

    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 Summary)

    Index
    _delta: Quaternion
    _deltaAngle: rsx.Degree

    Angle of the rotation delta.

    _dragStartRotation: Quaternion

    Rotation of the gizmo at drag start.

    _isDragActive: boolean
    _isDragged: boolean
    _position: Vector3
    _worldAxes: Matrix3
    _worldRotationAxis: Vector3

    Axis of the rotation delta in world space.

    cameraLayer: rsx.LayerMask
    • get delta(): Quaternion

      Amount of rotation applied since the start of the drag.

      Returns Quaternion

    • 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 isHovering(): boolean

      Determines if the gizmo currently being hovered.

      Returns boolean

    • get worldAxes(): Matrix3

      World axes of the gizmo. Columns are the world-space local X, Y, Z directions.

      Returns Matrix3

    • set worldAxes(value: Immutable<Matrix3>): void

      Parameters

      Returns void

    • get worldPosition(): Vector3

      World position of the gizmo.

      Returns Vector3

    • set worldPosition(value: Immutable<Vector3>): void

      Parameters

      Returns void

    • get worldRotation(): Quaternion

      World rotation of the gizmo.

      Returns Quaternion

    • set worldRotation(value: Immutable<Quaternion>): void

      Parameters

      Returns void

    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.