om::graphics::textures::TextureFace Class Reference

A class that represents a particular face of a texture. More...

#include <omGraphicsTextureFace.h>

Public Types
enum	Enum {   POSITIVE_X = 0, FRONT = 0, NEGATIVE_X = 1, POSITIVE_Y = 2,   NEGATIVE_Y = 3, POSITIVE_Z = 4, NEGATIVE_Z = 5, UNDEFINED }
	An enum that specifies the different allowed texture faces. More...

Public Member Functions
	TextureFace (Enum newType)
	Create a new texture face type with the specified face type enum value. More...
	TextureFace (Index faceIndex)
	Create a new texture face type with the specified face index. More...
Vector3	getDirection () const
	Return a 3D vector indicating the cannonical direction for this texture face. More...
	operator Enum () const
	Convert this texture wrap type to an enum value. More...
String	toString () const
	Return a string representation of the texture face type. More...
	operator String () const
	Convert this texture face type into a string representation. More...

Static Public Member Functions
static Size	getMaxFaceCount ()
	Return the maximum number of faces that a texture can have. More...

Detailed Description

A class that represents a particular face of a texture.

While most common textures have only a single face (FRONT), cube map textures may have six faces for the six axial directions of a cube. This class allows the user to specify a particular face of that cube map.

Member Enumeration Documentation

enum om::graphics::textures::TextureFace::Enum

An enum that specifies the different allowed texture faces.

Enumerator
POSITIVE_X	The face of the cube map in the positive X direction (front face).
FRONT	The front face of a texture (face in the positive X direction).
NEGATIVE_X	The face of the cube map in the negative X direction.
POSITIVE_Y	The face of the cube map in the positive Y direction.
NEGATIVE_Y	The face of the cube map in the negative Y direction.
POSITIVE_Z	The face of the cube map in the positive Z direction.
NEGATIVE_Z	The face of the cube map in the negative Z direction.
UNDEFINED	An undefined face of a texture.

Constructor & Destructor Documentation

om::graphics::textures::TextureFace::TextureFace ( Enum  newType )

inline

Create a new texture face type with the specified face type enum value.

om::graphics::textures::TextureFace::TextureFace ( Index  faceIndex )

inline

Create a new texture face type with the specified face index.

Member Function Documentation

static Size om::graphics::textures::TextureFace::getMaxFaceCount ( )

inlinestatic

Return the maximum number of faces that a texture can have.

Vector3 om::graphics::textures::TextureFace::getDirection

(

)

const

Return a 3D vector indicating the cannonical direction for this texture face.

om::graphics::textures::TextureFace::operator Enum ( ) const

inline

Convert this texture wrap type to an enum value.

String om::graphics::textures::TextureFace::toString

(

)

const

Return a string representation of the texture face type.

om::graphics::textures::TextureFace::operator String ( ) const

inline

Convert this texture face type into a string representation.

---

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

• omGraphicsTextureFace.h