AZ::Render::FocusedEntityState Class Reference

Class for the Focused Entity editor state effect. More...

#include <FocusedEntityState.h>

Inherits AZ::Render::EditorStateBase, and AzToolsFramework::ViewportEditorModeNotificationsBus::Handler.

Public Member Functions
void	OnEditorModeActivated (const AzToolsFramework::ViewportEditorModesInterface &editorModeState, AzToolsFramework::ViewportEditorMode mode) override
void	OnEditorModeDeactivated (const AzToolsFramework::ViewportEditorModesInterface &editorModeState, AzToolsFramework::ViewportEditorMode mode) override
bool	IsEnabled () const override
	Returns true of this editor mode state is to be enabled, otherwise false.
AzToolsFramework::EntityIdList	GetMaskedEntities () const override
	Returns the entities that should be rendered to the entity mask for this editor state.
Public Member Functions inherited from AZ::Render::EditorStateBase
	EditorStateBase (EditorState editorState, const AZStd::string &stateName, const PassNameList &childPassNameList, const AZStd::string &maskDrawList)
	EditorStateBase (EditorState editorState, const AZStd::string &stateName, const PassNameList &childPassNameList)
	Delegate constructor for editor state parents that use the default entity mask.
const AZStd::string &	GetStateName () const
	Returns the name of this editor state.
const Name &	GetEntityMaskDrawList () const
	Returns the name of the entity mask draw list used this editor state.
const PassNameList &	GetChildPassNameList () const
Name	GetPassTemplateName () const
	Returns the pass template name for this editor state effect pass.
Name	GetPassName () const
	Returns the pass name of this editor state effect pass.
void	AddParentPassForPipeline (const Name &pipelineName, RPI::Ptr< RPI::Pass > parentPass)
	Adds the pass class pointer for this pass for the specified pipeline.
void	RemoveParentPassForPipeline (const Name &pipelineName)
	Removes the pass class pointer for this pass for the specified pipeline.
void	UpdatePassDataForPipelines ()
	Calls the update method for each pipeline this editor state effect pass is part of.
void	SetEnabled (bool enabled) override
Name	GetGeneratedChildPassName (size_t index) const
	Returns the generated name for the specified child pass.

Additional Inherited Members
Protected Member Functions inherited from AZ::Render::EditorStateBase
template<class ChildPass >
ChildPass *	FindChildPass (RPI::ParentPass *parentPass, size_t index) const
	Helper function for finding the specified child effect pass for this editor state effect pass.
virtual void	UpdatePassData (RPI::ParentPass *)
	Opportunity for the editor mode state to initialize any child pass object state.

Detailed Description

Class for the Focused Entity editor state effect.

---

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

• Gems/AtomLyIntegration/EditorModeFeedback/Code/Source/Pass/State/FocusedEntityState.h