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::ViewportEditorModeNotifications Class Reference

#include <ViewportEditorModeTrackerNotificationBus.h>

Inherits AZ::EBusTraits.

Public Types

using BusIdType = ViewportEditorModeTrackerInfo::IdType
 

Public Member Functions

 AZ_RTTI (ViewportEditorModeNotifications, "{9469DE39-6C21-423C-94FA-EF3A9616B14F}", AZ::EBusTraits)
 
virtual void OnEditorModeActivated (const ViewportEditorModesInterface &editorModeState, ViewportEditorMode mode)
 Notifies subscribers of the a given viewport to the activation of the specified editor mode.
 
virtual void OnEditorModeDeactivated (const ViewportEditorModesInterface &editorModeState, ViewportEditorMode mode)
 Notifies subscribers of the a given viewport to the deactivation of the specified editor mode.
 

Static Public Member Functions

static void Reflect (AZ::ReflectContext *context)
 

Static Public Attributes

static const AZ::EBusHandlerPolicy HandlerPolicy = AZ::EBusHandlerPolicy::Multiple
 
static const AZ::EBusAddressPolicy AddressPolicy = AZ::EBusAddressPolicy::ById
 

Detailed Description

Provides a bus to notify when the different editor modes are entered/exit.

Note
The editor modes are not discrete states but rather each progression of mode retain the active the parent mode that the new mode progressed from.

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