om::graphics::gui::base::Axis Class Reference

A class that represents a cartesian axis direction. More...

#include <omGraphicsGUIAxis.h>

Public Types
enum	Enum { X = 0, Y = 1, Z = 2, W = 3 }
	An enum that specifies the different standard axes. More...

Public Member Functions
	Axis (Enum newAxis)
	Create a new orientation using the specified axis type enum value. More...
Index	getIndex () const
	Convert this axis to its index (0 = X, 1 = Y, 2 = Z). More...
	operator Enum () const
	Convert this axis to an enum value. More...
String	toString () const
	Return a string representation of the axis. More...
	operator String () const
	Convert this axis into a string representation. More...

Detailed Description

A class that represents a cartesian axis direction.

This class can be used to specify how certain GUI elements are rotated, allowing them to specify an orientation aligned with a given axis.

Member Enumeration Documentation

enum om::graphics::gui::base::Axis::Enum

An enum that specifies the different standard axes.

Enumerator
X	The X axis (horizontal) with index 0.
Y	The Y axis (vertical) with index 1.
Z	The Z axis (depth) with index 2.
W	The W axis with index 3.

Constructor & Destructor Documentation

om::graphics::gui::base::Axis::Axis ( Enum  newAxis )

inline

Create a new orientation using the specified axis type enum value.

Member Function Documentation

Index om::graphics::gui::base::Axis::getIndex ( ) const

inline

Convert this axis to its index (0 = X, 1 = Y, 2 = Z).

om::graphics::gui::base::Axis::operator Enum ( ) const

inline

Convert this axis to an enum value.

String om::graphics::gui::base::Axis::toString

(

)

const

Return a string representation of the axis.

om::graphics::gui::base::Axis::operator String ( ) const

inline

Convert this axis into a string representation.

---

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

• omGraphicsGUIAxis.h