om::graphics::cameras::CameraType Class Reference

A class that encapsulates a type for a Camera. More...

#include <omGraphicsCameraType.h>

Public Member Functions
	CameraType (const Type &newType)
	Create a CameraType object with the specified internal type. More...
	CameraType (const Char *string)
	Create a CameraType object with the specified string type. More...
	CameraType (const UTF8String &newTypeString)
	Create a CameraType object with the specified string type. More...
Bool	operator== (const CameraType &other) const
	Return whether or not this camera type is equal to another. More...
Bool	operator!= (const CameraType &other) const
	Return whether or not this camera type is not equal to another. More...
CameraTypeID	getID () const
	Return an integer identifying this camera type. More...
	operator const UTF8String & () const
	Get a string representing the implementation-defined name of this type. More...
const UTF8String &	toString () const
	Get a string representing the implementation-defined name of this type. More...
const UTF8String &	getName () const
	Get a string representing the implementation-defined name of this type. More...

Static Public Member Functions
template<typename T >
static const CameraType &	of ()
	Return a CameraType object for the specified type template parameter. More...

Public Attributes
UTF8String	type
	A string object representing the internal type for this CameraType. More...

Detailed Description

A class that encapsulates a type for a Camera.

Constructor & Destructor Documentation

om::graphics::cameras::CameraType::CameraType ( const Type &  newType )

inline

Create a CameraType object with the specified internal type.

om::graphics::cameras::CameraType::CameraType ( const Char *  string )

inline

Create a CameraType object with the specified string type.

om::graphics::cameras::CameraType::CameraType ( const UTF8String &  newTypeString )

inline

Create a CameraType object with the specified string type.

Member Function Documentation

template<typename T >

static const CameraType& om::graphics::cameras::CameraType::of ( )

inlinestatic

Return a CameraType object for the specified type template parameter.

Bool om::graphics::cameras::CameraType::operator== ( const CameraType &  other ) const

inline

Return whether or not this camera type is equal to another.

Bool om::graphics::cameras::CameraType::operator!= ( const CameraType &  other ) const

inline

Return whether or not this camera type is not equal to another.

CameraTypeID om::graphics::cameras::CameraType::getID ( ) const

inline

Return an integer identifying this camera type.

This ID is a 32-bit integer that is generated by hashing the string generated for a type template parameter. While the posibility of ID collisions is very low, duplicates are nonetheless a possibility.

om::graphics::cameras::CameraType::operator const UTF8String & ( ) const

inline

Get a string representing the implementation-defined name of this type.

const UTF8String& om::graphics::cameras::CameraType::toString ( ) const

inline

Get a string representing the implementation-defined name of this type.

const UTF8String& om::graphics::cameras::CameraType::getName ( ) const

inline

Get a string representing the implementation-defined name of this type.

Member Data Documentation

UTF8String om::graphics::cameras::CameraType::type

A string object representing the internal type for this CameraType.

---

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

• omGraphicsCameraType.h