Angle

Canonical path: NemAll_Python_Geometry.Angle

Representation class for angle in [rad].

Methods:

• DegToRad –

  Convert degrees to radians

• FromDeg –

  Create an angle from degrees

• Get –

  Get angle as radian value.

• GetDeg –

  Get the angle in degrees

• Normalize2Pi –

  Normalize the angle to a range of <0, 2PI>.

• NormalizePi –

  Normalize the angle to a range of <-PI, PI>.

• RadToDeg –

  Convert radians to degrees

• RadToGrad –

  Convert radians to gradians

• Set –

  Overloaded function. See individual overloads.

• SetDeg –

  Set angle as degree value.

• __add__ –

  Overloaded function. See individual overloads.

• __eq__ –

  Comparison of angles.

• __float__ –

  Convert the angle to a floating point number

• __iadd__ –

  In-place addition of two angles

• __init__ –

  Overloaded function. See individual overloads.

• __isub__ –

  In-place subtraction of two angles

• __ne__ –

  Comparison of angles.

• __repr__ –

  Convert to string

• __sub__ –

  Subtraction of angles.

Attributes:

• Deg (float) –

  Angle calue in degrees

• Rad (float) –

  Angle value in radians

Deg property writable

Deg: float

Angle calue in degrees

Rad property writable

Rad: float

Angle value in radians

DegToRad staticmethod

DegToRad(angleDeg: float) -> float

Convert degrees to radians

Parameters:

• angleDeg (float) –

  Angle in deg

Returns:

• float –

  Angle in rad

Examples:

>>> Angle.DegToRad(180)
3.141592653589793

FromDeg staticmethod

FromDeg(angleDeg: float) -> Angle

Create an angle from degrees

Parameters:

• angleDeg (float) –

  Angle in degree

Returns:

• Angle –

  Angle

Examples:

>>> Angle.FromDeg(180)
Angle(3.1415926535897931)

Get

Get() -> float

Get angle as radian value.

Returns:

• float –

  double as radian value.

GetDeg

GetDeg() -> float

Get the angle in degrees

Returns:

• float –

  double as degree value.

Examples:

>>> Angle(pi).GetDeg()
180.0

Normalize2Pi

Normalize2Pi()

Normalize the angle to a range of <0, 2PI>.

This method is checked and set Angle to 0 while angle is out of range <-1e8, 1e8>. The algorithm isn't stable for angle out of this range.

Examples:

>>> angle = Angle(7.5*pi)
>>> angle.Normalize2Pi()
>>> angle
Angle(4.7123889803846879)

NormalizePi

NormalizePi()

Normalize the angle to a range of <-PI, PI>.

This method is checked and set Angle to 0 while angle is out of range <-1e8, 1e8>. The algorithm isn't stable for angle out of this range.

Examples:

>>> angle = Angle(7.5*pi)
>>> angle.NormalizePi()
>>> angle
Angle(-1.5707963267948983)

RadToDeg staticmethod

RadToDeg(angleRad: float) -> float

Convert radians to degrees

Parameters:

• angleRad (float) –

  Angle in rad

Returns:

• float –

  Angle in rad

Examples:

>>> Angle.RadToDeg(pi)
180.0

RadToGrad staticmethod

RadToGrad(angleRad: float) -> float

Convert radians to gradians

Parameters:

• angleRad (float) –

  Angle in rad

Returns:

• float –

  Angle in grad

Examples:

>>> Angle.RadToGrad(pi)
200.0

Set overloaded

Set(angle: float)

Set angle as radian value.

Parameters:

• angle (float) –

  angle which will be set.

Set(angle: Angle)

Set angle as radian value.

Parameters:

• angle (Angle) –

  angle which will be set.

SetDeg

SetDeg(angleDeg: float)

Set angle as degree value.

Parameters:

• angleDeg (float) –

  angle as degree value which will be set.

__add__ overloaded

__add__(angle: Angle) -> Angle

Addition of angles.

Parameters:

• angle (Angle) –

  angle to be compared.

Returns:

• Angle –

  True when angles are not equal, otherwise false.

Examples:

>>> Angle(pi) + Angle(pi)
Angle(6.2831853071795862)

__add__(angle: Angle) -> Angle

Addition operator

Parameters:

• angle (Angle) –

  Angle which will be added

Returns:

• Angle –

  New angle

Examples:

>>> Angle(pi) + pi
Angle(6.2831853071795862)

__add__(angle: float) -> Angle

Addition operator

Parameters:

• angle (float) –

  Angle as double value which will be added

Returns:

• Angle –

  New angle

__eq__

__eq__(angle: Angle) -> bool

Comparison of angles.

Be careful, this method work without tolerance!

Parameters:

• angle (Angle) –

  angle to be compared.

Returns:

• bool –

  True when angles are equal, otherwise false.

__float__

__float__() -> float

Convert the angle to a floating point number

Returns:

• float –

  The angle in radians as a floating point number

Examples:

>>> float(Angle(pi))
3.141592653589793

__iadd__

__iadd__(angle: Angle) -> Angle

In-place addition of two angles

Parameters:

• angle (Angle) –

  Angle which will be added.

Returns:

• Angle –

  Reference to Angle.

Examples:

>>> angle = Angle(pi)
>>> angle += Angle(pi)
>>> angle
Angle(6.2831853071795862)

__init__ overloaded

__init__()

Initialize

__init__(angle: Angle)

Copy constructor.

Parameters:

• angle (Angle) –

  angle which will be copied.

__init__(angle: float)

Constructor.

Initialize angle from single value

Parameters:

• angle (float) –

  Angle.

__isub__

__isub__(angle: Angle) -> Angle

In-place subtraction of two angles

Parameters:

• angle (Angle) –

  Angle which will be added.

Returns:

• Angle –

  Reference to Angle.

Examples:

>>> angle = Angle(pi)
>>> angle -= Angle(pi)
>>> angle
Angle(0)

__ne__

__ne__(angle: Angle) -> bool

Comparison of angles.

Be careful, this method work without tolerance!

Parameters:

• angle (Angle) –

  angle to be compared.

Returns:

• bool –

  True when angles are not equal, otherwise false.

__repr__

__repr__() -> str

Convert to string

__sub__

__sub__(angle: Angle) -> Angle

Subtraction of angles.

Parameters:

• angle (Angle) –

  angle to be compared.

Returns:

• Angle –

  True when angles are not equal, otherwise false.

Placeholder