Inherits AZ::EBusTraits.
|
virtual void | PreExportEntity (AZ::Entity &, AZ::Entity &)=0 |
|
virtual void | PostExportEntity (AZ::Entity &, AZ::Entity &)=0 |
|
virtual void | AddDirtyEntity (AZ::EntityId target)=0 |
|
virtual int | RemoveDirtyEntity (AZ::EntityId target)=0 |
|
virtual void | ClearDirtyEntities ()=0 |
|
virtual bool | IsDuringUndoRedo ()=0 |
|
virtual void | UndoPressed ()=0 |
|
virtual void | RedoPressed ()=0 |
|
virtual void | FlushUndo ()=0 |
|
virtual void | FlushRedo ()=0 |
|
virtual void | MarkEntitySelected (AZ::EntityId entityId)=0 |
|
virtual void | MarkEntitiesSelected (const EntityIdList &entitiesToSelect)=0 |
|
virtual void | MarkEntityDeselected (AZ::EntityId entityId)=0 |
|
virtual void | MarkEntitiesDeselected (const EntityIdList &entitiesToDeselect)=0 |
|
virtual void | SetEntityHighlighted (AZ::EntityId entityId, bool highlighted)=0 |
|
virtual UndoSystem::URSequencePoint * | BeginUndoBatch (const char *label)=0 |
|
virtual UndoSystem::URSequencePoint * | ResumeUndoBatch (UndoSystem::URSequencePoint *batchId, const char *label)=0 |
|
virtual void | EndUndoBatch ()=0 |
|
virtual PreemptiveUndoCache * | GetUndoCache ()=0 |
|
virtual bool | IsEntityEditable (AZ::EntityId entityId)=0 |
|
virtual bool | AreEntitiesEditable (const EntityIdList &entityIds)=0 |
|
virtual void | CheckoutPressed ()=0 |
|
virtual SourceControlFileInfo | GetSceneSourceControlInfo ()=0 |
|
virtual bool | AreAnyEntitiesSelected ()=0 |
|
virtual int | GetSelectedEntitiesCount ()=0 |
|
virtual const EntityIdList & | GetSelectedEntities ()=0 |
|
virtual const EntityIdList & | GetHighlightedEntities ()=0 |
|
virtual void | SetSelectedEntities (const EntityIdList &selectedEntities)=0 |
|
virtual bool | IsSelectable (const AZ::EntityId &entityId)=0 |
|
virtual bool | IsSelected (const AZ::EntityId &entityId)=0 |
|
virtual bool | IsSliceRootEntity (const AZ::EntityId &entityId)=0 |
|
virtual UndoSystem::UndoStack * | GetUndoStack ()=0 |
|
virtual UndoSystem::URSequencePoint * | GetCurrentUndoBatch ()=0 |
|
virtual EntityIdSet | GatherEntitiesAndAllDescendents (const EntityIdList &inputEntities)=0 |
|
virtual AZ::EntityId | CreateNewEntity (AZ::EntityId parentId=AZ::EntityId())=0 |
| Create a new entity at a default position.
|
|
virtual AZ::EntityId | CreateNewEntityAtPosition (const AZ::Vector3 &pos, AZ::EntityId parentId=AZ::EntityId())=0 |
| Create a new entity at a specified position.
|
|
virtual AZ::EntityId | GetExistingEntity (AZ::u64 id)=0 |
| Gets an existing entity id from a known id.
|
|
virtual bool | EntityExists (AZ::EntityId id)=0 |
| Returns if an entity with the given id exists.
|
|
virtual void | DeleteSelected ()=0 |
|
virtual void | DeleteEntityById (AZ::EntityId entityId)=0 |
|
virtual void | DeleteEntities (const EntityIdList &entities)=0 |
|
virtual void | DeleteEntityAndAllDescendants (AZ::EntityId entityId)=0 |
|
virtual void | DeleteEntitiesAndAllDescendants (const EntityIdList &entities)=0 |
|
virtual bool | DetachEntities (const AZStd::vector< AZ::EntityId > &entitiesToDetach, AZStd::vector< AZStd::pair< AZ::EntityId, AZ::SliceComponent::EntityRestoreInfo > > &restoreInfos)=0 |
|
virtual bool | DetachSubsliceInstances (const AZ::SliceComponent::SliceInstanceEntityIdRemapList &subsliceRootList, AZStd::vector< AZStd::pair< AZ::EntityId, AZ::SliceComponent::EntityRestoreInfo > > &restoreInfos)=0 |
| Detaches the supplied subslices from their owning slice instance.
|
|
virtual bool | FindCommonRoot (const AzToolsFramework::EntityIdSet &entitiesToBeChecked, AZ::EntityId &commonRootEntityId, AzToolsFramework::EntityIdList *topLevelEntities=nullptr)=0 |
| Finds the Common root of an entity list; Also finds the top level entities in a given list of active entities (who share the common root) Example : A(B[D,E{F}],C),G (Letter is entity name, braces hold children) Sample run | entitiesToBeChecked:(B,D,E,F,C) commonRootEntityId: , topLevelEntities: <B,C>, return : <true> Sample run | entitiesToBeChecked:(E,C) commonRootEntityId:<InvalidEntityId> , topLevelEntities: <E,C>, return : <false> Sample run | entitiesToBeChecked:(A,G,B,E,C) commonRootEntityId:<InvalidEntityId> , topLevelEntities: <A,G>, return : <true> (True because both of the top level entities have no parent , which for us is the common parent) Sample run | entitiesToBeChecked:(A,D) commonRootEntityId:<InvalidEntityId> , topLevelEntities: <A,D>, return : <false>
|
|
virtual bool | FindCommonRootInactive (const AzToolsFramework::EntityList &entitiesToBeChecked, AZ::EntityId &commonRootEntityId, AzToolsFramework::EntityList *topLevelEntities=nullptr)=0 |
| Finds the Common root of an entity list; Also finds the top level entities in a given list of inactive entities (who share the common root) Example : A(B[D,E{F}],C),G (Letter is entity name, braces hold children) Sample run | entitiesToBeChecked:(B,D,E,F,C) commonRootEntityId: , topLevelEntities: <B,C>, return : <true> Sample run | entitiesToBeChecked:(E,C) commonRootEntityId:<InvalidEntityId> , topLevelEntities: <E,C>, return : <false> Sample run | entitiesToBeChecked:(A,G,B,E,C) commonRootEntityId:<InvalidEntityId> , topLevelEntities: <A,G>, return : <true> (True because both of the top level entities have no parent , which for us is the common parent) Sample run | entitiesToBeChecked:(A,D) commonRootEntityId:<InvalidEntityId> , topLevelEntities: <A,D>, return : <false>
|
|
virtual void | FindTopLevelEntityIdsInactive (const EntityIdList &entityIdsToCheck, EntityIdList &topLevelEntityIds)=0 |
|
virtual AZ::SliceComponent::SliceInstanceAddress | FindCommonSliceInstanceAddress (const EntityIdList &entityIds)=0 |
|
virtual AZ::EntityId | GetRootEntityIdOfSliceInstance (AZ::SliceComponent::SliceInstanceAddress sliceAddress)=0 |
|
virtual AZ::EntityId | GetCurrentLevelEntityId ()=0 |
|
virtual bool | RequestEditForFileBlocking (const char *assetPath, const char *progressMessage, const RequestEditProgressCallback &progressCallback)=0 |
|
virtual bool | CheckSourceControlConnectionAndRequestEditForFileBlocking (const char *assetPath, const char *progressMessage, const RequestEditProgressCallback &progressCallback)=0 |
|
virtual void | RequestEditForFile (const char *assetPath, RequestEditResultCallback resultCallback)=0 |
|
virtual void | CheckSourceControlConnectionAndRequestEditForFile (const char *assetPath, RequestEditResultCallback resultCallback)=0 |
|
virtual void | EnterEditorIsolationMode ()=0 |
|
virtual void | ExitEditorIsolationMode ()=0 |
|
virtual bool | IsEditorInIsolationMode ()=0 |
|
virtual void | CreateAndAddEntityFromComponentTags (const AZStd::vector< AZ::Crc32 > &requiredTags, const char *entityName)=0 |
|
virtual ResolveToolPathOutcome | ResolveConfigToolsPath (const char *toolApplicationName) const =0 |
|
virtual void | RunRedoSeparately (UndoSystem::URSequencePoint *redoCommand)=0 |
|
Bus used to make general requests to the ToolsApplication.
virtual bool AzToolsFramework::ToolsApplicationRequests::FindCommonRoot |
( |
const AzToolsFramework::EntityIdSet & |
entitiesToBeChecked, |
|
|
AZ::EntityId & |
commonRootEntityId, |
|
|
AzToolsFramework::EntityIdList * |
topLevelEntities = nullptr |
|
) |
| |
|
pure virtual |
Finds the Common root of an entity list; Also finds the top level entities in a given list of active entities (who share the common root) Example : A(B[D,E{F}],C),G (Letter is entity name, braces hold children) Sample run | entitiesToBeChecked:(B,D,E,F,C) commonRootEntityId: , topLevelEntities: <B,C>, return : <true> Sample run | entitiesToBeChecked:(E,C) commonRootEntityId:<InvalidEntityId> , topLevelEntities: <E,C>, return : <false> Sample run | entitiesToBeChecked:(A,G,B,E,C) commonRootEntityId:<InvalidEntityId> , topLevelEntities: <A,G>, return : <true> (True because both of the top level entities have no parent , which for us is the common parent) Sample run | entitiesToBeChecked:(A,D) commonRootEntityId:<InvalidEntityId> , topLevelEntities: <A,D>, return : <false>
- Parameters
-
entitiesToBeChecked | List of entities whose parentage is to be found |
commonRootEntityId | [Out] Entity id of the common root for the entitiesToBeChecked |
topLevelEntities | [Out] List of entities at the top of the hierarchy in entitiesToBeChecked |
- Returns
- boolean value indicating whether entities have a common root or not IF True commonRootEntityId is the common root of all rootLevelEntities IF False commonRootEntityId is an invalid entity id NOTE: Requires that the entities to be checked are live, they must be active and available via TransformBus. entitiesToBeChecked cannot contain nested entities with gaps, see Sample run 4
virtual bool AzToolsFramework::ToolsApplicationRequests::FindCommonRootInactive |
( |
const AzToolsFramework::EntityList & |
entitiesToBeChecked, |
|
|
AZ::EntityId & |
commonRootEntityId, |
|
|
AzToolsFramework::EntityList * |
topLevelEntities = nullptr |
|
) |
| |
|
pure virtual |
Finds the Common root of an entity list; Also finds the top level entities in a given list of inactive entities (who share the common root) Example : A(B[D,E{F}],C),G (Letter is entity name, braces hold children) Sample run | entitiesToBeChecked:(B,D,E,F,C) commonRootEntityId: , topLevelEntities: <B,C>, return : <true> Sample run | entitiesToBeChecked:(E,C) commonRootEntityId:<InvalidEntityId> , topLevelEntities: <E,C>, return : <false> Sample run | entitiesToBeChecked:(A,G,B,E,C) commonRootEntityId:<InvalidEntityId> , topLevelEntities: <A,G>, return : <true> (True because both of the top level entities have no parent , which for us is the common parent) Sample run | entitiesToBeChecked:(A,D) commonRootEntityId:<InvalidEntityId> , topLevelEntities: <A,D>, return : <false>
- Parameters
-
entitiesToBeChecked | List of entities whose parentage is to be found |
commonRootEntityId | [Out] Entity id of the common root for the entitiesToBeChecked |
topLevelEntities | [Out] List of entities at the top of the hierarchy in entitiesToBeChecked |
- Returns
- boolean value indicating whether entities have a common root or not IF True commonRootEntityId is the common root of all rootLevelEntities IF False commonRootEntityId is an invalid entity id NOTE: Does not require that the entities to be checked are live, they could be temp or asset entities. entitiesToBeChecked cannot contain nested entities with gaps, see Sample run 4