Alphabetical Class Index  Class Hierarchy   File Members   Compound Members   File List  

HIOUtilityGif Class Reference

#include <HIOUtilityGif.h>

List of all members.

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 ()

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 
) [inline, virtual]

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 
) [inline, virtual]

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 ( ) [inline, virtual]
Returns:
A character pointer denoting the name of the handler.

Implements HInputHandler.

HInputHandlerStyle HIOUtilityGif::GetInputStyle ( ) [inline, virtual]
Returns:
The type of input style which is HInputHandlerStyleImage.

Implements HInputHandler.

References HInputHandlerStyleImage.

const char* HIOUtilityGif::GetInputTypesString ( ) [inline, virtual]
Returns:
The string of the type of input this handler creates which is "gif".

Implements HInputHandler.

void HIOUtilityGif::RegisterInputHandlerTypes ( ) [inline, virtual]

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

Implements HInputHandler.

References HIORegisterInputType.


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