Class SceneGizmos

drawSettings

• get drawSettings(): Immutable<GizmoDrawSettings>

• Set the settings.

  Returns Immutable<GizmoDrawSettings>
• set drawSettings(value): void

• Parameters

  • value: Immutable<GizmoDrawSettings>

  Returns void

selection

• get selection(): Iterable<SceneObject>

• Returns Iterable<SceneObject>

• set selection(value): void

• Parameters

  • value: Iterable<SceneObject> | readonly SceneObject[]

  Returns void

clearSelection

• clearSelection(): void

• Clears the currently selected/active interactive gizmo for the specified camera.

  Returns void

draw

• draw(): void

• Order the gizmo drawing system to draw the current scene.

  Returns void

getActiveInteractiveGizmosForComponent

• getActiveInteractiveGizmosForComponent(component): InteractiveGizmo[]

• Gets the current gizmo for the specified component. If the component has no active gizmo, null is returned.

  Parameters

  • component: Component

  Returns InteractiveGizmo[]

getRegisteredGizmos

• getRegisteredGizmos(): RegisteredGizmo[]

• Gets the list of registered gizmo types.

  Use setGizmosEnabled to control whether a gizmo is available for instancing.

  Returns RegisteredGizmo[]

isActive

• isActive(): boolean

• Is any interactive gizmo selected/active on the specified camera.

  Returns boolean

registerInteractiveGizmo

• registerInteractiveGizmo(gizmo): void

• Register a gizmo.

  Parameters

  • gizmo: InteractiveGizmo

    The gizmo to register.

  Returns void

  Note

  To remove the gizmo, call InteractiveGizmo.Destroy.

setGizmosEnabled

• setGizmosEnabled(gizmoClasses, isEnabled): void

• Sets the state of the specified gizmoClasses.

  Parameters

  • gizmoClasses: Type[]
  • isEnabled: boolean

  Returns void

setMainInteractiveGizmo

• setMainInteractiveGizmo(handleManager): void

• Parameters

  • handleManager: InteractiveGizmo

  Returns void

trySelect

• trySelect(inputPosition): boolean

• Select a interactive gizmo at the specified location, if there is any under the pointer. Makes the selected interactive gizmo active and draggable.

  Parameters

  • inputPosition: Immutable<Vector2>

    Position of the pointer, relative to the provided camera viewport.

  Returns boolean

  True if interactive gizmo active state changed, false otherwise.

updateInput

• updateInput(viewportPositionInPixels, inputDeltaInPixels): boolean

• Required to be called everyframe to update all interactive gizmos with new event data.

  Parameters

  • viewportPositionInPixels: Immutable<Vector2>

    Position of the pointer, relative to the provided camera viewport, in pixels.
  • inputDeltaInPixels: Immutable<Vector2>

    Determines pointer movement since last call to this method.

  Returns boolean

  True if an interactive gizmo handled the event.

ReadonlyonGizmoDraw