Alphabetical Class Index  Class Hierarchy   File Members   Compound Members   File List  

HIOUtilityGif Class Reference

#include <HIOUtilityGif.h>

Public Member Functions

HFileInputResult FileInputToImageKey (const __wchar_t *filename, HC_KEY *image_key, HC_KEY segment_key, HInputHandlerOptions *options)
 
HFileInputResult FileInputToImageKey (const unsigned short *filename, HC_KEY *image_key, HC_KEY segment_key, HInputHandlerOptions *options)
 
HFileInputResult FileInputToImageKey (const char *filename, HC_KEY *image_key, HC_KEY segment_key, HInputHandlerOptions *options)
 
const char * GetInputName ()
 
HInputHandlerStyle GetInputStyle ()
 
const char * GetInputTypesString ()
 
 HIOUtilityGif ()
 
void RegisterInputHandlerTypes ()
 
- Public Member Functions inherited from HInputHandler
virtual HFileInputResult FileInputByKey (const char *filename, HC_KEY key, HInputHandlerOptions *options)
 
virtual HFileInputResult FileInputByKey (const __wchar_t *filename, HC_KEY key, HInputHandlerOptions *options)
 
virtual HFileInputResult FileInputByKey (const unsigned short *filename, HC_KEY key, HInputHandlerOptions *options)
 
const __wchar_t * GetInputInformation ()
 
unsigned long GetInputOps ()
 
float GetInputPercentProgress ()
 
const __wchar_t * GetInputProgress ()
 
 HInputHandler ()
 
void ReportInputInformation (const char *information)
 This posts information to the information queue.
 
void ReportInputInformation (const __wchar_t *information)
 
void ReportInputPercentProgress (float percent_progress)
 This posts the current percent progress should be between 0.0 and 1.0.
 
void ReportInputProgress (const char *progress)
 This posts the current progress message.
 
void ReportInputProgress (const __wchar_t *progress)
 
HIONoticeCallbackSetInputInformationNoticeCallback (HIONoticeCallback *notice_callback)
 
HIOPercentNoticeCallbackSetInputPercentProgressNoticeCallback (HIOPercentNoticeCallback *percent_notice_callback)
 
HIONoticeCallbackSetInputProgressNoticeCallback (HIONoticeCallback *notice_callback)
 
void SetModuleDirectory (const char *module_directory)
 
void SetModuleDirectory (const __wchar_t *module_directory)
 

Additional Inherited Members

- Protected Member Functions inherited from HInputHandler
void SetFinishedInput ()
 
void SetInputOps (unsigned long ops)
 This sets the HInputOp.
 
void SetStartingInput (const char *filename)
 
void SetStartingInput (const __wchar_t *filename=0)
 
- Protected Attributes inherited from HInputHandler
unsigned long m_InputOps
 This is the HInputOp set for a subclassed instance.
 
__wchar_t * m_module_directory
 

Detailed Description

The HIOUtilityGif allows you to read in GIF images. This class is currently unsupported with the LeadTools Raster Pro Toolkit being the recommended way of importing or exporting raster data.

Constructor & Destructor Documentation

HIOUtilityGif::HIOUtilityGif ( )
inline

Member Function Documentation

HFileInputResult HIOUtilityGif::FileInputToImageKey ( const __wchar_t *  filename,
HC_KEY image_key,
HC_KEY  segment_key,
HInputHandlerOptions options 
)
virtual

This method reads the raster data defined in filename into a HOOPS image in the key segment.

Parameters
FileNameA character pointer denoting the name of the image file to read from.
image_keyThe pointer to a HOOPS key that will be filled in with a HOOPS image key.
segment_keyThe HOOPS segment key to create the image_key in i.e. the working segment.
optionsThe file input options.
Returns
The #HFileOutputResult result of the operation.

Reimplemented from HInputHandler.

HFileInputResult HIOUtilityGif::FileInputToImageKey ( const unsigned short *  filename,
HC_KEY image_key,
HC_KEY  segment_key,
HInputHandlerOptions options 
)
inlinevirtual

This method loads image data from a given file to a given HOOPS image key. Note that this must be implemented in a sub-classed HInputHandler instance handling Images.

Parameters
filenameThe UNICODE name of the file to load.
image_keyThe pointer to a HOOPS key that will be filled in with a HOOPS image key.
segment_keyThe HOOPS segment key to create the image_key in ie. the working segment.
optionsAn options class containing any needed extra infromation for operation.
Returns
The HFileInputResult result of the input operation.

Reimplemented from HInputHandler.

References HInputHandler::FileInputToImageKey().

HFileInputResult HIOUtilityGif::FileInputToImageKey ( const char *  filename,
HC_KEY image_key,
HC_KEY  segment_key,
HInputHandlerOptions options 
)
inlinevirtual

This method loads image data from a given file to a given HOOPS image key. Note that this must be implemented in a sub-classed HInputHandler instance handling Images.

Parameters
filenameThe name of the file to load.
image_keyThe pointer to a HOOPS key that will be filled in with a HOOPS image key.
segment_keyThe HOOPS segment key to create the image_key in ie. the working segment.
optionsAn options class containing any needed extra infromation for operation.
Returns
The HFileInputResult result of the input operation.

Reimplemented from HInputHandler.

References HInputHandler::FileInputToImageKey().

const char* HIOUtilityGif::GetInputName ( )
inlinevirtual
Returns
A character pointer denoting the name of the handler.

Implements HInputHandler.

HInputHandlerStyle HIOUtilityGif::GetInputStyle ( )
inlinevirtual
Returns
The type of input style which is HInputHandlerStyleImage.

Implements HInputHandler.

References HInputHandlerStyleImage.

const char* HIOUtilityGif::GetInputTypesString ( )
inlinevirtual
Returns
The string of the type of input this handler creates which is "gif".

Implements HInputHandler.

void HIOUtilityGif::RegisterInputHandlerTypes ( )
inlinevirtual

This method registers the "gif" extension to this handler.

Implements HInputHandler.

References HIORegisterInputType.


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