#include <EntityPropertyEditorRequestsBus.h>
Inherits AZ::EBusTraits.
|
using | VisitComponentEditorsCallback = AZStd::function< bool(const ComponentEditor *)> |
|
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
◆ 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
-
selectedEntityIds | the 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
-
selectedEntityIds | the 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
-
callback | The callback that iterates over all the component editors within an EntityPropertyEditor. |
The documentation for this class was generated from the following file:
- Code/Framework/AzToolsFramework/AzToolsFramework/API/EntityPropertyEditorRequestsBus.h