Class GizmoUtility

constructor

• new GizmoUtility(): GizmoUtility

  Returns GizmoUtility

Static ReadonlydefaultViewportWidth

StaticsnapModifierKey

• get snapModifierKey(): EnumValue<ButtonCode>

  The modifier key used for handle grid snapping.

  Returns EnumValue<ButtonCode>

StaticsnappingSettings

• get snappingSettings(): SnappingSettings

  The snapping settings.

  Returns SnappingSettings

StaticcreateAvailableGizmoContextMenu

• createAvailableGizmoContextMenu(sceneGizmos: 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.

StaticgetInteractiveGizmoSize

• getInteractiveGizmoSize(
      camera: Camera,
      position: Immutable<Vector3>,
      window: EditorWindowBase,
  ): 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 and the size of the viewport.

  Parameters

  • camera: Camera

    Camera through which the handle is being viewed.

  • position: Immutable<Vector3>

    center of the handle.

  • window: EditorWindowBase

    Window the gizmo is rendered in.

  Returns number

  Uniform scale to apply to the handle.

StaticsnapDegree

• snapDegree(value: rsx.Degree, snapAmount: rsx.Degree): 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.

StaticsnapValue

• snapValue(value: number, snapAmount: number): 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.

StaticsnapVector

• snapVector(value: Immutable<Vector3>, snapAmount: number): 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.

StaticsyncActiveGizmoStatesFromSettings

• syncActiveGizmoStatesFromSettings(sceneGizmos: SceneGizmos): void

  Syncs the active gizmo states from the settings.

  Parameters

  • sceneGizmos: SceneGizmos

    Scene gizmos to sync the active gizmo states to.

  Returns void