Bus to control the overall editor ComponentMode state.
More...
#include <EditorComponentModeBus.h>
Inherits AZ::EBusTraits.
Bus to control the overall editor ComponentMode state.
◆ AddedToComponentMode()
virtual bool AzToolsFramework::ComponentModeFramework::ComponentModeSystemRequests::AddedToComponentMode |
( |
const AZ::EntityComponentIdPair & |
entityComponentIdPair, |
|
|
const AZ::Uuid & |
componentType |
|
) |
| |
|
pure virtual |
Is this Component type on this entity currently participating in the Editor ComponentMode.
◆ AddSelectedComponentModesOfType()
virtual void AzToolsFramework::ComponentModeFramework::ComponentModeSystemRequests::AddSelectedComponentModesOfType |
( |
const AZ::Uuid & |
componentType | ) |
|
|
pure virtual |
If the user has a multiple selection where each entity in the selection has the same Component on it, move all Components into ComponentMode.
◆ HasMultipleComponentTypes()
virtual bool AzToolsFramework::ComponentModeFramework::ComponentModeSystemRequests::HasMultipleComponentTypes |
( |
| ) |
|
|
pure virtual |
Return if there are more than one Component type in Component Mode. There may be two dependent Component Modes that are not 'active' at the same time but can be switched between in a Component Mode session (e.g. Tube and Spline Components).
◆ Refresh()
virtual void AzToolsFramework::ComponentModeFramework::ComponentModeSystemRequests::Refresh |
( |
const AZ::EntityComponentIdPair & |
entityComponentIdPair | ) |
|
|
pure virtual |
If something about the Component/Entity has changed, Refresh can be used to update Manipulator positions etc.
◆ SelectActiveComponentMode()
virtual bool AzToolsFramework::ComponentModeFramework::ComponentModeSystemRequests::SelectActiveComponentMode |
( |
const AZ::Uuid & |
componentType | ) |
|
|
pure virtual |
Pick a specific ComponentMode for a Component (by directly selecting a Component in the EntityInspector - it is now 'selected'). Return true if the mode actually changed - the mode will not change if the componentType requested is the same as the current one.
◆ SelectNextActiveComponentMode()
virtual bool AzToolsFramework::ComponentModeFramework::ComponentModeSystemRequests::SelectNextActiveComponentMode |
( |
| ) |
|
|
pure virtual |
Move to the next active ComponentMode so the Actions for that mode become available (it is now 'selected'). Return true if the mode actually changed - the mode will not change if the componentType requested is the same as the current one.
◆ SelectPreviousActiveComponentMode()
virtual bool AzToolsFramework::ComponentModeFramework::ComponentModeSystemRequests::SelectPreviousActiveComponentMode |
( |
| ) |
|
|
pure virtual |
Move to the previous active ComponentMode so the Actions for that mode become available (it is now 'selected'). Return true if the mode actually changed - the mode will not change if the componentType requested is the same as the current one.
The documentation for this class was generated from the following file:
- Code/Framework/AzToolsFramework/AzToolsFramework/ComponentMode/EditorComponentModeBus.h