Alphabetical Class Index  Class Hierarchy   File Members   Compound Members   File List  

HIOUtilityLeadTools Class Reference

#include <HIOUtilityLeadTools.h>

List of all members.

Public Member Functions

HFileInputResult FileInputToImageKey (const char *filename, HC_KEY *image_key, HC_KEY segment_key, HInputHandlerOptions *options)
HFileOutputResult FileOutputFromImageKey (const char *filename, HC_KEY image_key, HOutputHandlerOptions *options)
HInputHandlerStyle GetInputStyle ()
const char * GetInputTypesString ()
HOutputHandlerStyle GetOutputStyle ()
const char * GetOutputTypesString ()
 HIOUtilityLeadTools ()
void RegisterInputHandlerTypes ()
void RegisterOutputHandlerTypes ()

Detailed Description

The HIOUtilityLeadTools is the integration class for the LeadTools Raster Pro toolkit. Using this integration class allows you to import and export the over 60 raster image types supported by the Raster Pro toolkit. To use this integration class you will need to obtain a license of the Raster Pro Toolkit.


Constructor & Destructor Documentation

HIOUtilityLeadTools::HIOUtilityLeadTools ( ) [inline]

Member Function Documentation

HFileInputResult HIOUtilityLeadTools::FileInputToImageKey ( const char *  filename,
HC_KEY image_key,
HC_KEY  segment_key,
HInputHandlerOptions options 
) [virtual]

This method reads the data in the image file to a HOOPS image defined by image_key.

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.

HFileOutputResult HIOUtilityLeadTools::FileOutputFromImageKey ( const char *  filename,
HC_KEY  image_key,
HOutputHandlerOptions options 
) [virtual]

This method exports the raster data contained in image_key as a file. It uses the file extension to determine what type of raster image to create.

Parameters:
filenameThe name of the file to output.
image_keyThe HOOPS image key to get output image data from.
optionsThe options class containing any needed extra information for the operation.
Returns:
The #HFileOutputResult result of the output operation.

Reimplemented from HOutputHandler.

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

Implements HInputHandler.

References HInputHandlerStyleImage.

const char* HIOUtilityLeadTools::GetInputTypesString ( ) [inline, virtual]
Returns:
The input extension types that are handled by HIOUtilityLeadTools which include "jpeg", "gif", "bmp" and "tif".

Implements HInputHandler.

HOutputHandlerStyle HIOUtilityLeadTools::GetOutputStyle ( ) [inline, virtual]
Returns:
The type of output style which is HOutputHandlerStyleImage.

Implements HOutputHandler.

References HOutputHandlerStyleImage.

const char* HIOUtilityLeadTools::GetOutputTypesString ( ) [inline, virtual]
Returns:
The output extension types that are handled by HIOUtilityLeadTools which include "jpeg", "gif", "bmp" and "tif".

Implements HOutputHandler.

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

This method registers the image types supported by the Raster Pro toolkit for reading.

Implements HInputHandler.

References HIORegisterInputType.

void HIOUtilityLeadTools::RegisterOutputHandlerTypes ( ) [inline, virtual]

This method registers the image types supported by the Raster Pro toolkit for writing.

Implements HOutputHandler.

References HIORegisterOutputType.


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