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.
Public Member Functions | List of all members
AzToolsFramework::ViewportEditorModeTrackerInterface Class Referenceabstract

The AZ::Interface of the central editor mode tracker for all viewports. More...

#include <ViewportEditorModeTrackerInterface.h>

Inherited by AzToolsFramework::ViewportEditorModeTracker.

Public Member Functions

 AZ_RTTI (ViewportEditorModeTrackerInterface, "{7D72A4F7-2147-4ED9-A315-E456A3BE3CF6}")
 
virtual AZ::Outcome< void, AZStd::string > ActivateMode (const ViewportEditorModeTrackerInfo &ViewportEditorModeTrackerInfo, ViewportEditorMode mode)=0
 Activates the specified editor mode for the specified viewport editor mode tracker.
 
virtual AZ::Outcome< void, AZStd::string > DeactivateMode (const ViewportEditorModeTrackerInfo &ViewportEditorModeTrackerInfo, ViewportEditorMode mode)=0
 Deactivates the specified editor mode for the specified viewport editor mode tracker.
 
virtual const ViewportEditorModesInterface * GetViewportEditorModes (const ViewportEditorModeTrackerInfo &ViewportEditorModeTrackerInfo) const =0
 Attempts to retrieve the editor mode state for the specified viewport editor mode tracker, otherwise returns nullptr.
 
virtual size_t GetTrackedViewportCount () const =0
 Returns the number of viewport editor mode trackers.
 
virtual bool IsViewportModeTracked (const ViewportEditorModeTrackerInfo &ViewportEditorModeTrackerInfo) const =0
 Returns true if viewport editor modes are being tracked for the specified od, otherwise false.
 

Detailed Description

The AZ::Interface of the central editor mode tracker for all viewports.

Member Function Documentation

◆ ActivateMode()

virtual AZ::Outcome< void, AZStd::string > AzToolsFramework::ViewportEditorModeTrackerInterface::ActivateMode ( const ViewportEditorModeTrackerInfo &  ViewportEditorModeTrackerInfo,
ViewportEditorMode  mode 
)
pure virtual

Activates the specified editor mode for the specified viewport editor mode tracker.

Implemented in AzToolsFramework::ViewportEditorModeTracker.

◆ DeactivateMode()

virtual AZ::Outcome< void, AZStd::string > AzToolsFramework::ViewportEditorModeTrackerInterface::DeactivateMode ( const ViewportEditorModeTrackerInfo &  ViewportEditorModeTrackerInfo,
ViewportEditorMode  mode 
)
pure virtual

Deactivates the specified editor mode for the specified viewport editor mode tracker.

Implemented in AzToolsFramework::ViewportEditorModeTracker.

◆ GetTrackedViewportCount()

virtual size_t AzToolsFramework::ViewportEditorModeTrackerInterface::GetTrackedViewportCount ( ) const
pure virtual

Returns the number of viewport editor mode trackers.

Implemented in AzToolsFramework::ViewportEditorModeTracker.

◆ GetViewportEditorModes()

virtual const ViewportEditorModesInterface * AzToolsFramework::ViewportEditorModeTrackerInterface::GetViewportEditorModes ( const ViewportEditorModeTrackerInfo &  ViewportEditorModeTrackerInfo) const
pure virtual

Attempts to retrieve the editor mode state for the specified viewport editor mode tracker, otherwise returns nullptr.

Implemented in AzToolsFramework::ViewportEditorModeTracker.

◆ IsViewportModeTracked()

virtual bool AzToolsFramework::ViewportEditorModeTrackerInterface::IsViewportModeTracked ( const ViewportEditorModeTrackerInfo &  ViewportEditorModeTrackerInfo) const
pure virtual

Returns true if viewport editor modes are being tracked for the specified od, otherwise false.

Implemented in AzToolsFramework::ViewportEditorModeTracker.

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