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.
AzToolsFramework::Etcs Namespace Reference

Classes

struct  PivotOrientationResult
 

Functions

PivotOrientationResult CalculatePivotOrientation (AZ::EntityId entityId, ReferenceFrame referenceFrame)
 
template<typename EntityIdMap >
PivotOrientationResult CalculatePivotOrientationForEntityIds (const EntityIdMap &entityIdMap, const ReferenceFrame referenceFrame)
 Calculate the orientation for a group of entities based on the incoming reference frame.
 
template<typename EntityIdMap >
PivotOrientationResult CalculateSelectionPivotOrientation (const EntityIdMap &entityIdMap, const OptionalFrame &pivotOverrideFrame, const ReferenceFrame referenceFrame)
 
void SetEntityWorldTranslation (AZ::EntityId entityId, const AZ::Vector3 &worldTranslation, bool &internal)
 
void SetEntityLocalTranslation (AZ::EntityId entityId, const AZ::Vector3 &localTranslation, bool &internal)
 
void SetEntityWorldTransform (AZ::EntityId entityId, const AZ::Transform &worldTransform, bool &internal)
 
void SetEntityLocalScale (AZ::EntityId entityId, float localScale, bool &internal)
 
void SetEntityLocalRotation (AZ::EntityId entityId, const AZ::Vector3 &localRotation, bool &internal)
 
void SetEntityLocalRotation (AZ::EntityId entityId, const AZ::Quaternion &localRotation, bool &internal)
 

Detailed Description

The Etcs (EntityTransformComponentSelection) namespace contains functions and data used exclusively by the EditorTransformComponentSelection type. Functions in this namespace are exposed to facilitate testing and should not be used outside of EditorTransformComponentSelection or EditorTransformComponentSelectionTests.

Function Documentation

◆ CalculatePivotOrientation()

PivotOrientationResult AzToolsFramework::Etcs::CalculatePivotOrientation ( AZ::EntityId  entityId,
ReferenceFrame  referenceFrame 
)

Calculate the orientation for an individual entity based on the incoming reference frame. Note: If the entity is in a hierarchy the Parent reference frame will return the orientation of the parent.

◆ CalculateSelectionPivotOrientation()

template<typename EntityIdMap >
PivotOrientationResult AzToolsFramework::Etcs::CalculateSelectionPivotOrientation ( const EntityIdMap &  entityIdMap,
const OptionalFrame pivotOverrideFrame,
const ReferenceFrame  referenceFrame 
)

Calculate the orientation for a group of entities based on the incoming reference frame with possible pivot override.