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.
AzToolsFramework::ToolsApplication Class Reference

Inherits AzFramework::Application, ToolsApplicationRequests::Bus::Handler, and AzToolsFramework::Prefab::PrefabPublicNotificationBus::Handler.

Inherited by UnitTest::ToolsTestApplication.

Classes

struct  PathAssetEntry
 

Public Member Functions

 AZ_RTTI (ToolsApplication, "{2895561E-BE90-4CC3-8370-DD46FCF74C01}", AzFramework::Application)
 
 AZ_CLASS_ALLOCATOR (ToolsApplication, AZ::SystemAllocator)
 
 ToolsApplication (int *argc=nullptr, char ***argv=nullptr)
 
void Stop () override
 
void CreateReflectionManager () override
 
void Reflect (AZ::ReflectContext *context) override
 
AZ::ComponentTypeList GetRequiredSystemComponents () const override
 
AzToolsFramework::ToolsApplicationRequests::ResolveToolPathOutcome ResolveConfigToolsPath (const char *toolApplicationName) const override
 
void Start (const Descriptor &descriptor, const StartupParameters &startupParameters=StartupParameters()) override
 

Protected Member Functions

void StartCommon (AZ::Entity *systemEntity) override
 
void CreateStaticModules (AZStd::vector< AZ::Module * > &outModules) override
 
bool AddEntity (AZ::Entity *entity) override
 
bool RemoveEntity (AZ::Entity *entity) override
 
const char * GetCurrentConfigurationName () const override
 
void SetSettingsRegistrySpecializations (AZ::SettingsRegistryInterface::Specializations &specializations) override
 
void QueryApplicationType (AZ::ApplicationTypeQuery &appType) const override
 
void PreExportEntity (AZ::Entity &source, AZ::Entity &target) override
 
void PostExportEntity (AZ::Entity &source, AZ::Entity &target) override
 
void MarkEntitySelected (AZ::EntityId entityId) override
 
void MarkEntitiesSelected (const EntityIdList &entitiesToSelect) override
 
void MarkEntityDeselected (AZ::EntityId entityId) override
 
void MarkEntitiesDeselected (const EntityIdList &entitiesToDeselect) override
 
void SetEntityHighlighted (AZ::EntityId entityId, bool highlighted) override
 
void AddDirtyEntity (AZ::EntityId entityId) override
 
int RemoveDirtyEntity (AZ::EntityId entityId) override
 
void ClearDirtyEntities () override
 
bool IsDuringUndoRedo () override
 
void UndoPressed () override
 
void RedoPressed () override
 
void FlushUndo () override
 
void FlushRedo () override
 
UndoSystem::URSequencePointBeginUndoBatch (const char *label) override
 
UndoSystem::URSequencePointResumeUndoBatch (UndoSystem::URSequencePoint *token, const char *label) override
 
void EndUndoBatch () override
 
bool IsEntityEditable (AZ::EntityId entityId) override
 
bool AreEntitiesEditable (const EntityIdList &entityIds) override
 
void CheckoutPressed () override
 
SourceControlFileInfo GetSceneSourceControlInfo () override
 
bool AreAnyEntitiesSelected () override
 
int GetSelectedEntitiesCount () override
 
const EntityIdList & GetSelectedEntities () override
 
const EntityIdList & GetHighlightedEntities () override
 
void SetSelectedEntities (const EntityIdList &selectedEntities) override
 
bool IsSelectable (const AZ::EntityId &entityId) override
 
bool IsSelected (const AZ::EntityId &entityId) override
 
bool IsSliceRootEntity (const AZ::EntityId &entityId) override
 
UndoSystem::UndoStackGetUndoStack () override
 
UndoSystem::URSequencePointGetCurrentUndoBatch () override
 
PreemptiveUndoCacheGetUndoCache () override
 
EntityIdSet GatherEntitiesAndAllDescendents (const EntityIdList &inputEntities) override
 
AZ::EntityId CreateNewEntity (AZ::EntityId parentId=AZ::EntityId()) override
 
AZ::EntityId CreateNewEntityAtPosition (const AZ::Vector3 &pos, AZ::EntityId parentId=AZ::EntityId()) override
 
AZ::EntityId GetExistingEntity (AZ::u64 id) override
 
bool EntityExists (AZ::EntityId id) override
 
void DeleteSelected () override
 
void DeleteEntityById (AZ::EntityId entityId) override
 
void DeleteEntities (const EntityIdList &entities) override
 
void DeleteEntityAndAllDescendants (AZ::EntityId entityId) override
 
void DeleteEntitiesAndAllDescendants (const EntityIdList &entities) override
 
bool DetachEntities (const AZStd::vector< AZ::EntityId > &entitiesToDetach, AZStd::vector< AZStd::pair< AZ::EntityId, AZ::SliceComponent::EntityRestoreInfo > > &restoreInfos) override
 
bool DetachSubsliceInstances (const AZ::SliceComponent::SliceInstanceEntityIdRemapList &subsliceRootList, AZStd::vector< AZStd::pair< AZ::EntityId, AZ::SliceComponent::EntityRestoreInfo > > &restoreInfos) override
 
bool FindCommonRoot (const EntityIdSet &entitiesToBeChecked, AZ::EntityId &commonRootEntityId, EntityIdList *topLevelEntities=nullptr) override
 
bool FindCommonRootInactive (const EntityList &entitiesToBeChecked, AZ::EntityId &commonRootEntityId, EntityList *topLevelEntities=nullptr) override
 
void FindTopLevelEntityIdsInactive (const EntityIdList &entityIdsToCheck, EntityIdList &topLevelEntityIds) override
 
AZ::SliceComponent::SliceInstanceAddress FindCommonSliceInstanceAddress (const EntityIdList &entityIds) override
 
AZ::EntityId GetRootEntityIdOfSliceInstance (AZ::SliceComponent::SliceInstanceAddress sliceAddress) override
 
AZ::EntityId GetCurrentLevelEntityId () override
 
bool RequestEditForFileBlocking (const char *assetPath, const char *progressMessage, const RequestEditProgressCallback &progressCallback) override
 
bool CheckSourceControlConnectionAndRequestEditForFileBlocking (const char *assetPath, const char *progressMessage, const RequestEditProgressCallback &progressCallback) override
 
void RequestEditForFile (const char *assetPath, RequestEditResultCallback resultCallback) override
 
void CheckSourceControlConnectionAndRequestEditForFile (const char *assetPath, RequestEditResultCallback resultCallback) override
 
void EnterEditorIsolationMode () override
 
void ExitEditorIsolationMode () override
 
bool IsEditorInIsolationMode () override
 
void CreateAndAddEntityFromComponentTags (const AZStd::vector< AZ::Crc32 > &requiredTags, const char *entityName) override
 
void RunRedoSeparately (UndoSystem::URSequencePoint *redoCommand) override
 
void OnPrefabInstancePropagationBegin () override
 
void OnPrefabInstancePropagationEnd () override
 
void CreateUndosForDirtyEntities ()
 
void ConsistencyCheckUndoCache ()
 

Protected Attributes

AZ::Aabb m_selectionBounds
 
EntityIdList m_selectedEntities
 
EntityIdList m_highlightedEntities
 
UndoSystem::UndoStackm_undoStack
 
UndoSystem::URSequencePointm_currentBatchUndo
 
AZStd::unordered_set< AZ::EntityId > m_dirtyEntities
 
PreemptiveUndoCache m_undoCache
 
bool m_isDuringUndoRedo
 
bool m_isInIsolationMode
 
EntityIdSet m_isolatedEntityIdSet
 
bool m_freezeSelectionUpdates = false
 
EditorEntityAPIm_editorEntityAPI = nullptr
 
EditorEntityManager m_editorEntityManager
 
UndoSystem::UndoCacheInterfacem_undoCacheInterface = nullptr
 

Member Function Documentation

◆ DetachSubsliceInstances()

bool AzToolsFramework::ToolsApplication::DetachSubsliceInstances ( const AZ::SliceComponent::SliceInstanceEntityIdRemapList &  subsliceRootList,
AZStd::vector< AZStd::pair< AZ::EntityId, AZ::SliceComponent::EntityRestoreInfo > > &  restoreInfos 
)
overrideprotected

Detaches the supplied subslices from their owning slice instance

Parameters
subsliceRootListA list of SliceInstanceAddresses paired with a mapping from the sub slices asset entityId's to the owing slice instance's live entityIds See SliceComponent::GetMappingBetweenSubsliceAndSourceInstanceEntityIds for a helper to acquire this mapping
restoreInfosA list of EntityRestoreInfo's to be filled with information on how to restore the entities in the subslices back to their original state before this operation
Returns
Returns true on operation success, false otherwise

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