LuciadCPillar C# 2024.0.08
Luciad.Cartesian.Angle Struct Reference

An angle on a mathematical circle: degrees, counter-clockwise from right/X-axis. More...

Inheritance diagram for Luciad.Cartesian.Angle:

Public Types

enum  Direction { Clockwise , CounterClockwise }
 Represents the different angular directions. More...
 

Public Member Functions

 Angle (Angle angle)
 Creates an angle based on another angle. More...
 
 Angle (double degrees)
 Creates an angle based on the given angular value in degrees. More...
 
bool Equals (Angle other)
 
override bool Equals (object other)
 
override int GetHashCode ()
 

Static Public Member Functions

static Angle FromRadians (double radians)
 Creates an Angle from an angle value in radians. More...
 
static double Normalize (double degrees)
 Normalizes the degree value to the range ]-180, +180]. More...
 
static implicit operator Angle (Azimuth azimuth)
 
static implicit operator Angle (double value)
 
static bool operator!= (Angle lhs, Angle rhs)
 
static bool operator== (Angle lhs, Angle rhs)
 

Properties

double Degrees [get]
 The value in degrees constrained between [0, 360]. More...
 
double Radians [get]
 The value in radians constrained between [0, 2*PI] More...
 

Detailed Description

An angle on a mathematical circle: degrees, counter-clockwise from right/X-axis.

Member Enumeration Documentation

◆ Direction

Represents the different angular directions.

Enumerator
Clockwise 

Angle in clockwise direction.

CounterClockwise 

Angle in counter-clockwise direction.

Constructor & Destructor Documentation

◆ Angle() [1/2]

Luciad.Cartesian.Angle.Angle ( double  degrees)
inline

Creates an angle based on the given angular value in degrees.

Parameters
degreesan angle in degree
Exceptions
System.ArgumentExceptionwhen degrees is NaN or infinite.

◆ Angle() [2/2]

Luciad.Cartesian.Angle.Angle ( Angle  angle)
inline

Creates an angle based on another angle.

Parameters
anglean angle.

Member Function Documentation

◆ Equals() [1/2]

bool Luciad.Cartesian.Angle.Equals ( Angle  other)
inline

◆ Equals() [2/2]

override bool Luciad.Cartesian.Angle.Equals ( object  other)
inline

◆ FromRadians()

static Angle Luciad.Cartesian.Angle.FromRadians ( double  radians)
inlinestatic

Creates an Angle from an angle value in radians.

Parameters
radiansan angle in radians
Returns
a new angle based on the given angle in radians
Exceptions
System.ArgumentExceptionwhen radians is NaN or infinite.

◆ GetHashCode()

override int Luciad.Cartesian.Angle.GetHashCode ( )
inline

◆ Normalize()

static double Luciad.Cartesian.Angle.Normalize ( double  degrees)
inlinestatic

Normalizes the degree value to the range ]-180, +180].

Parameters
degreesa value in degrees
Returns
a degrees value, normalized to ]-180, +180].

◆ operator Angle() [1/2]

static implicit Luciad.Cartesian.Angle.operator Angle ( Azimuth  azimuth)
inlinestatic

◆ operator Angle() [2/2]

static implicit Luciad.Cartesian.Angle.operator Angle ( double  value)
inlinestatic

◆ operator!=()

static bool Luciad.Cartesian.Angle.operator!= ( Angle  lhs,
Angle  rhs 
)
inlinestatic

◆ operator==()

static bool Luciad.Cartesian.Angle.operator== ( Angle  lhs,
Angle  rhs 
)
inlinestatic

Property Documentation

◆ Degrees

double Luciad.Cartesian.Angle.Degrees
get

The value in degrees constrained between [0, 360].

[get]

Returns the value in degrees constrained between [0, 360].

◆ Radians

double Luciad.Cartesian.Angle.Radians
get

The value in radians constrained between [0, 2*PI]

[get]

Returns the value in radians constrained between [0, 2*PI]