#include <ToolsApplicationAPI.h>

Inherits AZ::EBusTraits.

Public Types
using	Bus = AZ::EBus< ToolsApplicationRequests >

using	RequestEditProgressCallback = AZStd::function< void(int &current, int &max)>

using	RequestEditResultCallback = AZStd::function< void(bool success)>

using	ResolveToolPathOutcome = AZ::Outcome< AZStd::string, AZStd::string >

Public Member Functions
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

Static Public Attributes
static const AZ::EBusHandlerPolicy	HandlerPolicy = AZ::EBusHandlerPolicy::Single

Detailed Description

Bus used to make general requests to the ToolsApplication.

Member Typedef Documentation

◆ RequestEditProgressCallback

using AzToolsFramework::ToolsApplicationRequests::RequestEditProgressCallback = AZStd::function<void(int& current, int& max)>

Prepares a file for editability. Interacts with source-control if the asset is not already writable, in a blocking fashion.

Parameters

path	full path of the asset to be made editable.
progressMessage	progress message to display during checkout operation.
progressCallback	user callback for retrieving progress information, provide RequestEditProgressCallback() if no progress reporting is required.

Returns: boolean value indicating if the file is writable after the operation.

◆ RequestEditResultCallback

using AzToolsFramework::ToolsApplicationRequests::RequestEditResultCallback = AZStd::function<void(bool success)>

Prepares a file for editability. Interacts with source-control if the asset is not already writable.

Parameters

path	full path of the asset to be made editable.
resultCallback	user callback to be notified when source control operation is complete. Callback will be invoked with a true success value if the file was made writable. If the file is already writable at the time the function is called, resultCallback(true) will be invoked immediately.

◆ ResolveToolPathOutcome

using AzToolsFramework::ToolsApplicationRequests::ResolveToolPathOutcome = AZ::Outcome<AZStd::string, AZStd::string>

Attempts to resolve a path to an executable using the current executable's folder

Member Function Documentation

◆ AddDirtyEntity()

virtual void AzToolsFramework::ToolsApplicationRequests::AddDirtyEntity ( AZ::EntityId target )

pure virtual

Marks an entity as dirty.

Parameters

target - The Id of the entity to mark as dirty.

◆ AreAnyEntitiesSelected()

virtual bool AzToolsFramework::ToolsApplicationRequests::AreAnyEntitiesSelected ( )

pure virtual

Returns true if any entities are selected, false if no entities are selected.

◆ BeginUndoBatch()

virtual UndoSystem::URSequencePoint * AzToolsFramework::ToolsApplicationRequests::BeginUndoBatch ( const char * label )

pure virtual

Starts a new undo batch.

Parameters

label - description of the operation.

Returns: a handle for the new batch, which can be used with ResumeUndoBatch().

◆ CheckoutPressed()

virtual void AzToolsFramework::ToolsApplicationRequests::CheckoutPressed ( )

pure virtual

Notifies the tools application that the user wishes to checkout selected entities.

◆ CheckSourceControlConnectionAndRequestEditForFile()

virtual void AzToolsFramework::ToolsApplicationRequests::CheckSourceControlConnectionAndRequestEditForFile	(	const char *	assetPath,
		RequestEditResultCallback	resultCallback
	)

pure virtual

Same as RequestEditForFile, but intentionally fails operation when source control is offline We add this function as convenience to side step the behavior of removing write protection when LocalFileSCComponent is used

Parameters

path	full path of the asset to be made editable.
resultCallback	user callback to be notified when source control operation is complete. Callback will be invoked with a true success value if the file was made writable. If the file is already writable at the time the function is called, resultCallback(true) will be invoked immediately.

◆ CheckSourceControlConnectionAndRequestEditForFileBlocking()

virtual bool AzToolsFramework::ToolsApplicationRequests::CheckSourceControlConnectionAndRequestEditForFileBlocking	(	const char *	assetPath,
		const char *	progressMessage,
		const RequestEditProgressCallback &	progressCallback
	)

pure virtual

Same as RequestEditForBlocking, but intentionally fails operation when source control is offline We add this function as convenience to side step the behavior of removing write protection when LocalFileSCComponent is used

Parameters

path	full path of the asset to be made editable.
progressMessage	progress message to display during checkout operation.
progressCallback	user callback for retrieving progress information, provide RequestEditProgressCallback() if no progress reporting is required.

Returns: boolean value indicating if the file is writable after the operation.

◆ ClearDirtyEntities()

virtual void AzToolsFramework::ToolsApplicationRequests::ClearDirtyEntities ( )

pure virtual

Clears the dirty entity set.

◆ CreateAndAddEntityFromComponentTags()

virtual void AzToolsFramework::ToolsApplicationRequests::CreateAndAddEntityFromComponentTags	(	const AZStd::vector< AZ::Crc32 > &	requiredTags,
		const char *	entityName
	)

pure virtual

Creates and adds a new entity to the tools application from components which match at least one of the requiredTags The tag matching occurs on AZ::Edit::SystemComponentTags attribute from the reflected class data in the serialization context

◆ DeleteEntities()

virtual void AzToolsFramework::ToolsApplicationRequests::DeleteEntities ( const EntityIdList & entities )

pure virtual

Deletes all specified entities.

◆ DeleteEntitiesAndAllDescendants()

virtual void AzToolsFramework::ToolsApplicationRequests::DeleteEntitiesAndAllDescendants ( const EntityIdList & entities )

pure virtual

Deletes all entities in the provided list, as well as their transform descendants.

◆ DeleteEntityAndAllDescendants()

virtual void AzToolsFramework::ToolsApplicationRequests::DeleteEntityAndAllDescendants ( AZ::EntityId entityId )

pure virtual

Deletes the specified entity, as well as any transform descendants.

◆ DeleteEntityById()

virtual void AzToolsFramework::ToolsApplicationRequests::DeleteEntityById ( AZ::EntityId entityId )

pure virtual

Deletes the specified entity.

◆ DeleteSelected()

virtual void AzToolsFramework::ToolsApplicationRequests::DeleteSelected ( )

pure virtual

Delete all currently-selected entities.

◆ DetachSubsliceInstances()

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

pure virtual

Detaches the supplied subslices from their owning slice instance.

Parameters

subsliceRootList	A 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
restoreInfos	A 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

◆ EndUndoBatch()

virtual void AzToolsFramework::ToolsApplicationRequests::EndUndoBatch ( )

pure virtual

Completes the current undo batch. It's still possible to resume the batch as long as it's still the most recent one.

◆ EnterEditorIsolationMode()

virtual void AzToolsFramework::ToolsApplicationRequests::EnterEditorIsolationMode ( )

pure virtual

Enter the Isolation Mode and hide entities that are not selected.

◆ ExitEditorIsolationMode()

virtual void AzToolsFramework::ToolsApplicationRequests::ExitEditorIsolationMode ( )

pure virtual

Exit the Isolation Mode and stop hiding entities.

◆ FindCommonRoot()

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

◆ FindCommonRootInactive()

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

◆ FindCommonSliceInstanceAddress()

virtual AZ::SliceComponent::SliceInstanceAddress AzToolsFramework::ToolsApplicationRequests::FindCommonSliceInstanceAddress ( const EntityIdList & entityIds )

pure virtual

Check every entity to see if they all belong to the same slice instance, if so return that slice instance address, otherwise return null.

Parameters

entityIds An group of EntityIds.

Returns: The slice instance address if all of entityIds belongs to the same slice instance, otherwise null.

◆ FindTopLevelEntityIdsInactive()

virtual void AzToolsFramework::ToolsApplicationRequests::FindTopLevelEntityIdsInactive	(	const EntityIdList &	entityIdsToCheck,
		EntityIdList &	topLevelEntityIds
	)

pure virtual

Find all top level entities in the transform hierarchy of a list of entities, whether they are active or not. Different from the function FindCommonRootInactive, this function returns all top level entities even if entityIdsToCheck contains gaps in its transform hierarchy, at the cost of performance.

Parameters

	entityIdsToCheck	A list of entity ids.
[out]	A	list of entity ids of top level entities.

◆ FlushRedo()

virtual void AzToolsFramework::ToolsApplicationRequests::FlushRedo ( )

pure virtual

Notifies the application that the redo stack needs to be sliced (removed)

◆ FlushUndo()

virtual void AzToolsFramework::ToolsApplicationRequests::FlushUndo ( )

pure virtual

Notifies the application that the undo stack needs to be flushed

◆ GatherEntitiesAndAllDescendents()

virtual EntityIdSet AzToolsFramework::ToolsApplicationRequests::GatherEntitiesAndAllDescendents ( const EntityIdList & inputEntities )

pure virtual

Given a list of input entity Ids, gather their children and all descendants as well.

Parameters

inputEntities list of entities whose children should be gathered.

Returns: set of entity Ids including input entities and their descendants.

◆ GetCurrentLevelEntityId()

virtual AZ::EntityId AzToolsFramework::ToolsApplicationRequests::GetCurrentLevelEntityId ( )

pure virtual

Get the id of the level that is loaded currently in the editor. This is a "singleton" type of EntityId that represents the current level. It can be used to add level components to it.

◆ GetCurrentUndoBatch()

virtual UndoSystem::URSequencePoint * AzToolsFramework::ToolsApplicationRequests::GetCurrentUndoBatch ( )

pure virtual

Retrieves the current undo batch.

Returns: a pointer to the top of the undo stack.

◆ GetHighlightedEntities()

virtual const EntityIdList & AzToolsFramework::ToolsApplicationRequests::GetHighlightedEntities ( )

pure virtual

Retrieves the set of highlighted (but not selected) entities.

Returns: a list of entity Ids.

◆ GetRootEntityIdOfSliceInstance()

virtual AZ::EntityId AzToolsFramework::ToolsApplicationRequests::GetRootEntityIdOfSliceInstance ( AZ::SliceComponent::SliceInstanceAddress sliceAddress )

pure virtual

Get the id of the root entity of a slice instance. This function ignores any unpushed change made to the transform hierarchy of the entities in the slice instance in question.

Parameters

sliceAddress The address of a slice instance.

Returns: The root entity id.

◆ GetSceneSourceControlInfo()

virtual SourceControlFileInfo AzToolsFramework::ToolsApplicationRequests::GetSceneSourceControlInfo ( )

pure virtual

Returns source control info for the current world/scene. Not yet implemented in ToolsApplication.

◆ GetSelectedEntities()

virtual const EntityIdList & AzToolsFramework::ToolsApplicationRequests::GetSelectedEntities ( )

pure virtual

Retrieves the set of selected entities.

Returns: a list of entity Ids.

◆ GetSelectedEntitiesCount()

virtual int AzToolsFramework::ToolsApplicationRequests::GetSelectedEntitiesCount ( )

pure virtual

Returns the number of selected entities.

◆ GetUndoCache()

virtual PreemptiveUndoCache * AzToolsFramework::ToolsApplicationRequests::GetUndoCache ( )

pure virtual

Retrieves the preemptive undo cache for the application.

◆ GetUndoStack()

virtual UndoSystem::UndoStack * AzToolsFramework::ToolsApplicationRequests::GetUndoStack ( )

pure virtual

Retrieves the undo stack.

Returns: a pointer to the undo stack.

◆ IsDuringUndoRedo()

virtual bool AzToolsFramework::ToolsApplicationRequests::IsDuringUndoRedo ( )

pure virtual

Returns: true if an undo/redo operation is in progress.

◆ IsEditorInIsolationMode()

virtual bool AzToolsFramework::ToolsApplicationRequests::IsEditorInIsolationMode ( )

pure virtual

Request if the editor is currently in Isolation Mode /return boolean indicating if the editor is currently in Isolation Mode

◆ IsEntityEditable()

virtual bool AzToolsFramework::ToolsApplicationRequests::IsEntityEditable ( AZ::EntityId entityId )

pure virtual

Returns: true if the entity (or entities) can be edited/modified.

◆ IsSelectable()

virtual bool AzToolsFramework::ToolsApplicationRequests::IsSelectable ( const AZ::EntityId & entityId )

pure virtual

Functionality removed, function call left in to prevent compile issues if anybody's using it.

Parameters

entityId

◆ IsSelected()

virtual bool AzToolsFramework::ToolsApplicationRequests::IsSelected ( const AZ::EntityId & entityId )

pure virtual

Returns true if the specified entity is currently selected.

Parameters

entityId

◆ IsSliceRootEntity()

virtual bool AzToolsFramework::ToolsApplicationRequests::IsSliceRootEntity ( const AZ::EntityId & entityId )

pure virtual

Returns true if the specified entity is a slice root.

Parameters

entityId

◆ MarkEntitiesDeselected()

virtual void AzToolsFramework::ToolsApplicationRequests::MarkEntitiesDeselected ( const EntityIdList & entitiesToDeselect )

pure virtual

Notifies the application that the user intends to deselect a list of entities. This should be used any time multiple entities are deselected, as this is a large performance improvement over calling MarkEntityDeselected more than once.

Parameters

entitiesToDeselect - the vector of newly deselected entities

◆ MarkEntitiesSelected()

virtual void AzToolsFramework::ToolsApplicationRequests::MarkEntitiesSelected ( const EntityIdList & entitiesToSelect )

pure virtual

Notifies the application that the user intends to select a list of entities. This should be used any time multiple entities are selected, as this is a large performance improvement over calling MarkEntitySelected more than once.

Parameters

entitiesToSelect - the vector of newly selected entities

◆ MarkEntityDeselected()

virtual void AzToolsFramework::ToolsApplicationRequests::MarkEntityDeselected ( AZ::EntityId entityId )

pure virtual

Notifies the application that the user intends to deselect an entity.

Parameters

entityId - the Id of the now deselected entity.

◆ MarkEntitySelected()

virtual void AzToolsFramework::ToolsApplicationRequests::MarkEntitySelected ( AZ::EntityId entityId )

pure virtual

Notifies the application that the user intends to select an entity.

Parameters

entityId - the Id of the newly selected entity.

◆ PostExportEntity()

virtual void AzToolsFramework::ToolsApplicationRequests::PostExportEntity	(	AZ::Entity &	,
		AZ::Entity &
	)

pure virtual

Handles post-export tasks for an entity.

◆ PreExportEntity()

virtual void AzToolsFramework::ToolsApplicationRequests::PreExportEntity	(	AZ::Entity &	,
		AZ::Entity &
	)

pure virtual

Handles pre-export tasks for an entity, such as generating runtime components on the target.

◆ RedoPressed()

virtual void AzToolsFramework::ToolsApplicationRequests::RedoPressed ( )

pure virtual

Notifies the application the user intends to reapply the last redo-able operation.

◆ RemoveDirtyEntity()

virtual int AzToolsFramework::ToolsApplicationRequests::RemoveDirtyEntity ( AZ::EntityId target )

pure virtual

Removes an entity from the dirty entity set.

Parameters

target - The Id of the entity to remove

Returns: 1 if target EntityId was removed successfully, otherwise 0

◆ ResumeUndoBatch()

virtual UndoSystem::URSequencePoint * AzToolsFramework::ToolsApplicationRequests::ResumeUndoBatch	(	UndoSystem::URSequencePoint *	batchId,
		const char *	label
	)

pure virtual

Attempts to continue adding to an existing undo batch command. If the specified batchId is on the top of the stack, it is used, otherwise a new handle is returned.

Parameters

batchId	- the Id of the undo batch (returned from BeginUndoBatch).
label	- description of the operation.

Returns: a handle for the batch.

◆ RunRedoSeparately()

virtual void AzToolsFramework::ToolsApplicationRequests::RunRedoSeparately ( UndoSystem::URSequencePoint * redoCommand )

pure virtual

Open 3D Engine Internal use only.

Run a specific redo command separate from the undo/redo system. In many cases before a modification on an entity takes place, it is first packaged into undo/redo commands. Running the modification's redo command separate from the undo/redo system simulates its execution, and avoids some code duplication.

◆ SetEntityHighlighted()

virtual void AzToolsFramework::ToolsApplicationRequests::SetEntityHighlighted	(	AZ::EntityId	entityId,
		bool	highlighted
	)

pure virtual

Notifies the application that editor has highlighted an entity, or removed a highlight. This is used for mouse-hover behavior in Sandbox.

◆ SetSelectedEntities()

virtual void AzToolsFramework::ToolsApplicationRequests::SetSelectedEntities ( const EntityIdList & selectedEntities )

pure virtual

Explicitly specifies the set of selected entities.

Parameters

a	list of entity Ids.

◆ UndoPressed()

virtual void AzToolsFramework::ToolsApplicationRequests::UndoPressed ( )

pure virtual

Notifies the application the user intends to undo the last undo-able operation.

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

Code/Framework/AzToolsFramework/AzToolsFramework/API/ToolsApplicationAPI.h

Public Types

Public Member Functions

Static Public Attributes

Detailed Description

Member Typedef Documentation

◆ RequestEditProgressCallback

◆ RequestEditResultCallback

◆ ResolveToolPathOutcome

Member Function Documentation

◆ AddDirtyEntity()

◆ AreAnyEntitiesSelected()

◆ BeginUndoBatch()

◆ CheckoutPressed()

◆ CheckSourceControlConnectionAndRequestEditForFile()

◆ CheckSourceControlConnectionAndRequestEditForFileBlocking()

◆ ClearDirtyEntities()

◆ CreateAndAddEntityFromComponentTags()

◆ DeleteEntities()

◆ DeleteEntitiesAndAllDescendants()

◆ DeleteEntityAndAllDescendants()

◆ DeleteEntityById()

◆ DeleteSelected()

◆ DetachSubsliceInstances()

◆ EndUndoBatch()

◆ EnterEditorIsolationMode()

◆ ExitEditorIsolationMode()

◆ FindCommonRoot()

◆ FindCommonRootInactive()

◆ FindCommonSliceInstanceAddress()

◆ FindTopLevelEntityIdsInactive()

◆ FlushRedo()

◆ FlushUndo()

◆ GatherEntitiesAndAllDescendents()

◆ GetCurrentLevelEntityId()

◆ GetCurrentUndoBatch()

◆ GetHighlightedEntities()

◆ GetRootEntityIdOfSliceInstance()

◆ GetSceneSourceControlInfo()

◆ GetSelectedEntities()

◆ GetSelectedEntitiesCount()

◆ GetUndoCache()

◆ GetUndoStack()

◆ IsDuringUndoRedo()

◆ IsEditorInIsolationMode()

◆ IsEntityEditable()

◆ IsSelectable()

◆ IsSelected()

◆ IsSliceRootEntity()

◆ MarkEntitiesDeselected()

◆ MarkEntitiesSelected()

◆ MarkEntityDeselected()

◆ MarkEntitySelected()

◆ PostExportEntity()

◆ PreExportEntity()

◆ RedoPressed()

◆ RemoveDirtyEntity()

◆ ResumeUndoBatch()

◆ RunRedoSeparately()

◆ SetEntityHighlighted()

◆ SetSelectedEntities()

◆ UndoPressed()