#include <TransformBus.h>
Inherits AZ::ComponentBus.
- Deprecated:
- Use AZ::Event notifications on the main transform interface. Interface for AZ::TransformNotificationBus, which is the EBus that dispatches transform changes to listeners.
◆ CanParentChange()
virtual void AZ::TransformNotification::CanParentChange |
( |
bool & |
parentCanChange, |
|
|
EntityId |
oldParent, |
|
|
EntityId |
newParent |
|
) |
| |
|
inlinevirtual |
Called right before a parent change, to allow listeners to prevent the entity's parent from changing.
- Parameters
-
parentCanChange | A reference used to track if the parent can change. A result parameter is used instead of a return value because this is a multi-handler. |
oldParent | The entityId of the old parent. The entityId is invalid if there was no old parent. |
newParent | The entityId of the new parent. The entityId is invalid if there is no new parent. |
◆ OnChildAdded()
virtual void AZ::TransformNotification::OnChildAdded |
( |
EntityId |
child | ) |
|
|
inlinevirtual |
Signals that a child was added to the entity.
- Parameters
-
child | The entityId of the added child. |
◆ OnChildRemoved()
virtual void AZ::TransformNotification::OnChildRemoved |
( |
EntityId |
child | ) |
|
|
inlinevirtual |
Signals that a child was removed from the entity.
- Parameters
-
child | The entityId 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 entityId is valid, use AZ::EntityId::IsValid().
- Parameters
-
oldParent | The entityId of the old parent. The entityId is invalid if there was no old parent. |
newParent | The entityId of the new parent. The entityId is invalid if there is no new parent. |
◆ OnParentTransformWillChange()
Signals that the transform of the parent of the entity is about to change. Some components will need adjusting before this happens. To find if an entityId is valid, use AZ::EntityId::IsValid().
- Parameters
-
oldTransform | The transform of the old parent. |
newTransform | The transform of the new parent.
|
◆ OnStaticChanged()
virtual void AZ::TransformNotification::OnStaticChanged |
( |
bool |
| ) |
|
|
inlinevirtual |
Signals that the static flag on the transform has changed. This should only be needed during editing.
- Parameters
-
isStatic | A boolean that indicates whether the transform is static or not. |
◆ OnTransformChanged()
virtual void AZ::TransformNotification::OnTransformChanged |
( |
const Transform & |
, |
|
|
const Transform & |
|
|
) |
| |
|
inlinevirtual |
Signals that the local or world transform of the entity changed.
- Parameters
-
local | A reference to the new local transform of the entity. |
world | A reference to the new world transform of the entity. |
The documentation for this class was generated from the following file: