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

HIONoticeCallback *	SetInputInformationNoticeCallback (HIONoticeCallback *notice_callback)

HIOPercentNoticeCallback *	SetInputPercentProgressNoticeCallback (HIOPercentNoticeCallback *percent_notice_callback)

HIONoticeCallback *	SetInputProgressNoticeCallback (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)

HIONoticeCallback *	SetOutputInformationNoticeCallback (HIONoticeCallback *notice_callback)

HIOPercentNoticeCallback *	SetOutputPercentProgressNoticeCallback (HIOPercentNoticeCallback *percent_notice_callback)

HIONoticeCallback *	SetOutputProgressNoticeCallback (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

Constructs an HIOUtilityLeadTools object.

References HInputOpFileInputToImageKey, HOutputOpFileOutputFromImageKey, HInputHandler::SetInputOps(), and HOutputHandler::SetOutputOps().

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

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.

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

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.