Tekkotsu Homepage
Demos
Overview
Downloads
Dev. Resources
Reference
Credits

AngTwoPi Class Reference

#include <Measures.h>

List of all members.


Detailed Description

Circular arithmetic on angles between 0 and two pi (360 degrees).

Definition at line 46 of file Measures.h.


Public Member Functions

 AngTwoPi (void)
 AngTwoPi (direction_t const &v)
 constructor, value defaults to 0
AngTwoPi operator+ (AngTwoPi const &arg) const
AngTwoPi operator- (AngTwoPi const &arg) const
AngTwoPi operator * (direction_t const &arg) const
AngTwoPi operator/ (direction_t const &arg) const
AngTwoPioperator= (AngTwoPi const &arg)
AngTwoPioperator= (direction_t const &arg)
AngTwoPioperator+= (direction_t const &arg)
AngTwoPioperator-= (direction_t const &arg)
AngTwoPioperator *= (direction_t const &arg)
AngTwoPioperator/= (direction_t const &arg)
 operator direction_t () const

Protected Member Functions

void normalize ()
 conversion operator for going back to the primitive type

Protected Attributes

direction_t value
 holds the angle, should be kept normalized at all times

Friends

AngPi angdist (AngTwoPi const &arg1, AngTwoPi const &arg2)
 Angular distance: value is between 0 and pi.

Constructor & Destructor Documentation

AngTwoPi::AngTwoPi ( void   )  [inline]

Definition at line 49 of file Measures.h.

Referenced by operator *(), operator+(), operator-(), and operator/().

AngTwoPi::AngTwoPi ( direction_t const &  v  )  [inline]

constructor, value defaults to 0

conversion operator allows implicit construction from primitive

Definition at line 50 of file Measures.h.


Member Function Documentation

AngTwoPi AngTwoPi::operator+ ( AngTwoPi const &  arg  )  const [inline]

Definition at line 52 of file Measures.h.

AngTwoPi AngTwoPi::operator- ( AngTwoPi const &  arg  )  const [inline]

Definition at line 53 of file Measures.h.

AngTwoPi AngTwoPi::operator * ( direction_t const &  arg  )  const [inline]

Definition at line 54 of file Measures.h.

AngTwoPi AngTwoPi::operator/ ( direction_t const &  arg  )  const [inline]

Definition at line 55 of file Measures.h.

AngTwoPi& AngTwoPi::operator= ( AngTwoPi const &  arg  )  [inline]

Definition at line 57 of file Measures.h.

AngTwoPi& AngTwoPi::operator= ( direction_t const &  arg  )  [inline]

Definition at line 58 of file Measures.h.

AngTwoPi& AngTwoPi::operator+= ( direction_t const &  arg  )  [inline]

Definition at line 59 of file Measures.h.

AngTwoPi& AngTwoPi::operator-= ( direction_t const &  arg  )  [inline]

Definition at line 60 of file Measures.h.

AngTwoPi& AngTwoPi::operator *= ( direction_t const &  arg  )  [inline]

Definition at line 61 of file Measures.h.

AngTwoPi& AngTwoPi::operator/= ( direction_t const &  arg  )  [inline]

Definition at line 62 of file Measures.h.

AngTwoPi::operator direction_t (  )  const [inline]

Definition at line 64 of file Measures.h.

void AngTwoPi::normalize (  )  [protected]

conversion operator for going back to the primitive type

modifies value to put it back in range

Definition at line 26 of file Measures.cc.

Referenced by AngTwoPi(), operator *=(), operator+=(), operator-=(), operator/=(), and operator=().


Friends And Related Function Documentation

AngPi angdist ( AngTwoPi const &  arg1,
AngTwoPi const &  arg2 
) [friend]

Angular distance: value is between 0 and pi.

Definition at line 41 of file Measures.cc.


Member Data Documentation

holds the angle, should be kept normalized at all times

Definition at line 68 of file Measures.h.

Referenced by angdist(), normalize(), operator *(), operator *=(), operator direction_t(), operator+(), operator+=(), operator-(), operator-=(), operator/(), operator/=(), and operator=().


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

Tekkotsu v4.0
Generated Thu Nov 22 00:58:08 2007 by Doxygen 1.5.4