AzToolsFramework::ViewportEditorModeTracker Class Reference

The implementation of the central editor mode state tracker for all viewports. More...

#include <ViewportEditorModeTracker.h>

Inherits AzToolsFramework::ViewportEditorModeTrackerInterface.

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

Detailed Description

The implementation of the central editor mode state tracker for all viewports.

Member Function Documentation

ActivateMode()

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

overridevirtual

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

Implements AzToolsFramework::ViewportEditorModeTrackerInterface.

DeactivateMode()

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

overridevirtual

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

Implements AzToolsFramework::ViewportEditorModeTrackerInterface.

GetTrackedViewportCount()

size_t AzToolsFramework::ViewportEditorModeTracker::GetTrackedViewportCount ( ) const

overridevirtual

Returns the number of viewport editor mode trackers.

Implements AzToolsFramework::ViewportEditorModeTrackerInterface.

GetViewportEditorModes()

const ViewportEditorModesInterface * AzToolsFramework::ViewportEditorModeTracker::GetViewportEditorModes ( const ViewportEditorModeTrackerInfo &  ViewportEditorModeTrackerInfo ) const

overridevirtual

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

Implements AzToolsFramework::ViewportEditorModeTrackerInterface.

IsViewportModeTracked()

bool AzToolsFramework::ViewportEditorModeTracker::IsViewportModeTracked ( const ViewportEditorModeTrackerInfo &  ViewportEditorModeTrackerInfo ) const

overridevirtual

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

Implements AzToolsFramework::ViewportEditorModeTrackerInterface.

---

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

• Code/Framework/AzToolsFramework/AzToolsFramework/ViewportSelection/ViewportEditorModeTracker.h