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.
Public Types | Public Member Functions | List of all members
AzToolsFramework::ToolsApplicationEvents Class Reference

#include <ToolsApplicationAPI.h>

Inherits AZ::EBusTraits.

Public Types

using Bus = AZ::EBus< ToolsApplicationEvents >
 

Public Member Functions

virtual void BeforeEntitySelectionChanged ()
 
virtual void AfterEntitySelectionChanged (const EntityIdList &, const EntityIdList &)
 
virtual void BeforeEntityHighlightingChanged ()
 
virtual void AfterEntityHighlightingChanged ()
 
virtual void EntityParentChanged (AZ::EntityId, AZ::EntityId, AZ::EntityId)
 
virtual void EntityDeregistered (AZ::EntityId)
 
virtual void EntityRegistered (AZ::EntityId)
 
virtual void EntityCreatedAsChild (AZ::EntityId, AZ::EntityId)
 
virtual void BeforeUndoRedo ()
 
virtual void AfterUndoRedo ()
 
virtual void OnBeginUndo (const char *)
 
virtual void OnEndUndo (const char *, bool)
 
virtual void InvalidatePropertyDisplay (PropertyModificationRefreshLevel)
 
virtual void GotSceneSourceControlStatus (SourceControlFileInfo &)
 
virtual void PerformActionsBasedOnSceneStatus (bool, bool)
 
virtual void ShowAssetInBrowser (AZStd::string)
 
virtual void OnEnterEditorIsolationMode ()
 
virtual void OnExitEditorIsolationMode ()
 
virtual void SetEntityInstantiationPosition (const AZ::EntityId &, const AZ::EntityId &)
 
virtual void ClearEntityInstantiationPosition ()
 
virtual void OnSaveLevel ()
 

Detailed Description

Bus owned by the ToolsApplication. Listen for general ToolsApplication events.

Member Function Documentation

◆ AfterEntityHighlightingChanged()

virtual void AzToolsFramework::ToolsApplicationEvents::AfterEntityHighlightingChanged ( )
inlinevirtual

Fired after committing a change in entity highlighting set.

◆ AfterEntitySelectionChanged()

virtual void AzToolsFramework::ToolsApplicationEvents::AfterEntitySelectionChanged ( const EntityIdList &  ,
const EntityIdList &   
)
inlinevirtual

Fired after committing a change in entity selection set.

Parameters
EntityIdListthe list of newly selected entity Ids
EntityIdListthe list of newly deselected entity Ids

◆ AfterUndoRedo()

virtual void AzToolsFramework::ToolsApplicationEvents::AfterUndoRedo ( )
inlinevirtual

Fired just after applying a requested undo or redo operation. Note that prefab propagation will not have occurred at this point, so data may not yet be updated. Consider listening to OnPrefabInstancePropagationEnd on PrefabPublicNotificationBus instead.

◆ BeforeEntityHighlightingChanged()

virtual void AzToolsFramework::ToolsApplicationEvents::BeforeEntityHighlightingChanged ( )
inlinevirtual

Fired before committing a change in entity highlighting set.

◆ BeforeEntitySelectionChanged()

virtual void AzToolsFramework::ToolsApplicationEvents::BeforeEntitySelectionChanged ( )
inlinevirtual

Fired prior to committing a change in entity selection set.

◆ BeforeUndoRedo()

virtual void AzToolsFramework::ToolsApplicationEvents::BeforeUndoRedo ( )
inlinevirtual

Fired just prior to applying a requested undo or redo operation.

◆ ClearEntityInstantiationPosition()

virtual void AzToolsFramework::ToolsApplicationEvents::ClearEntityInstantiationPosition ( )
inlinevirtual

Clears the position of the next entity to be instantiated, used by the EditorEntityModel if entity instantiation fails after SetEntityInstantiationPosition is called. This makes sure entities created after the initial event don't end up with a parent out of sync in the outliner and transform component.

◆ EntityCreatedAsChild()

virtual void AzToolsFramework::ToolsApplicationEvents::EntityCreatedAsChild ( AZ::EntityId  ,
AZ::EntityId   
)
inlinevirtual

Broadcast when the user has created an entity as a child of another entity. This event is broadcast after the entity has been created and activated and all relevant transform component information has been set.

Parameters
entityId- The Id of the new entity
parentId- The Id of the new entity's parent

◆ EntityDeregistered()

virtual void AzToolsFramework::ToolsApplicationEvents::EntityDeregistered ( AZ::EntityId  )
inlinevirtual

Fired when a given entity has been unregistered from the application.

Parameters
entityId- The Id of the subject entity.

◆ EntityParentChanged()

virtual void AzToolsFramework::ToolsApplicationEvents::EntityParentChanged ( AZ::EntityId  ,
AZ::EntityId  ,
AZ::EntityId   
)
inlinevirtual

Fired when an entity's transform parent has changed.

◆ EntityRegistered()

virtual void AzToolsFramework::ToolsApplicationEvents::EntityRegistered ( AZ::EntityId  )
inlinevirtual

Fired when a given entity has been registered with the application.

Parameters
entityId- The Id of the subject entity.

◆ GotSceneSourceControlStatus()

virtual void AzToolsFramework::ToolsApplicationEvents::GotSceneSourceControlStatus ( SourceControlFileInfo &  )
inlinevirtual

Process source control status for the specified file.

◆ InvalidatePropertyDisplay()

virtual void AzToolsFramework::ToolsApplicationEvents::InvalidatePropertyDisplay ( PropertyModificationRefreshLevel  )
inlinevirtual

Notify property UI to refresh the property tree.

◆ OnBeginUndo()

virtual void AzToolsFramework::ToolsApplicationEvents::OnBeginUndo ( const char *  )
inlinevirtual

Fired when a new undo batch has been started.

Parameters
label- description of the batch.

◆ OnEndUndo()

virtual void AzToolsFramework::ToolsApplicationEvents::OnEndUndo ( const char *  ,
bool   
)
inlinevirtual

Fired when an undo batch has been ended..

Parameters
label- description of the batch.
changed- did anything change during the batch

◆ OnEnterEditorIsolationMode()

virtual void AzToolsFramework::ToolsApplicationEvents::OnEnterEditorIsolationMode ( )
inlinevirtual

Event sent when the editor is set to Isolation Mode where only selected entities are visible

◆ OnExitEditorIsolationMode()

virtual void AzToolsFramework::ToolsApplicationEvents::OnExitEditorIsolationMode ( )
inlinevirtual

Event sent when the editor quits Isolation Mode

◆ OnSaveLevel()

virtual void AzToolsFramework::ToolsApplicationEvents::OnSaveLevel ( )
inlinevirtual

Called when the level is saved.

◆ PerformActionsBasedOnSceneStatus()

virtual void AzToolsFramework::ToolsApplicationEvents::PerformActionsBasedOnSceneStatus ( bool  ,
bool   
)
inlinevirtual

Process scene status.

◆ SetEntityInstantiationPosition()

virtual void AzToolsFramework::ToolsApplicationEvents::SetEntityInstantiationPosition ( const AZ::EntityId &  ,
const AZ::EntityId &   
)
inlinevirtual

Sets the position of the next entity to be instantiated, used by the EditorEntityModel when dragging from asset browser

◆ ShowAssetInBrowser()

virtual void AzToolsFramework::ToolsApplicationEvents::ShowAssetInBrowser ( AZStd::string  )
inlinevirtual

Highlight the specified asset in the asset browser.

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