HIOUtilityLeadTools Class Reference

#include <HIOUtilityLeadTools.h>

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 ()
 
- 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)
 
virtual HFileInputResult FileInputToImageKey (const __wchar_t *filename, HC_KEY *image_key, HC_KEY segment_key, HInputHandlerOptions *options)
 
virtual HFileInputResult FileInputToImageKey (const unsigned short *filename, HC_KEY *image_key, HC_KEY segment_key, HInputHandlerOptions *options)
 
const __wchar_t * GetInputInformation ()
 
virtual const char * GetInputName ()=0
 
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)
 
- Public Member Functions inherited from HOutputHandler
virtual HFileOutputResult FileOutputByKey (const char *filename, HC_KEY key, HOutputHandlerOptions *options)
 
virtual HFileOutputResult FileOutputByKey (const __wchar_t *filename, HC_KEY key, HOutputHandlerOptions *options)
 
virtual HFileOutputResult FileOutputByKey (const unsigned short *filename, HC_KEY key, HOutputHandlerOptions *options)
 
virtual HFileOutputResult FileOutputFromImageKey (const __wchar_t *filename, HC_KEY image_key, HOutputHandlerOptions *options)
 
virtual const char * GetOutputDefaultHSRA ()
 
const __wchar_t * GetOutputInformation ()
 
virtual const char * GetOutputName ()=0
 
unsigned long GetOutputOps ()
 
float GetOutputPercentProgress ()
 
const char * GetOutputProgress ()
 
 HOutputHandler ()
 
void ReportOutputInformation (const char *information)
 This posts information to the information queue.
 
void ReportOutputPercentProgress (float percent_progress)
 This posts the current percent progress message should be between 0.0 and 1.0.
 
void ReportOutputProgress (const char *progress)
 This posts the current progress message.
 
void SetModuleDirectory (const char *module_directory)
 
void SetModuleDirectory (const __wchar_t *module_directory)
 
HIONoticeCallbackSetOutputInformationNoticeCallback (HIONoticeCallback *notice_callback)
 
HIOPercentNoticeCallbackSetOutputPercentProgressNoticeCallback (HIOPercentNoticeCallback *percent_notice_callback)
 
HIONoticeCallbackSetOutputProgressNoticeCallback (HIONoticeCallback *notice_callback)
 

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 Member Functions inherited from HOutputHandler
void SetFinishedOutput ()
 
void SetOutputOps (unsigned long ops)
 This sets the HOutputOp.
 
void SetStartingOutput ()
 
- Protected Attributes inherited from HInputHandler
unsigned long m_InputOps
 This is the HInputOp set for a subclassed instance.
 
__wchar_t * m_module_directory
 
- Protected Attributes inherited from HOutputHandler
char * m_module_directory
 
unsigned long m_OutputOps
 This is the HOutputOp set for a subclassed instance.
 

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::HIOUtilityLeadTools ( )
inline

Member Function Documentation

◆ FileInputToImageKey()

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.

◆ FileOutputFromImageKey()

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.

◆ GetInputStyle()

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

Implements HInputHandler.

References HInputHandlerStyleImage.

◆ GetInputTypesString()

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

Implements HInputHandler.

◆ GetOutputStyle()

HOutputHandlerStyle HIOUtilityLeadTools::GetOutputStyle ( )
inlinevirtual
Returns
The type of output style which is HOutputHandlerStyleImage.

Implements HOutputHandler.

References HOutputHandlerStyleImage.

◆ GetOutputTypesString()

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

Implements HOutputHandler.

◆ RegisterInputHandlerTypes()

void HIOUtilityLeadTools::RegisterInputHandlerTypes ( )
inlinevirtual

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

Implements HInputHandler.

References HIORegisterInputType.

◆ RegisterOutputHandlerTypes()

void HIOUtilityLeadTools::RegisterOutputHandlerTypes ( )
inlinevirtual

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: