Class ViewportInteractionBase

constructor

• new ViewportInteractionBase(
      viewportRenderer: UIViewportRenderer,
  ): ViewportInteractionBase

  Creates a new ViewportInteractionBase instance.

  Parameters

  • viewportRenderer: UIViewportRenderer

    The scene window that owns the scene mode.

  Returns ViewportInteractionBase

ReadonlyviewportRenderer

isAvailable

• get isAvailable(): boolean
  Virtual

  Determines if the interaction is available.

  Returns boolean

  Note

  If the interaction is not available, no events will be forwarded to it. This property allows interactions to determines if all the dependencies are availble for it to execute.

scenePicking

• get scenePicking(): ScenePicking

  The ScenePicking.

  Returns ScenePicking

viewportCamera

• get viewportCamera(): ViewportCamera

  The ViewportCamera the interaction controls.

  Returns ViewportCamera

viewportData

• get viewportData(): IViewportRendererData

  The ViewportRendererData used with this interaction.

  Returns IViewportRendererData

onCommandEvent

• onCommandEvent(theEvent: UICommandEvent): boolean
  Virtual

  Handles the specified command event.

  Parameters

  • theEvent: UICommandEvent

  Returns boolean

onDestroy

• onDestroy(): void
  Virtual

  Called when the editor window is being destroyed.

  Returns void

onDisable

• onDisable(): void
  Virtual

  Called when the mode is being deactivated.

  Returns void

onEditorUpdate

• onEditorUpdate(): void
  Virtual

  Called when the editor updates.

  Returns void

onEnable

• onEnable(): void
  Virtual

  Called when the mode is activated.

  Returns void

onModeChange

• onModeChange(): void
  Virtual

  Called on all modes when currently active mode is changed.

  Returns void

onMouseEvent

• onMouseEvent(theEvent: UIMouseEvent): boolean
  Virtual

  Handles the specified mouse event.

  Parameters

  • theEvent: UIMouseEvent

  Returns boolean