UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
UE::Geometry::TQuaternion< RealType > Struct Template Reference

#include <Quaternion.h>

Public Member Functions

 TQuaternion ()
 
 TQuaternion (RealType X, RealType Y, RealType Z, RealType W)
 
 TQuaternion (const RealType *Values)
 
PRAGMA_DISABLE_DEPRECATION_WARNINGS TQuaternion (const TQuaternion &Copy)=default
 
TQuaternion & operator= (const TQuaternion &Copy)=default
 
template<typename RealType2 >
PRAGMA_ENABLE_DEPRECATION_WARNINGS TQuaternion (const TQuaternion< RealType2 > &Copy)
 
 TQuaternion (const TVector< RealType > &Axis, RealType Angle, bool bAngleIsDegrees)
 
 TQuaternion (const TVector< RealType > &From, const TVector< RealType > &To)
 
 TQuaternion (const TQuaternion< RealType > &From, const TQuaternion< RealType > &To, RealType InterpT)
 
 TQuaternion (const TMatrix3< RealType > &RotationMatrix)
 
void SetAxisAngleD (const TVector< RealType > &Axis, RealType AngleDeg)
 
void SetAxisAngleR (const TVector< RealType > &Axis, RealType AngleRad)
 
void SetFromTo (const TVector< RealType > &From, const TVector< RealType > &To)
 
void SetToSlerp (TQuaternion< RealType > From, TQuaternion< RealType > To, RealType InterpT)
 
void SetFromRotationMatrix (const TMatrix3< RealType > &RotationMatrix)
 
RealType & operator[] (int i)
 
const RealType & operator[] (int i) const
 
bool EpsilonEqual (const TQuaternion< RealType > &Other, RealType Tolerance=TMathUtil< RealType >::ZeroTolerance) const
 
bool IsIdentity (RealType Tolerance=TMathUtil< RealType >::ZeroTolerance) const
 
RealType Length () const
 
RealType SquaredLength () const
 
TVector< RealType > AxisX () const
 
TVector< RealType > AxisY () const
 
TVector< RealType > AxisZ () const
 
void GetAxes (TVector< RealType > &X, TVector< RealType > &Y, TVector< RealType > &Z) const
 
RealType Normalize (const RealType epsilon=0)
 
TQuaternion< RealType > Normalized (const RealType epsilon=0) const
 
RealType Dot (const TQuaternion< RealType > &Other) const
 
TQuaternion< RealType > Inverse () const
 
TVector< RealType > InverseMultiply (const TVector< RealType > &Other) const
 
TMatrix3< RealType > ToRotationMatrix () const
 
constexpr TQuaternion< RealType > operator- () const
 
 operator FQuat4f () const
 
 operator FQuat4d () const
 
 operator FRotator () const
 
 TQuaternion (const FQuat4f &Quat)
 
 TQuaternion (const FQuat4d &Quat)
 
 TQuaternion (const FRotator &Rotator)
 
 operator UE::Math::TVector4< RealType > () const
 
template<typename RealType2 >
 TQuaternion (const TQuaternion< RealType2 > &Copy)
 

Static Public Member Functions

static TQuaternion< RealType > Zero ()
 
static TQuaternion< RealType > Identity ()
 

Public Attributes

union { 
 
   struct { 
 
      RealType   X 
 
      RealType   Y 
 
      RealType   Z 
 
      RealType   W 
 
   }  
 
   RealType   XYZW [4] 
 
};  
 

Constructor & Destructor Documentation

◆ TQuaternion() [1/13]

template<typename RealType >
UE::Geometry::TQuaternion< RealType >::TQuaternion ( )

◆ TQuaternion() [2/13]

template<typename RealType >
UE::Geometry::TQuaternion< RealType >::TQuaternion ( RealType  X,
RealType  Y,
RealType  Z,
RealType  W 
)

◆ TQuaternion() [3/13]

template<typename RealType >
UE::Geometry::TQuaternion< RealType >::TQuaternion ( const RealType *  Values)
explicit

◆ TQuaternion() [4/13]

template<typename RealType >
PRAGMA_DISABLE_DEPRECATION_WARNINGS UE::Geometry::TQuaternion< RealType >::TQuaternion ( const TQuaternion< RealType > &  Copy)
default

◆ TQuaternion() [5/13]

template<typename RealType >
template<typename RealType2 >
PRAGMA_ENABLE_DEPRECATION_WARNINGS UE::Geometry::TQuaternion< RealType >::TQuaternion ( const TQuaternion< RealType2 > &  Copy)
explicit

◆ TQuaternion() [6/13]

template<typename RealType >
UE::Geometry::TQuaternion< RealType >::TQuaternion ( const TVector< RealType > &  Axis,
RealType  Angle,
bool  bAngleIsDegrees 
)

◆ TQuaternion() [7/13]

template<typename RealType >
UE::Geometry::TQuaternion< RealType >::TQuaternion ( const TVector< RealType > &  From,
const TVector< RealType > &  To 
)

◆ TQuaternion() [8/13]

template<typename RealType >
UE::Geometry::TQuaternion< RealType >::TQuaternion ( const TQuaternion< RealType > &  From,
const TQuaternion< RealType > &  To,
RealType  InterpT 
)

◆ TQuaternion() [9/13]

template<typename RealType >
UE::Geometry::TQuaternion< RealType >::TQuaternion ( const TMatrix3< RealType > &  RotationMatrix)

◆ TQuaternion() [10/13]

template<typename RealType >
UE::Geometry::TQuaternion< RealType >::TQuaternion ( const FQuat4f &  Quat)
inlineexplicit

◆ TQuaternion() [11/13]

template<typename RealType >
UE::Geometry::TQuaternion< RealType >::TQuaternion ( const FQuat4d &  Quat)
inlineexplicit

◆ TQuaternion() [12/13]

template<typename RealType >
UE::Geometry::TQuaternion< RealType >::TQuaternion ( const FRotator &  Rotator)
inlineexplicit

◆ TQuaternion() [13/13]

template<typename RealType >
template<typename RealType2 >
UE::Geometry::TQuaternion< RealType >::TQuaternion ( const TQuaternion< RealType2 > &  Copy)

Member Function Documentation

◆ AxisX()

template<typename RealType >
TVector< RealType > UE::Geometry::TQuaternion< RealType >::AxisX ( ) const

◆ AxisY()

template<typename RealType >
TVector< RealType > UE::Geometry::TQuaternion< RealType >::AxisY ( ) const

◆ AxisZ()

template<typename RealType >
TVector< RealType > UE::Geometry::TQuaternion< RealType >::AxisZ ( ) const

◆ Dot()

template<typename RealType >
RealType UE::Geometry::TQuaternion< RealType >::Dot ( const TQuaternion< RealType > &  Other) const

◆ EpsilonEqual()

template<typename RealType >
bool UE::Geometry::TQuaternion< RealType >::EpsilonEqual ( const TQuaternion< RealType > &  Other,
RealType  Tolerance = TMathUtil<RealType>::ZeroTolerance 
) const

◆ GetAxes()

template<typename RealType >
void UE::Geometry::TQuaternion< RealType >::GetAxes ( TVector< RealType > &  X,
TVector< RealType > &  Y,
TVector< RealType > &  Z 
) const

◆ Identity()

template<typename RealType >
static TQuaternion< RealType > UE::Geometry::TQuaternion< RealType >::Identity ( )
inlinestatic

◆ Inverse()

template<typename RealType >
TQuaternion< RealType > UE::Geometry::TQuaternion< RealType >::Inverse ( ) const

◆ InverseMultiply()

template<typename RealType >
TVector< RealType > UE::Geometry::TQuaternion< RealType >::InverseMultiply ( const TVector< RealType > &  Other) const

◆ IsIdentity()

template<typename RealType >
bool UE::Geometry::TQuaternion< RealType >::IsIdentity ( RealType  Tolerance = TMathUtil<RealType>::ZeroTolerance) const
inline

◆ Length()

template<typename RealType >
RealType UE::Geometry::TQuaternion< RealType >::Length ( ) const
inline

◆ Normalize()

template<typename RealType >
RealType UE::Geometry::TQuaternion< RealType >::Normalize ( const RealType  epsilon = 0)

◆ Normalized()

template<typename RealType >
TQuaternion< RealType > UE::Geometry::TQuaternion< RealType >::Normalized ( const RealType  epsilon = 0) const

◆ operator FQuat4d()

template<typename RealType >
UE::Geometry::TQuaternion< RealType >::operator FQuat4d ( ) const
inlineexplicit

◆ operator FQuat4f()

template<typename RealType >
UE::Geometry::TQuaternion< RealType >::operator FQuat4f ( ) const
inlineexplicit

◆ operator FRotator()

template<typename RealType >
UE::Geometry::TQuaternion< RealType >::operator FRotator ( ) const
inlineexplicit

◆ operator UE::Math::TVector4< RealType >()

template<typename RealType >
UE::Geometry::TQuaternion< RealType >::operator UE::Math::TVector4< RealType > ( ) const
inlineexplicit

◆ operator-()

template<typename RealType >
constexpr TQuaternion< RealType > UE::Geometry::TQuaternion< RealType >::operator- ( ) const
inlineconstexpr

◆ operator=()

template<typename RealType >
TQuaternion & UE::Geometry::TQuaternion< RealType >::operator= ( const TQuaternion< RealType > &  Copy)
default

◆ operator[]() [1/2]

template<typename RealType >
RealType & UE::Geometry::TQuaternion< RealType >::operator[] ( int  i)
inline

◆ operator[]() [2/2]

template<typename RealType >
const RealType & UE::Geometry::TQuaternion< RealType >::operator[] ( int  i) const
inline

◆ SetAxisAngleD()

template<typename RealType >
void UE::Geometry::TQuaternion< RealType >::SetAxisAngleD ( const TVector< RealType > &  Axis,
RealType  AngleDeg 
)

◆ SetAxisAngleR()

template<typename RealType >
void UE::Geometry::TQuaternion< RealType >::SetAxisAngleR ( const TVector< RealType > &  Axis,
RealType  AngleRad 
)

◆ SetFromRotationMatrix()

template<typename RealType >
void UE::Geometry::TQuaternion< RealType >::SetFromRotationMatrix ( const TMatrix3< RealType > &  RotationMatrix)

◆ SetFromTo()

template<typename RealType >
void UE::Geometry::TQuaternion< RealType >::SetFromTo ( const TVector< RealType > &  From,
const TVector< RealType > &  To 
)

◆ SetToSlerp()

template<typename RealType >
void UE::Geometry::TQuaternion< RealType >::SetToSlerp ( TQuaternion< RealType >  From,
TQuaternion< RealType >  To,
RealType  InterpT 
)

◆ SquaredLength()

template<typename RealType >
RealType UE::Geometry::TQuaternion< RealType >::SquaredLength ( ) const
inline

◆ ToRotationMatrix()

template<typename RealType >
TMatrix3< RealType > UE::Geometry::TQuaternion< RealType >::ToRotationMatrix ( ) const

◆ Zero()

template<typename RealType >
static TQuaternion< RealType > UE::Geometry::TQuaternion< RealType >::Zero ( )
inlinestatic

Member Data Documentation

◆ [union]

union { ... } UE::Geometry::TQuaternion< RealType >

◆ W

template<typename RealType >
RealType UE::Geometry::TQuaternion< RealType >::W

◆ X

template<typename RealType >
RealType UE::Geometry::TQuaternion< RealType >::X

◆ XYZW

template<typename RealType >
RealType UE::Geometry::TQuaternion< RealType >::XYZW[4]

◆ Y

template<typename RealType >
RealType UE::Geometry::TQuaternion< RealType >::Y

◆ Z

template<typename RealType >
RealType UE::Geometry::TQuaternion< RealType >::Z
The documentation for this struct was generated from the following file: