omni::geometry::Angle Struct Reference

Struct for representing an angle (stored in degrees internally) More...

#include <Angle.h>

Public Member Functions
	Angle ()
	Default constructor. More...
	Angle (qreal _angle)
	Constructor from value. More...
void	setDegrees (qreal _angle)
	Set angle by given degrees. More...
void	setRadians (qreal _angle)
	Set angle by radians. More...
qreal	degrees () const
	Return degrees. More...
qreal	radians () const
	Returns radians. More...
Angle const &	operator+= (Angle const &)
	Increment angle by another. More...
Angle const &	operator-= (Angle const &)
	Decrement angle by another. More...

Static Public Member Functions
static Angle	fromDeg (qreal _angle)
	Constructs from degrees. More...
static Angle	fromRad (qreal _angle)
	Constructs angle from radians. More...

Private Attributes
qreal	angle_

Friends
bool	operator== (Angle const &, Angle const &)
	Test for equality. More...

Detailed Description

Struct for representing an angle (stored in degrees internally)

Constructor & Destructor Documentation

omni::geometry::Angle::Angle

(

)

Default constructor.

                 : angle_(0.0)
    {}

omni::geometry::Angle::Angle

(

qreal

_angle

)

Constructor from value.

    {
      setDegrees(_angle);
    }

Member Function Documentation

qreal omni::geometry::Angle::degrees

(

)

const

Return degrees.

    {
      return angle_;
    }

Angle omni::geometry::Angle::fromDeg ( qreal  _angle )

static

Constructs from degrees.

    {
      return Angle(_angle);
    }

Angle omni::geometry::Angle::fromRad ( qreal  _angle )

static

Constructs angle from radians.

    {
      Angle _angle;

      _angle.setRadians(_rad);
      return _angle;
    }

Angle const & omni::geometry::Angle::operator+=

(

Angle const &

_angle

)

Increment angle by another.

    {
      angle_ += _angle.degrees();
      return *this;
    }

Angle const & omni::geometry::Angle::operator-=

(

Angle const &

_angle

)

Decrement angle by another.

    {
      angle_ -= _angle.degrees();
      return *this;
    }

qreal omni::geometry::Angle::radians

(

)

const

Returns radians.

    {
      return angle_ / 180.0 * M_PI;
    }

void omni::geometry::Angle::setDegrees

(

qreal

_angle

)

Set angle by given degrees.

    {
      angle_ = fmod(_angle, 360.0);
    }

void omni::geometry::Angle::setRadians

(

qreal

_angle

)

Set angle by radians.

    {
      setDegrees(_angle * 180.0 / M_PI);
    }

Friends And Related Function Documentation

bool operator== ( Angle const &  _lhs, Angle const &  _rhs  )

friend

Test for equality.

    {
      return OMNI_TEST_MEMBER_EQUAL(angle_);
    }

Field Documentation

qreal omni::geometry::Angle::angle_

private

---

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

• include/omni/geometry/Angle.h
• src/lib/geometry/Angle.cpp