System Component to handle the Editor Focus Mode system. More...
#include <FocusModeSystemComponent.h>
Inherits AZ::Component, AzToolsFramework::FocusModeInterface, EditorEntityInfoNotificationBus::Handler, and AzToolsFramework::Prefab::PrefabPublicNotificationBus::Handler.
Public Member Functions | |
AZ_COMPONENT (FocusModeSystemComponent, "{6CE522FE-2057-4794-BD05-61E04BD8EA30}") | |
void | Init () override |
void | Activate () override |
void | Deactivate () override |
void | SetFocusRoot (AZ::EntityId entityId) override |
void | ClearFocusRoot (AzFramework::EntityContextId entityContextId) override |
Clears the Editor focus, allowing the user to select the whole level again. | |
AZ::EntityId | GetFocusRoot (AzFramework::EntityContextId entityContextId) override |
bool | IsFocusRoot (AZ::EntityId entityId) const override |
const EntityIdList & | GetFocusedEntities (AzFramework::EntityContextId entityContextId) override |
Returns a list of the ids of all the entities that are descendants of the focus root. | |
bool | IsInFocusSubTree (AZ::EntityId entityId) const override |
Returns whether the entity id provided is part of the focused sub-tree. | |
void | OnEntityInfoUpdatedAddChildEnd (AZ::EntityId parentId, AZ::EntityId childId) override |
void | OnEntityInfoUpdatedRemoveChildEnd (AZ::EntityId parentId, AZ::EntityId childId) override |
void | OnPrefabInstancePropagationEnd () override |
System Component to handle the Editor Focus Mode system.
|
overridevirtual |
Clears the Editor focus, allowing the user to select the whole level again.
Implements AzToolsFramework::FocusModeInterface.
|
overridevirtual |
Returns a list of the ids of all the entities that are descendants of the focus root.
Implements AzToolsFramework::FocusModeInterface.
|
overridevirtual |
Returns the entity id of the root of the current Editor focus.
Implements AzToolsFramework::FocusModeInterface.
|
overridevirtual |
Verifies if the entityId provided matches with the current focus root.
Implements AzToolsFramework::FocusModeInterface.
|
overridevirtual |
Returns whether the entity id provided is part of the focused sub-tree.
Implements AzToolsFramework::FocusModeInterface.
|
overridevirtual |
Sets the root entity the Editor should focus on. The Editor will only allow the user to select entities that are descendants of the EntityId provided.
entityId | The entityId that will become the new focus root. |
Implements AzToolsFramework::FocusModeInterface.