Class MovePivotInteractiveGizmo

Manages the handle to reposition the pivot of selected scene objects.

Hierarchy (View Summary)

SceneObjectInteractiveGizmo
- MovePivotInteractiveGizmo

Index

Constructors

constructor

new MovePivotInteractiveGizmo(
viewportInteraction: GizmoViewportInteraction,
): MovePivotInteractiveGizmo
Parameters
- viewportInteraction: GizmoViewportInteraction
Returns MovePivotInteractiveGizmo

Overrides SceneObjectInteractiveGizmo.constructor

Properties

`Protected` `Readonly`_activeSelectionPivotOffset

_activeSelectionPivotOffset: Vector3

The offset of the pivot of the current selection.

`Protected`_currentPivotWorldPosition

_currentPivotWorldPosition: Vector3

The current position of the pivot.

`Protected` `Readonly`_gizmoViewportInteraction

_gizmoViewportInteraction: GizmoViewportInteraction

`Protected`_isDragged

_isDragged: boolean

`Protected`_moveInteractiveGizmo

_moveInteractiveGizmo: MoveInteractiveGizmo

The move handle used to drag the pivot.

`Protected`_selectedObject

_selectedObject: SceneObject

The selected scene object.

`Protected`_selectedSceneObjects

_selectedSceneObjects: SceneObject[]

The selected scene object

Accessors

activeSelectionPivotOffset

get activeSelectionPivotOffset(): Immutable<Vector3>

The offset of the pivot of the current selection, in object space.

Returns Immutable<Vector3>

Overrides SceneObjectInteractiveGizmo.activeSelectionPivotOffset
set activeSelectionPivotOffset(value: Immutable<Vector3>): void
The offset of the pivot of the current selection, in object space.
Parameters
- value: Immutable<Vector3>
Returns void

Overrides SceneObjectInteractiveGizmo.activeSelectionPivotOffset

isEnabled

get isEnabled(): boolean

Determines the active state of the gizmo. If disabled, the gizmo will not render or receive input.

Returns boolean

Inherited from SceneObjectInteractiveGizmo.isEnabled

moveInteractiveGizmo

get moveInteractiveGizmo(): MoveInteractiveGizmo

The move handle used to drag the pivot.

Returns MoveInteractiveGizmo

Methods

destroy

destroy(): void

Destroy the interactive gizmo and registered slider gizmos.

Returns void

Inherited from SceneObjectInteractiveGizmo.destroy

disable

disable(): void

Disable the handle manager and it's handles.

Returns void

Overrides SceneObjectInteractiveGizmo.disable

`Abstract`draw

draw(event: InteractiveGizmoEvent): void
Virtual
Called every frame after postInput. Allows interactive gizmo graphics to be drawn. This is the only method that draw methods may be called
Parameters
- event: InteractiveGizmoEvent
Returns void

Overrides SceneObjectInteractiveGizmo.draw

drawSliderGizmos

drawSliderGizmos(event: InteractiveGizmoEvent): void
Draws all child slider gizmos registered to this gizmo.
Parameters
- event: InteractiveGizmoEvent
Returns void

Inherited from SceneObjectInteractiveGizmo.drawSliderGizmos

`Abstract`postInput

postInput(event: InteractiveGizmoEvent): void
Virtual
Called every frame after interactive gizmo input is processed. Active interactive gizmos will now contain values and signals if and how much they were dragged.
Parameters
- event: InteractiveGizmoEvent
Returns void

Overrides SceneObjectInteractiveGizmo.postInput

`Abstract`preInput

preInput(event: InteractiveGizmoEvent): void
Virtual
Called every frame before interactive gizmo input is processed. Allows interactive gizmo transforms to be updated before input.
Parameters
- event: InteractiveGizmoEvent
Returns void

Overrides SceneObjectInteractiveGizmo.preInput

setPivotPosition

setPivotPosition(position: Immutable<Vector3>): void
Set the position of the pivot, moving the handle to the position and setting the scene object pivot offset in case of single selection.
Parameters
- position: Immutable<Vector3>
  The position of the pivot
Returns void

setSelection

setSelection(selection: SceneObject[]): void
Set the current selection.
Parameters
- selection: SceneObject[]
Returns void

Overrides SceneObjectInteractiveGizmo.setSelection