Class GizmoUtility

The GizmoUtility provides helper functions for viewport gizmos that use the drawGizmo decorators as well as InteractiveGizmo subclasses. It also provides access to settings that are reused for different gizmo implementations.

Index

Constructors

Accessors

snapModifierKey snappingSettings

Methods

createAvailableGizmoContextMenu getInteractiveGizmoSize snapDegree snapValue snapVector syncActiveGizmoStatesFromSettings

Constructors

constructor

new GizmoUtility(): GizmoUtility
Returns GizmoUtility

Accessors

`Static`snapModifierKey

get snapModifierKey(): EnumValue<ButtonCode, number>
The modifier key used for handle grid snapping.

Returns EnumValue<ButtonCode, number>

`Static`snappingSettings

get snappingSettings(): SnappingSettings
The snapping settings.

Returns SnappingSettings

Methods

`Static`createAvailableGizmoContextMenu

createAvailableGizmoContextMenu(sceneGizmos): UIContextMenu
Creates a context menu for the available gizmos.
Parameters
- sceneGizmos: SceneGizmos
  Scene gizmos to create the context menu from.
Returns UIContextMenu
Context menu for the available gizmos.

`Static`getInteractiveGizmoSize

getInteractiveGizmoSize(camera, position): number
Returns a scale that can be applied to a handle in order to keep it at constant size regardless of distance from the provided camera.
Parameters
- camera: Camera
  Camera through which the handle is being viewed.
- position: Immutable<Vector3>
  center of the handle.
Returns number
Uniform scale to apply to the handle.

`Static`snapDegree

snapDegree(value, snapAmount): rsx.Degree
Snaps an angle value to the specified increments.
Parameters
- value: rsx.Degree
  Value to snap.
- snapAmount: rsx.Degree
  Increment to which to snap the value to.
Returns rsx.Degree
Value snapped to the provided increments.

`Static`snapValue

snapValue(value, snapAmount): number
Snaps a value to the specified increments.
Parameters
- value: number
  Value to snap.
- snapAmount: number
  Increment to which to snap the value to.
Returns number
Value snapped to the provided increments.

`Static`snapVector

snapVector(value, snapAmount): Vector3
Snaps a vector to the specified increments.
Parameters
- value: Immutable<Vector3>
  Vector to snap.
- snapAmount: number
  Increment to which to snap the value to.
Returns Vector3
Value snapped to the provided increments.

`Static`syncActiveGizmoStatesFromSettings

syncActiveGizmoStatesFromSettings(sceneGizmos): void
Syncs the active gizmo states from the settings.
Parameters
- sceneGizmos: SceneGizmos
  Scene gizmos to sync the active gizmo states to.
Returns void