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.
Public Types | Public Member Functions | List of all members
AzToolsFramework::EntityPropertyEditorRequests Class Referenceabstract

#include <EntityPropertyEditorRequestsBus.h>

Inherits AZ::EBusTraits.

Public Types

using VisitComponentEditorsCallback = AZStd::function< bool(const ComponentEditor *)>
 

Public Member Functions

virtual void GetSelectedAndPinnedEntities (EntityIdList &selectedEntityIds)=0
 
virtual void GetSelectedEntities (EntityIdList &selectedEntityIds)=0
 
virtual void SetNewComponentId (AZ::ComponentId componentId)=0
 
virtual void VisitComponentEditors (const VisitComponentEditorsCallback &callback) const =0
 

Detailed Description

Requests to be made of all EntityPropertyEditorRequests Beware, there may be more than one EntityPropertyEditor that can respond Broadcast should be used for accessing these functions

Member Function Documentation

◆ GetSelectedAndPinnedEntities()

virtual void AzToolsFramework::EntityPropertyEditorRequests::GetSelectedAndPinnedEntities ( EntityIdList &  selectedEntityIds)
pure virtual

Allows a component to get the list of selected entities or if in a pinned window, the list of entities in that window

Parameters
selectedEntityIdsthe return vector holding the entities required

◆ GetSelectedEntities()

virtual void AzToolsFramework::EntityPropertyEditorRequests::GetSelectedEntities ( EntityIdList &  selectedEntityIds)
pure virtual

Allows a component to get the list of selected entities

Parameters
selectedEntityIdsthe return vector holding the entities required

◆ SetNewComponentId()

virtual void AzToolsFramework::EntityPropertyEditorRequests::SetNewComponentId ( AZ::ComponentId  componentId)
pure virtual

Explicitly sets a component as having been the most recently added. This means that the next time the UI refreshes, that component will be ensured to be visible.

◆ VisitComponentEditors()

virtual void AzToolsFramework::EntityPropertyEditorRequests::VisitComponentEditors ( const VisitComponentEditorsCallback &  callback) const
pure virtual

Visits the component editors in an EntityPropertyEditor via a callback.

Parameters
callbackThe callback that iterates over all the component editors within an EntityPropertyEditor.
The documentation for this class was generated from the following file: