osc::CoordinateDirection Class Reference

#include <coordinate_direction.h>

Public Member Functions
constexpr	CoordinateDirection ()=default
constexpr	CoordinateDirection (CoordinateAxis axis)
constexpr	CoordinateDirection (CoordinateAxis axis, Negative)
constexpr CoordinateAxis	axis () const
constexpr bool	is_negated () const
template<typename T = float> requires std::is_arithmetic_v<T>
and std::is_signed_v< T > constexpr T	direction () const
template<typename T = float> requires std::is_arithmetic_v<T>
constexpr Vector< T, 3 >	direction_vector () const
constexpr CoordinateDirection	operator- () const
constexpr size_t	index () const

Static Public Member Functions
static std::optional< CoordinateDirection >	try_parse (std::string_view)
static constexpr CoordinateDirection	x ()
static constexpr CoordinateDirection	minus_x ()
static constexpr CoordinateDirection	y ()
static constexpr CoordinateDirection	minus_y ()
static constexpr CoordinateDirection	z ()
static constexpr CoordinateDirection	minus_z ()

Friends
constexpr auto	operator<=> (const CoordinateDirection &, const CoordinateDirection &)=default
constexpr CoordinateDirection	cross (CoordinateDirection, CoordinateDirection)

Constructor & Destructor Documentation

CoordinateDirection() [1/3]

constexpr osc::CoordinateDirection::CoordinateDirection ( )

constexprdefault

CoordinateDirection() [2/3]

constexpr osc::CoordinateDirection::CoordinateDirection ( CoordinateAxis  axis )

inlineconstexpr

CoordinateDirection() [3/3]

constexpr osc::CoordinateDirection::CoordinateDirection ( CoordinateAxis  axis, Negative    )

inlineconstexpr

Member Function Documentation

axis()

constexpr CoordinateAxis osc::CoordinateDirection::axis ( ) const

inlineconstexpr

direction()

template<typename T = float>
requires std::is_arithmetic_v<T>

and std::is_signed_v< T > constexpr T osc::CoordinateDirection::direction ( ) const

inlineconstexpr

direction_vector()

template<typename T = float>
requires std::is_arithmetic_v<T>

constexpr Vector< T, 3 > osc::CoordinateDirection::direction_vector ( ) const

inlineconstexpr

index()

constexpr size_t osc::CoordinateDirection::index ( ) const

inlineconstexpr

is_negated()

constexpr bool osc::CoordinateDirection::is_negated ( ) const

inlineconstexpr

minus_x()

static constexpr CoordinateDirection osc::CoordinateDirection::minus_x ( )

inlinestaticconstexpr

minus_y()

static constexpr CoordinateDirection osc::CoordinateDirection::minus_y ( )

inlinestaticconstexpr

minus_z()

static constexpr CoordinateDirection osc::CoordinateDirection::minus_z ( )

inlinestaticconstexpr

operator-()

constexpr CoordinateDirection osc::CoordinateDirection::operator- ( ) const

inlineconstexpr

try_parse()

static std::optional< CoordinateDirection > osc::CoordinateDirection::try_parse ( std::string_view  )

static

x()

static constexpr CoordinateDirection osc::CoordinateDirection::x ( )

inlinestaticconstexpr

y()

static constexpr CoordinateDirection osc::CoordinateDirection::y ( )

inlinestaticconstexpr

z()

static constexpr CoordinateDirection osc::CoordinateDirection::z ( )

inlinestaticconstexpr

Friends And Related Symbol Documentation

cross

constexpr CoordinateDirection cross ( CoordinateDirection  x, CoordinateDirection  y  )

friend

operator<=>

constexpr auto operator<=> ( const CoordinateDirection &  , const CoordinateDirection &    )

friend

---

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

• /home/adam/Desktop/opensim-creator/third_party/opynsim/liboscar/maths/coordinate_direction.h