siderust::cartesian::Direction< F > Struct Template Reference

A unit-vector direction in Cartesian form, compile-time frame-tagged. More...

#include <siderust/coordinates/cartesian.hpp>

Public Member Functions
	Direction ()
	Direction (double x_, double y_, double z_)

Static Public Member Functions
static constexpr siderust_frame_t	frame_id ()

Public Attributes
double	x
	X component (unitless).
double	y
	Y component (unitless).
double	z
	Z component (unitless).

Detailed Description

template<typename F>
struct siderust::cartesian::Direction< F >

A unit-vector direction in Cartesian form, compile-time frame-tagged.

Mirrors Rust's affn::cartesian::Direction<F>.

Template Parameters

F	Reference frame tag (e.g. frames::ICRS).

Examples

coordinates_examples.cpp.

Definition at line 27 of file cartesian.hpp.

Constructor & Destructor Documentation

Direction() [1/2]

template<typename F >

siderust::cartesian::Direction< F >::Direction ( )

inline

Definition at line 34 of file cartesian.hpp.

Direction() [2/2]

template<typename F >

siderust::cartesian::Direction< F >::Direction ( double  x_, double  y_, double  z_  )

inline

Definition at line 35 of file cartesian.hpp.

Member Function Documentation

frame_id()

template<typename F >

static constexpr siderust_frame_t siderust::cartesian::Direction< F >::frame_id ( )

inlinestaticconstexpr

Definition at line 37 of file cartesian.hpp.

Member Data Documentation

x

template<typename F >

double siderust::cartesian::Direction< F >::x

X component (unitless).

Definition at line 30 of file cartesian.hpp.

Referenced by cartesian_and_units_example().

y

template<typename F >

double siderust::cartesian::Direction< F >::y

Y component (unitless).

Definition at line 31 of file cartesian.hpp.

Referenced by cartesian_and_units_example().

z

template<typename F >

double siderust::cartesian::Direction< F >::z

Z component (unitless).

Definition at line 32 of file cartesian.hpp.

Referenced by cartesian_and_units_example().

---

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

• cartesian.hpp