sgdk::PositiveRotation Class Reference
[Compass Module]

#include <swiss_gd_knife/math/geom/compass.hpp>

List of all members.

---

Detailed Description

A typesafe enumeration class defining the possible rotational directions a Compass can identify as upward from the ZeroDirection.

---

Model of:

• Assignable
• Copy Constructible

---

Public Member Functions
	PositiveRotation (const PositiveRotation &copy)
	The copy constructor.
PositiveRotation &	operator= (const PositiveRotation &copy)
	The assignment operator.
bool	isClockwise () const
bool	isCounterclockwise () const
Static Public Attributes
static const PositiveRotation	CLOCKWISE
static const PositiveRotation	COUNTERCLOCKWISE

---

Constructor & Destructor Documentation

sgdk::PositiveRotation::PositiveRotation (  const PositiveRotation &  copy  )  [inline]

Constructs a new PositiveRotation that will be internally equivalent to the copy. Parameters: copy  the PositiveRotation being copied.

---

Member Function Documentation

PositiveRotation& sgdk::PositiveRotation::operator= (  const PositiveRotation &  copy  )  [inline]

Sets this PositiveRotation to be internally equivalent to the copy. Parameters: copy  the PositiveRotation being copied. Returns: a reference to this PositiveRotation.

bool sgdk::PositiveRotation::isClockwise (   )  const [inline]

Returns true if this object is PositiveRotation::CLOCKWISE, false otherwise. Returns: true if the Compass to which this object is passed will identify clockwise rotation as upward from the zero-degree direction, false otherwise.

bool sgdk::PositiveRotation::isCounterclockwise (   )  const [inline]

Returns true if this object is PositiveRotation::COUNTERCLOCKWISE, false otherwise. Returns: true if the Compass to which this object is passed will identify counterclockwise rotation as upward from the zero-degree direction, false otherwise.

---

Member Data Documentation

const PositiveRotation sgdk::PositiveRotation::CLOCKWISE [static]

If this object is passed into either Compass::Compass() or Compass::setPositiveRotation(), then the Compass will identify clockwise rotation as upward from the zero-degree direction.

const PositiveRotation sgdk::PositiveRotation::COUNTERCLOCKWISE [static]

If this object is passed into either Compass::Compass() or Compass::setPositiveRotation(), then the Compass will identify counterclockwise rotation as upward from the zero-degree direction.

---

Swiss GD Knife is hosted by .