VRUT::Image Class Reference

Baseclass for image container - abstract. More...

#include <image.h>

Inheritance diagram for VRUT::Image:

VRUT::ImageCommon VRUT::ImageDDS

List of all members.

Public Member Functions

 Image ()
 Class constructor.
virtual ~Image ()
 Class destructor.
virtual bool IsOk () const =0
 Is image properly loaded?
const wxFileName * GetFilename () const
 Get filename.
virtual bool Load (const wxString &fname)
 Load image data from file.
virtual GLuint BuildOglTexture () const =0
virtual bool HasTransparency () const =0
 Get true if image has alpha channel.
virtual int GetWidth () const =0
 Get the widht of the image.
virtual int GetHeight () const =0
 Get the height of the image.

Protected Attributes

wxFileName filename
 Path to file with image data.


Detailed Description

Baseclass for image container - abstract.

Definition at line 23 of file image.h.


Constructor & Destructor Documentation

VRUT::Image::Image (  )  [inline]

Class constructor.

Definition at line 31 of file image.h.

00031 {}

virtual VRUT::Image::~Image (  )  [inline, virtual]

Class destructor.

Definition at line 33 of file image.h.

00033 {}


Member Function Documentation

virtual bool VRUT::Image::IsOk (  )  const [pure virtual]

Is image properly loaded?

Implemented in VRUT::ImageCommon, and VRUT::ImageDDS.

const wxFileName* VRUT::Image::GetFilename (  )  const [inline]

Get filename.

Definition at line 38 of file image.h.

00039               {
00040                      return &filename;
00041               }

virtual bool VRUT::Image::Load ( const wxString &  fname  )  [inline, virtual]

Load image data from file.

Reimplemented in VRUT::ImageCommon, and VRUT::ImageDDS.

Definition at line 43 of file image.h.

00044               {
00045                      if (wxFileName::FileExists(fname))
00046                      {
00047                             filename.Assign(fname);
00048                             return true;
00049                      }
00050                      return false;
00051               }

virtual GLuint VRUT::Image::BuildOglTexture (  )  const [pure virtual]

Build and bind OpenGL texture from image in CURRENT OpenGL context, doesn't store the new ID

Returns:
OpenGL ID for texture, GL_ID_NONE if failed

Implemented in VRUT::ImageCommon, and VRUT::ImageDDS.

virtual bool VRUT::Image::HasTransparency (  )  const [pure virtual]

Get true if image has alpha channel.

Implemented in VRUT::ImageCommon, and VRUT::ImageDDS.

virtual int VRUT::Image::GetWidth (  )  const [pure virtual]

Get the widht of the image.

Implemented in VRUT::ImageCommon, and VRUT::ImageDDS.

virtual int VRUT::Image::GetHeight (  )  const [pure virtual]

Get the height of the image.

Implemented in VRUT::ImageCommon, and VRUT::ImageDDS.


Member Data Documentation

wxFileName VRUT::Image::filename [protected]

Path to file with image data.

Definition at line 27 of file image.h.


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

Generated on Tue Mar 10 14:41:43 2009 for VRUT by  doxygen 1.5.5