HIOUtilityLeadTools

Functions

HIOUtilityLeadTools

~HIOUtilityLeadTools

void

RegisterInputHandlerTypes

HInputHandlerStyle

GetInputStyle

char const *

GetInputTypesString

HFileIOResult

FileInputToImageKey

void

RegisterOutputHandlerTypes

HOutputHandlerStyle

GetOutputStyle

char const *

GetOutputTypesString

HFileIOResult

FileOutputFromImageKey

Detailed Description

class HIOUtilityLeadTools : public HInputHandler, public HOutputHandler

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.

Public Functions

inline HIOUtilityLeadTools()

Constructs an HIOUtilityLeadTools object.

inline ~HIOUtilityLeadTools()
inline virtual void RegisterInputHandlerTypes()

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

inline virtual HInputHandlerStyle GetInputStyle()
Returns:

The type of input style which is HInputHandlerStyleImage.

inline virtual char const *GetInputTypesString()
Returns:

The input extension types that are handled by HIOUtilityLeadTools which include “jpeg”, “gif”, “bmp” and “tif”.

virtual HFileIOResult FileInputToImageKey(char const *filename, HC_KEY *image_key, HC_KEY segment_key, HInputHandlerOptions *options)

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

Parameters:
  • FileName – A character pointer denoting the name of the image file to read from.

  • image_key – The pointer to a HOOPS key that will be filled in with a HOOPS image key.

  • segment_key – The HOOPS segment key to create the image_key in i.e. the working segment.

  • options – The file input options.

Returns:

The #HFileOutputResult result of the operation.

inline virtual void RegisterOutputHandlerTypes()

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

inline virtual HOutputHandlerStyle GetOutputStyle()
Returns:

The type of output style which is HOutputHandlerStyleImage.

inline virtual char const *GetOutputTypesString()
Returns:

The output extension types that are handled by HIOUtilityLeadTools which include “jpeg”, “gif”, “bmp” and “tif”.

virtual HFileIOResult FileOutputFromImageKey(char const *filename, HC_KEY image_key, HOutputHandlerOptions *options)

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:
  • filename – The name of the file to output.

  • image_key – The HOOPS image key to get output image data from.

  • options – The options class containing any needed extra information for the operation.

Returns:

The #HFileOutputResult result of the output operation.