Class GizmoViewportInteraction

The GizmoViewportInteraction implements a ViewportInteractionBase that renders InteractiveGizmo to interact with scene objects.

Interactive gizmos are interactable controls in the scene such as the move and rotate gizmos. Users can extend handles by using the interactiveGizmo decorator on a subclass of InteractiveGizmo

Hierarchy (view full)

Constructors

constructor

Properties

onSceneSelectionChanged onSceneViewportRedrawRequested viewportRenderer kHandleAxesGUISize

Accessors

isMovePivotModeEnabled lastTextureSpaceDragPosition scenePicking sceneWindow selectionState viewportCamera viewportData

Methods

clearSelection disableSnappingHighlights draw enableSnappingHighlights onCommandEvent onDestroy onDisable onEditorUpdate onEnable onModeChange onMouseEvent pickPivotPosition setSnappingDestination toggleMovePivotMode updateBounds updateProjection setSnappingDestinationEdge setSnappingDestinationSurface setSnappingDestinationVertex

Constructors

constructor

Properties

ProtectedonSceneSelectionChanged

onSceneSelectionChanged: ((selectedSceneObjects: SceneObject[]) => void)

Triggered when the scene selection changed.

Type declaration

    • (selectedSceneObjects): void

    • Parameters

      • selectedSceneObjects: SceneObject[]

        The new selected objects.

      Returns void

ProtectedonSceneViewportRedrawRequested

onSceneViewportRedrawRequested: ((request: Const<SceneViewportRedrawRequest>) => void)

Called on viewport redraw request. This is used to update the picking cache on move pivot mode when the camera moves.

ReadonlyviewportRenderer

viewportRenderer: UIViewportRenderer

The viewport this interaction controls.

Static ReadonlykHandleAxesGUISize

kHandleAxesGUISize: number

Accessors

isMovePivotModeEnabled

  • get isMovePivotModeEnabled(): boolean

  • Check if the move pivot mode is currently enabled.

    Returns boolean

lastTextureSpaceDragPosition

  • get lastTextureSpaceDragPosition(): Vector2

  • The last drag position in viewport texture space. Note: This is needed as the handle manager is updated outside of the event handling. This should be fixed. The texture space position should be availabel in PostInput to pass through to consuming systems.

    Returns Vector2

scenePicking

sceneWindow

selectionState

viewportCamera

  • get viewportCamera(): ViewportCamera

  • The ViewportCamera the interaction controls.

    Returns ViewportCamera

viewportData

Methods

clearSelection

  • clearSelection(): void

  • Deactivates the previously selected handles.

    Returns void

ProtecteddisableSnappingHighlights

  • disableSnappingHighlights(): void

  • Disable feature higlight for move pivot snapping.

    Returns void

draw

  • draw(): void

  • Draws the handles and axes gui.

    Returns void

ProtectedenableSnappingHighlights

  • enableSnappingHighlights(): void

  • Enable feature highlight for move pivot snapping.

    Returns void

onCommandEvent

onDestroy

onDisable

onEditorUpdate

onEnable

onModeChange

onMouseEvent

ProtectedpickPivotPosition

  • pickPivotPosition(scenePosition, blocking?): void

  • Pick the pivot position under the cursor and snaps it to nearest scene feature based on settings.

    Parameters

    Returns void

setSnappingDestination

  • setSnappingDestination(snappingDestination): void

  • Set the snapping destination that is applied to move handle snapping.

    Parameters

    Returns void

toggleMovePivotMode

  • toggleMovePivotMode(isEnabled): void

  • Toggle between object move mode and pivot move mode.

    Parameters

    • isEnabled: boolean

      Will the mode be enabled or disabled.

    Returns void

ProtectedupdateBounds

  • updateBounds(): void

  • Handles updating the position of axes gizmo.

    Returns void

ProtectedupdateProjection

  • updateProjection(): void

  • Checks the axes gui for projection type change.

    Returns void

StaticsetSnappingDestinationEdge

  • setSnappingDestinationEdge(): void

  • Returns void

StaticsetSnappingDestinationSurface

  • setSnappingDestinationSurface(): void

  • Returns void

StaticsetSnappingDestinationVertex

  • setSnappingDestinationVertex(): void

  • Returns void

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods