IMG_TileOptions Class Reference

#include <IMG_TileOptions.h>

List of all members.

Public Member Functions

 IMG_TileOptions ()
 If the format is a null pointer, it will be inferred from the filename.
virtual ~IMG_TileOptions ()
virtual IMG_TileOptionsclone () const
 Create a new copy of myself.
void setPlaneInfo (const char *filename, const char *channel, const char *format, IMG_DataType dtype=IMG_DT_ANY, IMG_ColorModel cmodel=IMG_CM_ANY)
bool changeFileExtension ()
void clearOptions ()
void setFormatOptions (const char *string)
void setFormatOptions (int argc, char *argv[])
void setFormatOptions (const UT_StringArray &options)
void setFormatOption (const char *token, const char *value)
void setFormatOptions (const UT_Options &options)
virtual const IMG_FormatgetFormat () const
const char * getFilename () const
const char * getChannel () const
const char * getFormatName () const
IMG_DataType getDataType () const
IMG_ColorModel getColorModel () const
const UT_OptionsgetLocalOptions () const
virtual bool getOption (const char *token, UT_String &value) const
virtual void setTextureOptions (UT_Options &options)
virtual int packOptionsString (UT_String &result) const

Protected Member Functions

void copy (const IMG_TileOptions &src)

Protected Attributes

UT_String myFilename
UT_String myChannel
UT_String myFormatName
IMG_DataType myDataType
IMG_ColorModel myColorModel
UT_Options myOptions


Detailed Description

Definition at line 29 of file IMG_TileOptions.h.


Constructor & Destructor Documentation

IMG_TileOptions::IMG_TileOptions (  ) 

If the format is a null pointer, it will be inferred from the filename.

virtual IMG_TileOptions::~IMG_TileOptions (  )  [virtual]


Member Function Documentation

bool IMG_TileOptions::changeFileExtension (  ) 

void IMG_TileOptions::clearOptions (  ) 

There are sevaral ways to set format options: 1) A sting (which is parsed into token/value pairs) 2) A set of token/value pairs specified as a linear array

virtual IMG_TileOptions* IMG_TileOptions::clone (  )  const [virtual]

Create a new copy of myself.

void IMG_TileOptions::copy ( const IMG_TileOptions src  )  [protected]

const char* IMG_TileOptions::getChannel (  )  const

IMG_ColorModel IMG_TileOptions::getColorModel (  )  const

IMG_DataType IMG_TileOptions::getDataType (  )  const

const char* IMG_TileOptions::getFilename (  )  const

virtual const IMG_Format* IMG_TileOptions::getFormat (  )  const [virtual]

Get the IMG_Format associated with these options. This will possibly return a null ptr.

const char* IMG_TileOptions::getFormatName (  )  const

const UT_Options& IMG_TileOptions::getLocalOptions (  )  const

virtual bool IMG_TileOptions::getOption ( const char *  token,
UT_String value 
) const [virtual]

Getting the option will return true/false based on whether the option was defined. If the option was not defined, the value will not be touched (i.e. it will remain unchanged).

virtual int IMG_TileOptions::packOptionsString ( UT_String result  )  const [virtual]

Pack all options into a single string. Returns the number of options packed.

void IMG_TileOptions::setFormatOption ( const char *  token,
const char *  value 
)

void IMG_TileOptions::setFormatOptions ( const UT_Options options  ) 

void IMG_TileOptions::setFormatOptions ( const UT_StringArray options  ) 

void IMG_TileOptions::setFormatOptions ( int  argc,
char *  argv[] 
)

void IMG_TileOptions::setFormatOptions ( const char *  string  ) 

void IMG_TileOptions::setPlaneInfo ( const char *  filename,
const char *  channel,
const char *  format,
IMG_DataType  dtype = IMG_DT_ANY,
IMG_ColorModel  cmodel = IMG_CM_ANY 
)

virtual void IMG_TileOptions::setTextureOptions ( UT_Options options  )  [virtual]

Texture options are only output for specific file formats. These texture options are used to pass information from the calling application to the device (where required). The application can write directly to the UT_Options, which will then be output in the file.


Member Data Documentation

Definition at line 88 of file IMG_TileOptions.h.

Definition at line 91 of file IMG_TileOptions.h.

Definition at line 90 of file IMG_TileOptions.h.

Definition at line 87 of file IMG_TileOptions.h.

Definition at line 89 of file IMG_TileOptions.h.

Definition at line 92 of file IMG_TileOptions.h.


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

Generated on Fri May 25 00:10:30 2012 for HDK by  doxygen 1.5.9