frc::CoordinateAxis Class Reference

A class representing a coordinate system axis within the NWU coordinate system. More...

#include <frc/geometry/CoordinateAxis.h>

Public Member Functions
constexpr	CoordinateAxis (double x, double y, double z)
	Constructs a coordinate system axis within the NWU coordinate system and normalizes it.
	CoordinateAxis (const CoordinateAxis &)=default
CoordinateAxis &	operator= (const CoordinateAxis &)=default
	CoordinateAxis (CoordinateAxis &&)=default
CoordinateAxis &	operator= (CoordinateAxis &&)=default

Static Public Member Functions
static constexpr CoordinateAxis	N ()
	Returns a coordinate axis corresponding to +X in the NWU coordinate system.
static constexpr CoordinateAxis	S ()
	Returns a coordinate axis corresponding to -X in the NWU coordinate system.
static constexpr CoordinateAxis	E ()
	Returns a coordinate axis corresponding to -Y in the NWU coordinate system.
static constexpr CoordinateAxis	W ()
	Returns a coordinate axis corresponding to +Y in the NWU coordinate system.
static constexpr CoordinateAxis	U ()
	Returns a coordinate axis corresponding to +Z in the NWU coordinate system.
static constexpr CoordinateAxis	D ()
	Returns a coordinate axis corresponding to -Z in the NWU coordinate system.

Friends
class	CoordinateSystem

Detailed Description

A class representing a coordinate system axis within the NWU coordinate system.

Constructor & Destructor Documentation

CoordinateAxis() [1/3]

frc::CoordinateAxis::CoordinateAxis ( double x, double y, double z )

inlineconstexpr

Constructs a coordinate system axis within the NWU coordinate system and normalizes it.

Parameters

x	The x component.
y	The y component.
z	The z component.

CoordinateAxis() [2/3]

frc::CoordinateAxis::CoordinateAxis ( const CoordinateAxis & )

default

CoordinateAxis() [3/3]

frc::CoordinateAxis::CoordinateAxis ( CoordinateAxis && )

default

Member Function Documentation

D()

static constexpr CoordinateAxis frc::CoordinateAxis::D ( )

inlinestaticconstexpr

Returns a coordinate axis corresponding to -Z in the NWU coordinate system.

E()

static constexpr CoordinateAxis frc::CoordinateAxis::E ( )

inlinestaticconstexpr

Returns a coordinate axis corresponding to -Y in the NWU coordinate system.

N()

static constexpr CoordinateAxis frc::CoordinateAxis::N ( )

inlinestaticconstexpr

Returns a coordinate axis corresponding to +X in the NWU coordinate system.

operator=() [1/2]

CoordinateAxis & frc::CoordinateAxis::operator= ( const CoordinateAxis & )

default

operator=() [2/2]

CoordinateAxis & frc::CoordinateAxis::operator= ( CoordinateAxis && )

default

S()

static constexpr CoordinateAxis frc::CoordinateAxis::S ( )

inlinestaticconstexpr

Returns a coordinate axis corresponding to -X in the NWU coordinate system.

U()

static constexpr CoordinateAxis frc::CoordinateAxis::U ( )

inlinestaticconstexpr

Returns a coordinate axis corresponding to +Z in the NWU coordinate system.

W()

static constexpr CoordinateAxis frc::CoordinateAxis::W ( )

inlinestaticconstexpr

Returns a coordinate axis corresponding to +Y in the NWU coordinate system.

Friends And Related Symbol Documentation

CoordinateSystem

friend class CoordinateSystem

friend

---

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

• frc/geometry/CoordinateAxis.h