OpenGUI::Imagery

OpenGUI::Imagery Class Reference

#include <OpenGUI_Imagery.h>

List of all members.

Detailed Description

Defines a sub area of an Imageset.


Public Member Functions

const FRect & getTextureUVRect () const
 Returns the FRect that defines the Texture UVs for this Imagery within the Imageset.
const IRect & getImagesetRect () const
 Returns the IRect that was used to define the Imagery within the Imageset.
TexturePtr getTexture () const
 Returns a pointer to the Texture object for this Imagery's parent Imageset.
const String & getName () const
 Returns the name of this Imagery object.
const String & getFQN () const
 Returns the fully qualified name of this Imagery object.

Member Function Documentation

const String & OpenGUI::Imagery::getFQN (   )  const
 

Returns the fully qualified name of this Imagery object.

const IRect & OpenGUI::Imagery::getImagesetRect (   )  const
 

Returns the IRect that was used to define the Imagery within the Imageset.

If the Imagery was created by defining UV coordinates, rather than a pixel based rect, then a pixel rect will be calculated based on the UVs. (This is mostly accurate, but not 100% perfect, so some error may occur.)

const String & OpenGUI::Imagery::getName (   )  const
 

Returns the name of this Imagery object.

TexturePtr OpenGUI::Imagery::getTexture (   )  const
 

Returns a pointer to the Texture object for this Imagery's parent Imageset.

const FRect & OpenGUI::Imagery::getTextureUVRect (   )  const
 

Returns the FRect that defines the Texture UVs for this Imagery within the Imageset.

The documentation for this class was generated from the following files:
Copyright © 2006 OpenGUI | OpenGUI.SF.net
Generated: Sun Sep 9 02:00:21 2007