Open 3D Engine AzCore API Reference  2205.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 | Public Attributes | List of all members
AZ::TransformConfig Class Reference

Component configuration for the transform component. More...

#include <TransformBus.h>

Inherits AZ::ComponentConfig.

Public Types

enum  ParentActivationTransformMode : u32 { ParentActivationTransformMode::MaintainOriginalRelativeTransform, ParentActivationTransformMode::MaintainCurrentWorldTransform }
 

Public Member Functions

 AZ_RTTI (TransformConfig, "{B3AAB26D-D075-4E2B-9653-9527EE363DF8}", ComponentConfig)
 
 AZ_CLASS_ALLOCATOR (TransformConfig, SystemAllocator, 0)
 
 TransformConfig ()=default
 
 TransformConfig (const Transform &transform)
 
- Public Member Functions inherited from AZ::ComponentConfig
 AZ_CLASS_ALLOCATOR (ComponentConfig, SystemAllocator, 0)
 
 AZ_RTTI (ComponentConfig, "{0A7929DF-2932-40EA-B2B3-79BC1C3490D0}")
 

Public Attributes

Transform m_worldTransform = Transform::Identity()
 
Transform m_localTransform = Transform::Identity()
 
EntityId m_parentId
 
ParentActivationTransformMode m_parentActivationTransformMode = ParentActivationTransformMode::MaintainOriginalRelativeTransform
 
bool m_netSyncEnabled = true
 
InterpolationMode m_interpolatePosition = InterpolationMode::NoInterpolation
 
InterpolationMode m_interpolateRotation = InterpolationMode::NoInterpolation
 
bool m_isStatic = false
 

Detailed Description

Component configuration for the transform component.

Member Enumeration Documentation

◆ ParentActivationTransformMode

Behavior when a parent entity activates. A parent may activate before or after its children have activated.

Enumerator
MaintainOriginalRelativeTransform 

Child will snap to originally-configured parent-relative transform when parent is activated.

MaintainCurrentWorldTransform 

Child will still follow parent, but will maintain its current world transform when parent is activated.

Constructor & Destructor Documentation

◆ TransformConfig() [1/2]

AZ::TransformConfig::TransformConfig ( )
default

Constructor with all default values. Transform is positioned at (0,0,0) with no rotation and scale of 1.

◆ TransformConfig() [2/2]

AZ::TransformConfig::TransformConfig ( const Transform transform)
inlineexplicit

Constructor which sets a 3D transform. Sets both the local and world transform to the same value.

Parameters
transformThe entity's position, rotation, and scale in 3D.

Member Data Documentation

◆ m_interpolatePosition

InterpolationMode AZ::TransformConfig::m_interpolatePosition = InterpolationMode::NoInterpolation
Deprecated:
Behavior for smoothing of position between network updates.

◆ m_interpolateRotation

InterpolationMode AZ::TransformConfig::m_interpolateRotation = InterpolationMode::NoInterpolation
Deprecated:
Behavior for smoothing of rotation between network updates.

◆ m_isStatic

bool AZ::TransformConfig::m_isStatic = false

Whether the transform is static. A static transform will never move.

◆ m_localTransform

Transform AZ::TransformConfig::m_localTransform = Transform::Identity()

Local 3D transform, as an offset from the parent entity. This property is used to offset the entity from its parent's world transform. Local transform is ignored if no parent is assigned.

◆ m_netSyncEnabled

bool AZ::TransformConfig::m_netSyncEnabled = true
Deprecated:
Whether the transform can be synced over the network.

◆ m_parentActivationTransformMode

Behavior when the parent entity activates. A parent entity is not guaranteed to activate before its children. If a parent entity activates after its child, this property determines whether the entity maintains its current world transform or snaps to maintain the local transform as an offset from the parent.

◆ m_parentId

EntityId AZ::TransformConfig::m_parentId

ID of parent entity. When the parent entity moves, this transform will follow.

◆ m_worldTransform

Transform AZ::TransformConfig::m_worldTransform = Transform::Identity()

World 3D transform. This property is used if no parent is assigned, or if the assigned parent entity cannot be found. This property is ignored if the assigned parent is present.


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