AzToolsFramework::ViewportEditorModes Class Reference

The encapsulation of the editor modes for a given viewport. More...

#include <ViewportEditorModeTracker.h>

Inherits AzToolsFramework::ViewportEditorModesInterface.

Public Member Functions
AZ::Outcome< void, AZStd::string >	ActivateMode (ViewportEditorMode mode)
	Sets the specified mode as active.
AZ::Outcome< void, AZStd::string >	DeactivateMode (ViewportEditorMode mode)
bool	IsModeActive (ViewportEditorMode mode) const override
	Returns true if the specified editor mode is active, otherwise false.
Public Member Functions inherited from AzToolsFramework::ViewportEditorModesInterface
	AZ_RTTI (ViewportEditorModesInterface, "{2421496C-4A46-41C9-8AEF-AE2B6E43E6CF}")

Static Public Attributes
static constexpr AZ::u8	NumEditorModes = 4
	The number of currently supported viewport editor modes.

Detailed Description

The encapsulation of the editor modes for a given viewport.

Member Function Documentation

IsModeActive()

bool AzToolsFramework::ViewportEditorModes::IsModeActive ( ViewportEditorMode  mode ) const

overridevirtual

Returns true if the specified editor mode is active, otherwise false.

Implements AzToolsFramework::ViewportEditorModesInterface.

---

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

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