#include <FocusModeInterface.h>
Inherited by AzToolsFramework::FocusModeSystemComponent [private]
.
Public Member Functions | |
AZ_RTTI (FocusModeInterface, "{437243B0-F86B-422F-B7B8-4A21CC000702}") | |
virtual void | SetFocusRoot (AZ::EntityId entityId)=0 |
virtual void | ClearFocusRoot (AzFramework::EntityContextId entityContextId)=0 |
Clears the Editor focus, allowing the user to select the whole level again. | |
virtual AZ::EntityId | GetFocusRoot (AzFramework::EntityContextId entityContextId)=0 |
virtual const EntityIdList & | GetFocusedEntities (AzFramework::EntityContextId entityContextId)=0 |
Returns a list of the ids of all the entities that are descendants of the focus root. | |
virtual bool | IsInFocusSubTree (AZ::EntityId entityId) const =0 |
Returns whether the entity id provided is part of the focused sub-tree. | |
virtual bool | IsFocusRoot (AZ::EntityId entityId) const =0 |
FocusModeInterface Interface to handle the Editor Focus Mode.
|
pure virtual |
Clears the Editor focus, allowing the user to select the whole level again.
Implemented in AzToolsFramework::FocusModeSystemComponent.
|
pure virtual |
Returns a list of the ids of all the entities that are descendants of the focus root.
Implemented in AzToolsFramework::FocusModeSystemComponent.
|
pure virtual |
Returns the entity id of the root of the current Editor focus.
Implemented in AzToolsFramework::FocusModeSystemComponent.
|
pure virtual |
Verifies if the entityId provided matches with the current focus root.
Implemented in AzToolsFramework::FocusModeSystemComponent.
|
pure virtual |
Returns whether the entity id provided is part of the focused sub-tree.
Implemented in AzToolsFramework::FocusModeSystemComponent.
|
pure virtual |
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. |
Implemented in AzToolsFramework::FocusModeSystemComponent.