AzToolsFramework::FocusModeInterface Class Reference

#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

Detailed Description

FocusModeInterface Interface to handle the Editor Focus Mode.

Member Function Documentation

ClearFocusRoot()

virtual void AzToolsFramework::FocusModeInterface::ClearFocusRoot ( AzFramework::EntityContextId  entityContextId )

pure virtual

Clears the Editor focus, allowing the user to select the whole level again.

Implemented in AzToolsFramework::FocusModeSystemComponent.

GetFocusedEntities()

virtual const EntityIdList & AzToolsFramework::FocusModeInterface::GetFocusedEntities ( AzFramework::EntityContextId  entityContextId )

pure virtual

Returns a list of the ids of all the entities that are descendants of the focus root.

Implemented in AzToolsFramework::FocusModeSystemComponent.

GetFocusRoot()

virtual AZ::EntityId AzToolsFramework::FocusModeInterface::GetFocusRoot ( AzFramework::EntityContextId  entityContextId )

pure virtual

Returns the entity id of the root of the current Editor focus.

Returns

The entity id of the root of the Editor focus, or an invalid entity id if no focus is set.

Implemented in AzToolsFramework::FocusModeSystemComponent.

IsFocusRoot()

virtual bool AzToolsFramework::FocusModeInterface::IsFocusRoot ( AZ::EntityId  entityId ) const

pure virtual

Verifies if the entityId provided matches with the current focus root.

Returns

True if the entity provided is the focus root, false otherwise.

Implemented in AzToolsFramework::FocusModeSystemComponent.

IsInFocusSubTree()

virtual bool AzToolsFramework::FocusModeInterface::IsInFocusSubTree ( AZ::EntityId  entityId ) const

pure virtual

Returns whether the entity id provided is part of the focused sub-tree.

Implemented in AzToolsFramework::FocusModeSystemComponent.

SetFocusRoot()

virtual void AzToolsFramework::FocusModeInterface::SetFocusRoot ( AZ::EntityId  entityId )

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.

Parameters

entityId

The entityId that will become the new focus root.

Implemented in AzToolsFramework::FocusModeSystemComponent.

---

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

• Code/Framework/AzToolsFramework/AzToolsFramework/FocusMode/FocusModeInterface.h