LuciadCPillar 2024.0.08
All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Modules Pages
luciad::Azimuth Struct Referencefinal

An azimuth: degrees, clockwise from north/up/Y-axis. More...

#include <luciad/cartesian/Azimuth.h>

Public Member Functions

 Azimuth (const Angle &angle)
 Creates an azimuth based on an angle. More...
 
 Azimuth (const Azimuth &azimuth)=default
 Creates an azimuth based on an angle, expressed in degrees. More...
 
 Azimuth (double degrees)
 Create an Azimuth based on the given azimuth value in degrees. More...
 
double getDegrees () const
 Returns the value in degrees. More...
 
double getRadians () const
 Returns the value in radians. More...
 
bool operator!= (const Azimuth &other) const
 
Azimuth operator* (const double scalar) const
 
Azimuthoperator*= (const double scalar)
 
Azimuth operator+ (const Azimuth &other) const
 
Azimuthoperator+= (const Azimuth &other)
 
Azimuth operator- () const
 
Azimuth operator- (const Azimuth &other) const
 
Azimuthoperator-= (const Azimuth &other)
 
Azimuth operator/ (const double scalar) const
 
Azimuthoperator/= (const double scalar)
 
bool operator< (const Azimuth &other) const
 
bool operator<= (const Azimuth &other) const
 
Azimuthoperator= (const Angle &other)
 
Azimuthoperator= (const Azimuth &other)=default
 
Azimuthoperator= (const double arg) noexcept
 
bool operator== (const Azimuth &other) const
 
bool operator> (const Azimuth &other) const
 
bool operator>= (const Azimuth &other) const
 

Static Public Member Functions

static Azimuth fromRadians (double radians)
 Creates an Azimuth from an azimuth value in radians. More...
 

Detailed Description

An azimuth: degrees, clockwise from north/up/Y-axis.

Constructor & Destructor Documentation

◆ Azimuth() [1/3]

luciad::Azimuth::Azimuth ( double  degrees)

Create an Azimuth based on the given azimuth value in degrees.

Parameters
degreesan angle in degree
Exceptions
luciad::InvalidArgumentExceptionwhen degrees is NaN or infinite.

◆ Azimuth() [2/3]

luciad::Azimuth::Azimuth ( const Azimuth azimuth)
default

Creates an azimuth based on an angle, expressed in degrees.

Parameters
azimuththe azimuth value.

◆ Azimuth() [3/3]

luciad::Azimuth::Azimuth ( const Angle angle)

Creates an azimuth based on an angle.

Parameters
anglethe angle value.

Member Function Documentation

◆ fromRadians()

static Azimuth luciad::Azimuth::fromRadians ( double  radians)
static

Creates an Azimuth from an azimuth value in radians.

Parameters
radiansan azimuth in radians
Returns
a new Azimuth based on the given azimuth in radians
Exceptions
luciad::InvalidArgumentExceptionwhen radians is NaN or infinite.

◆ getDegrees()

double luciad::Azimuth::getDegrees ( ) const
inline

Returns the value in degrees.

Returns
the value in degrees.

◆ getRadians()

double luciad::Azimuth::getRadians ( ) const

Returns the value in radians.

Returns
the value in radians.

◆ operator!=()

bool luciad::Azimuth::operator!= ( const Azimuth other) const
inline

◆ operator*()

Azimuth luciad::Azimuth::operator* ( const double  scalar) const
inline

◆ operator*=()

Azimuth & luciad::Azimuth::operator*= ( const double  scalar)
inline

◆ operator+()

Azimuth luciad::Azimuth::operator+ ( const Azimuth other) const
inline

◆ operator+=()

Azimuth & luciad::Azimuth::operator+= ( const Azimuth other)
inline

◆ operator-() [1/2]

Azimuth luciad::Azimuth::operator- ( ) const
inline

◆ operator-() [2/2]

Azimuth luciad::Azimuth::operator- ( const Azimuth other) const
inline

◆ operator-=()

Azimuth & luciad::Azimuth::operator-= ( const Azimuth other)
inline

◆ operator/()

Azimuth luciad::Azimuth::operator/ ( const double  scalar) const
inline

◆ operator/=()

Azimuth & luciad::Azimuth::operator/= ( const double  scalar)
inline

◆ operator<()

bool luciad::Azimuth::operator< ( const Azimuth other) const
inline

◆ operator<=()

bool luciad::Azimuth::operator<= ( const Azimuth other) const
inline

◆ operator=() [1/3]

Azimuth & luciad::Azimuth::operator= ( const Angle other)

◆ operator=() [2/3]

Azimuth & luciad::Azimuth::operator= ( const Azimuth other)
default

◆ operator=() [3/3]

Azimuth & luciad::Azimuth::operator= ( const double  arg)
inlinenoexcept

◆ operator==()

bool luciad::Azimuth::operator== ( const Azimuth other) const
inline

◆ operator>()

bool luciad::Azimuth::operator> ( const Azimuth other) const
inline

◆ operator>=()

bool luciad::Azimuth::operator>= ( const Azimuth other) const
inline