Class SceneGizmos

drawSettings

• get drawSettings(): Immutable<GizmoDrawSettings>

• Set the settings.

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

• Parameters

  • value: Immutable<GizmoDrawSettings>

  Returns void

registeredGizmos

• get registeredGizmos(): Iterable<RegisteredGizmo>

• Gets the list of registered gizmo types.

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

  Returns Iterable<RegisteredGizmo>

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[]

isActive

• isActive(): boolean

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

  Returns boolean

notifyMouseEvent

• notifyMouseEvent(event, inputPosition): boolean

• Notifies this SceneGizmos of a mouse event. Creates a corresponding InteractiveGizmoEvent that is sent to the InteractiveGizmoManager of this SceneGizmos.

  Parameters

  • event: UIMouseEvent

    The event that occurred.
  • inputPosition: Immutable<Vector2>

    Mouse position in texture space of the viewport

  Returns boolean

  True, if the event was handled

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

ReadonlyonGizmoDraw