Menu
Lumberyard
C++ API Reference (Version 1.10)

AZ::TransformNotification Class Reference

Interface for AZ::TransformNotificationBus, which is the EBus that dispatches transform changes to listeners. More...

Inherits AZ::ComponentBus.

Public Member Functions

virtual ~TransformNotification ()
 A destructor. More...
 
virtual void OnTransformChanged (const Transform &, const Transform &)
 Signals that the local or world transform of the entity changed. More...
 
virtual void OnParentChanged (EntityId oldParent, EntityId newParent)
 Signals that the parent of the entity changed. More...
 
virtual void OnChildAdded (EntityId child)
 Signals that a child was added to the entity. More...
 
virtual void OnChildRemoved (EntityId child)
 Signals that a child was removed from the entity. More...
 
- Public Member Functions inherited from AZ::ComponentBus
virtual ~ComponentBus ()=default
 Destroys a component bus. More...
 

Additional Inherited Members

- Public Types inherited from AZ::ComponentBus
typedef EntityId BusIdType
 Overrides the default AZ::EBusTraits ID type so that entity IDs are used to access the addresses of the bus. More...
 
- Public Types inherited from AZ::EBusTraits
using AllocatorType = AZStd::allocator
 Allocator used by the EBus. More...
 
using BusIdType = NullBusId
 The type of ID that is used to address the EBus. More...
 
using BusIdOrderCompare = NullBusIdCompare
 Sorting function for EBus address IDs. More...
 
using BusHandlerOrderCompare = BusHandlerCompareDefault
 Sorting function for EBus event handlers. More...
 
using MutexType = NullMutex
 Locking primitive that is used when connecting handlers to the EBus or executing events. More...
 
using EventQueueMutexType = NullMutex
 Locking primitive that is used when adding and removing events from the queue. More...
 
template<class Bus >
using ConnectionPolicy = EBusConnectionPolicy< Bus >
 Enables custom logic to run when a handler connects or disconnects from the EBus. More...
 
template<class Context >
using StoragePolicy = EBusEnvironmentStoragePolicy< Context >
 Specifies where EBus data is stored. More...
 
template<class Bus >
using RouterPolicy = EBusRouterPolicy< Bus >
 Controls the flow of EBus events. More...
 
- Static Public Attributes inherited from AZ::ComponentBus
static const EBusAddressPolicy AddressPolicy
 Overrides the default AZ::EBusTraits address policy so that the bus has multiple addresses at which to receive messages. More...
 
- Static Public Attributes inherited from AZ::EBusTraits
static const EBusHandlerPolicy HandlerPolicy
 Defines how many handlers can connect to an address on the EBus and the order in which handlers at each address receive events. More...
 
static const EBusAddressPolicy AddressPolicy
 Defines how many addresses exist on the EBus. More...
 
static const bool EnableEventQueue
 Specifies whether the EBus supports an event queue. More...
 
- Protected Member Functions inherited from AZ::EBusTraits
 ~EBusTraits ()=default
 A destructor. More...
 

Detailed Description

Interface for AZ::TransformNotificationBus, which is the EBus that dispatches transform changes to listeners.

Constructor & Destructor Documentation

◆ ~TransformNotification()

virtual AZ::TransformNotification::~TransformNotification ( )
inlinevirtual

A destructor.

Member Function Documentation

◆ OnChildAdded()

virtual void AZ::TransformNotification::OnChildAdded ( EntityId  child)
inlinevirtual

Signals that a child was added to the entity.

Parameters
childThe entity ID of the added child.

◆ OnChildRemoved()

virtual void AZ::TransformNotification::OnChildRemoved ( EntityId  child)
inlinevirtual

Signals that a child was removed from the entity.

Parameters
childThe entity ID of the removed child.

◆ OnParentChanged()

virtual void AZ::TransformNotification::OnParentChanged ( EntityId  oldParent,
EntityId  newParent 
)
inlinevirtual

Signals that the parent of the entity changed.

To find if an entity ID is valid, use AZ::EntityId::IsValid().

Parameters
oldParentThe entity ID of the old parent. The entity ID is invalid if there was no old parent.
newParentThe entity ID of the new parent. The entity ID is invalid if there is no new parent.

◆ OnTransformChanged()

virtual void AZ::TransformNotification::OnTransformChanged ( const Transform &  ,
const Transform &   
)
inlinevirtual

Signals that the local or world transform of the entity changed.

Parameters
localA reference to the new local transform of the entity.
worldA reference to the new world transform of the entity.

The documentation for this class was generated from the following file:
  • C:/lumberyard-root/dev/Code/Framework/AzCore/AzCore/Component/TransformBus.h