Open 3D Engine AzToolsFramework API Reference 23.10.0
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
AzToolsFramework::ComponentModeFramework::ComponentModeRequests Class Referenceabstract

Mouse viewport events to be intercepted by individual ComponentModes. More...

#include <EditorComponentModeBus.h>

Inherits AzToolsFramework::ViewportInteraction::MouseViewportRequests, and AzToolsFramework::ComponentModeFramework::ComponentMode.

Public Member Functions

virtual void PostHandleMouseInteraction ()=0
 
- Public Member Functions inherited from AzToolsFramework::ViewportInteraction::MouseViewportRequests
virtual bool HandleMouseInteraction (const MouseInteractionEvent &)
 Implement this function to handle a particular mouse event.
 
- Public Member Functions inherited from AzToolsFramework::ComponentModeFramework::ComponentMode
virtual AZ::Uuid GetComponentType () const =0
 The type of the underlying Component this mode is for.
 
virtual AZ::Uuid GetComponentModeType () const =0
 The type of the Component Mode.
 
virtual AZ::ComponentId GetComponentId () const =0
 The Id of the underlying Component this mode is associated with.
 
virtual void Refresh ()=0
 
virtual AZStd::vector< ActionOverridePopulateActions ()=0
 Notify the ActionManager which actions should be enabled for this Mode.
 
virtual AZStd::vector< ViewportUi::ClusterIdPopulateViewportUi ()=0
 Add UI elements for this ComponentMode onto the Viewport UI system.
 
virtual AZStd::string GetComponentModeName () const =0
 The name for the ComponentMode to be displayed.
 

Detailed Description

Mouse viewport events to be intercepted by individual ComponentModes.

Member Function Documentation

◆ PostHandleMouseInteraction()

virtual void AzToolsFramework::ComponentModeFramework::ComponentModeRequests::PostHandleMouseInteraction ( )
pure virtual

This function is called internally after a mouse interaction returns true. Implementers of HandleMouseInteraction should not override this function.


The documentation for this class was generated from the following file: