API Documentation
Loading...
Searching...
No Matches
Static Public Member Functions | List of all members
AngleDefinitions Class Reference

Logic for converting between Euler angles and basic rotations or normals. More...

#include <AngleFunctions.h>

Static Public Member Functions

static Vector< 3, Angle< fltp08 > > QuaternionToOrientation (const Vector< 4, fltp08 > &quaternion)
 
template<class t_angle_type , uint01 t_dims, class t_type >
static Angle< t_angle_type > Rotation (const Vector< t_dims, t_type > &left, const Vector< t_dims, t_type > &middle, const Vector< t_dims, t_type > &right)
 
template<class t_angle_type >
static Angle< t_angle_type > Inclination (const Angle< t_angle_type > &roll, const Angle< t_angle_type > &pitch)
 
template<class t_angle_type , uint01 t_dims, class t_type >
static constexpr Angle< t_angle_type > Inclination (const Vector< t_dims, t_type > ray)
 
template<class t_angle_type , uint01 t_dims, class t_type >
static constexpr Angle< t_angle_type > Heading (const Vector< t_dims, t_type > ray)
 
template<class t_angle_type , uint01 t_dims, class t_type >
static constexpr Vector< t_dims, Angle< t_angle_type > > Orientation (AngleType angle_type, const Vector< t_dims, t_type > &ray)
 
template<bool t_normalized, uint01 t_dims, class t_angle_type >
static constexpr Vector< t_dims, fltp08 > Orientation (AngleType angle_type, const Vector< t_dims, Angle< t_angle_type > > &ray)
 
template<class t_angle_type , class t_type >
static Vector< 3, Angle< t_angle_type > > NormalToOrientation (const Vector< 3, t_type > &normal, const Angle< t_angle_type > &yaw=Angle< t_angle_type >(0))
 
template<class t_angle_type >
static Vector< 3, Angle< t_angle_type > > NormalizeOrientation (Vector< 3, Angle< t_angle_type > > angle, const Vector< 3, Angle< t_angle_type > > &reference)
 
static const fltp08 * CalcIndexSin ()
 

Detailed Description

Logic for converting between Euler angles and basic rotations or normals.

Class: AngleDefinitions

Author: Tyler Parke

Date: 2017-11-13

Member Function Documentation

◆ CalcIndexSin()

const fltp08 * CalcIndexSin ( )
static

Fn: static const fltp08* AngleDefinitions::CalcIndexSin();

Calculates the index sine.

Author: Tyler Parke

Date: 2017-11-13

Returns: Null if it fails, else the calculated index sine.

◆ Heading()

template<class t_angle_type , uint01 t_dims, class t_type >
static constexpr Angle< t_angle_type > Heading ( const Vector< t_dims, t_type > ray)
inlinestaticconstexpr

◆ Inclination() [1/2]

template<class t_angle_type >
static Angle< t_angle_type > Inclination ( const Angle< t_angle_type > & roll,
const Angle< t_angle_type > & pitch )
inlinestatic

Fn: static Angle AngleDefinitions::Inclination(const Angle& roll, const Angle& pitch)

Gets the Inclination of .

Author: Tyler Parke

Date: 2018-08-15

Parameters: roll - The rotation about the X axis. pitch - The rotation about the Y axis.

Returns: The rotation.

◆ Inclination() [2/2]

template<class t_angle_type , uint01 t_dims, class t_type >
static constexpr Angle< t_angle_type > Inclination ( const Vector< t_dims, t_type > ray)
inlinestaticconstexpr

◆ NormalizeOrientation()

template<class t_angle_type >
static Vector< 3, Angle< t_angle_type > > NormalizeOrientation ( Vector< 3, Angle< t_angle_type > > angle,
const Vector< 3, Angle< t_angle_type > > & reference )
inlinestatic

◆ NormalToOrientation()

template<class t_angle_type , class t_type >
static Vector< 3, Angle< t_angle_type > > NormalToOrientation ( const Vector< 3, t_type > & normal,
const Angle< t_angle_type > & yaw = Angle<t_angle_type>(0) )
inlinestatic

Fn: static Vector<3, Angle> AngleDefinitions::NormalToOrientation(const Vector<3, t_type>& normal, const Angle& yaw = Angle(INTERNAL_ANGLE, 0))

Normal to orientation.

Author: Tyler Parke

Date: 2017-11-13

Parameters: normal - The normal. yaw - (Optional) The yaw.

Returns: A Vector<3,Angle>

◆ Orientation() [1/2]

template<bool t_normalized, uint01 t_dims, class t_angle_type >
static constexpr Vector< t_dims, fltp08 > Orientation ( AngleType angle_type,
const Vector< t_dims, Angle< t_angle_type > > & ray )
inlinestaticconstexpr

◆ Orientation() [2/2]

template<class t_angle_type , uint01 t_dims, class t_type >
static constexpr Vector< t_dims, Angle< t_angle_type > > Orientation ( AngleType angle_type,
const Vector< t_dims, t_type > & ray )
inlinestaticconstexpr

◆ QuaternionToOrientation()

Vector< 3, Angle< fltp08 > > QuaternionToOrientation ( const Vector< 4, fltp08 > & quaternion)
static

Fn: static Vector<3, Angle> AngleDefinitions::QuaternionToOrientation(const Vector<4, fltp08>& q);

Convert quaternion to roll pitch yaw.

Author: Tyler Parke

Date: 2017-11-13

Parameters: q - A Vector<4,fltp08> to process.

Returns: The quaternion converted to roll pitch yaw.

◆ Rotation()

template<class t_angle_type , uint01 t_dims, class t_type >
static Angle< t_angle_type > Rotation ( const Vector< t_dims, t_type > & left,
const Vector< t_dims, t_type > & middle,
const Vector< t_dims, t_type > & right )
inlinestatic

Fn: static Angle AngleDefinitions::Rotation(const Vector<t_dims, t_type>& left, const Vector<t_dims, t_type>& middle, const Vector<t_dims, t_type>& right)

Gets a rotation.

Author: Tyler Parke

Date: 2017-11-13

Parameters: left - The left. middle - The middle. right - The right.

Returns: The rotation.

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