JPL Spatial
Sound spatialization and propagation library
Loading...
Searching...
No Matches
JPL::OrientationData< Vec3Type > Struct Template Reference

Minimum data required to do our orientation math. More...

#include <JPLSpatial/Math/Position.h>

Public Member Functions

JPL_INLINE Basis< Vec3Type > ToBasis () const noexcept
 
JPL_INLINE Basis< Vec3Type > ToBasisUnsafe () const
 
JPL_INLINE Quat< Vec3Type > ToQuat () const noexcept
 

Static Public Member Functions

static JPL_INLINE OrientationData< Vec3Type > Identity () noexcept
 
static JPL_INLINE OrientationData< Vec3Type > IdentityForward () noexcept
 Identity facing forward as per right-handed rotation.
 

Public Attributes

Vec3Type Up
 
Vec3Type Forward
 

Detailed Description

template<CVec3 Vec3Type>
struct JPL::OrientationData< Vec3Type >

Minimum data required to do our orientation math.

Member Function Documentation

◆ Identity()

template<CVec3 Vec3Type>
static JPL_INLINE OrientationData< Vec3Type > JPL::OrientationData< Vec3Type >::Identity ( )
inlinestaticnoexcept

◆ IdentityForward()

template<CVec3 Vec3Type>
static JPL_INLINE OrientationData< Vec3Type > JPL::OrientationData< Vec3Type >::IdentityForward ( )
inlinestaticnoexcept

Identity facing forward as per right-handed rotation.

◆ ToBasis()

template<CVec3 Vec3Type>
JPL_INLINE Basis< Vec3Type > JPL::OrientationData< Vec3Type >::ToBasis ( ) const
inlinenoexcept

Flip forward to accomodate right-handed rotatation

◆ ToBasisUnsafe()

template<CVec3 Vec3Type>
JPL_INLINE Basis< Vec3Type > JPL::OrientationData< Vec3Type >::ToBasisUnsafe ( ) const
inline

Flip forward to accomodate right-handed rotatation

◆ ToQuat()

template<CVec3 Vec3Type>
JPL_INLINE Quat< Vec3Type > JPL::OrientationData< Vec3Type >::ToQuat ( ) const
inlinenoexcept

Flip forward to accomodate right-handed rotatation

Member Data Documentation

◆ Forward

template<CVec3 Vec3Type>
Vec3Type JPL::OrientationData< Vec3Type >::Forward

◆ Up

template<CVec3 Vec3Type>
Vec3Type JPL::OrientationData< Vec3Type >::Up

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