#include <HIOUtilityMagick.h>

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)

HFileOutputResult	FileOutputFromImageKey (const __wchar_t filename, HC_KEY image_key, HOutputHandlerOptions options)

HFileOutputResult	FileOutputFromImageKey (const unsigned short filename, HC_KEY image_key, HOutputHandlerOptions options)

HFileOutputResult	FileOutputFromImageKey (const char filename, HC_KEY image_key, HOutputHandlerOptions options)

const char *	GetInputName ()

HInputHandlerStyle	GetInputStyle ()

const char *	GetInputTypesString ()

const char *	GetOutputName ()

HOutputHandlerStyle	GetOutputStyle ()

const char *	GetOutputTypesString ()

	HIOUtilityMagick ()

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)

const __wchar_t *	GetInputInformation ()

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 const char *	GetOutputDefaultHSRA ()

const __wchar_t *	GetOutputInformation ()

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

HIOUtilityMagick is the integration class for the ImageMagick toolkit. This integration is supported on all HOOPS platforms.

The windows distribution of HOOPS/3dF redistributes the ImageMagick development libraries for WIN32. These are located in Dev_Tools/3rdParty/ImageMagick.

For information on ImageMagick see: http://www.imagemagick.org/

Constructor & Destructor Documentation

◆ HIOUtilityMagick()

HIOUtilityMagick::HIOUtilityMagick ( )

Constructs an HIOUtilityMagick object.

Member Function Documentation

◆ FileInputToImageKey() [1/3]

HFileInputResult HIOUtilityMagick::FileInputToImageKey	(	const __wchar_t *	filename,
		HC_KEY *	image_key,
		HC_KEY	segment_key,
		HInputHandlerOptions *	options
	)

virtual

This method maps 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.

◆ FileInputToImageKey() [2/3]

HFileInputResult HIOUtilityMagick::FileInputToImageKey	(	const unsigned short *	filename,
		HC_KEY *	image_key,
		HC_KEY	segment_key,
		HInputHandlerOptions *	options
	)

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

filename	The UNICODE name of the file to load.
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	An options class containing any needed extra information for operation.

Returns: The HFileInputResult result of the input operation.

Reimplemented from HInputHandler.

◆ FileInputToImageKey() [3/3]

HFileInputResult HIOUtilityMagick::FileInputToImageKey	(	const char *	filename,
		HC_KEY *	image_key,
		HC_KEY	segment_key,
		HInputHandlerOptions *	options
	)

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

filename	The name of the file to load.
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 ie. the working segment.
options	An options class containing any needed extra information for operation.

Returns: The HFileInputResult result of the input operation.

Reimplemented from HInputHandler.

◆ FileOutputFromImageKey() [1/2]

HFileOutputResult HIOUtilityMagick::FileOutputFromImageKey	(	const __wchar_t *	filename,
		HC_KEY	image_key,
		HOutputHandlerOptions *	options
	)

virtual

This method exports the raster data contained in image_key to 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.

Reimplemented from HOutputHandler.

◆ FileOutputFromImageKey() [2/2]

HFileOutputResult HIOUtilityMagick::FileOutputFromImageKey	(	const char *	filename,
		HC_KEY	image_key,
		HOutputHandlerOptions *	options
	)

virtual

This method writes image data from a given HOOPS key to a given output file. Note that this must be implemented in a subclassed HOutputHandler instance handling images. This must be implemented in a subclassed HOutputHandler instance handling images.

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.

Reimplemented from HOutputHandler.

◆ GetInputName()

const char* HIOUtilityMagick::GetInputName ( )

virtual

Returns: A character pointer denoting the name of the input handler.

Implements HInputHandler.

◆ GetInputStyle()

HInputHandlerStyle HIOUtilityMagick::GetInputStyle ( )

virtual

Returns: The type of input style which is HInputHandlerStyleImage.

Implements HInputHandler.

◆ GetInputTypesString()

const char* HIOUtilityMagick::GetInputTypesString ( )

virtual

Returns: The input extension types that are handled by HIOUtilityMagick which include "jpeg", "gif", "bmp" and "tif".

Implements HInputHandler.

◆ GetOutputName()

const char* HIOUtilityMagick::GetOutputName ( )

virtual

Returns: A character pointer denoting the name of the handler.

Implements HOutputHandler.

◆ GetOutputStyle()

HOutputHandlerStyle HIOUtilityMagick::GetOutputStyle ( )

virtual

Returns: The type of output style which is HOutputHandlerStyleImage.

Implements HOutputHandler.

◆ GetOutputTypesString()

const char* HIOUtilityMagick::GetOutputTypesString ( )

virtual

Returns: The output extension types that are handled by HIOUtilityMagick which include "jpeg", "gif", "bmp" and "tif".

Implements HOutputHandler.

◆ RegisterInputHandlerTypes()

void HIOUtilityMagick::RegisterInputHandlerTypes ( )

virtual

This method registers the image types that are supported by ImageMagick for reading.

Implements HInputHandler.

◆ RegisterOutputHandlerTypes()

void HIOUtilityMagick::RegisterOutputHandlerTypes ( )

virtual

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

Implements HOutputHandler.

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

HIOUtilityMagick.h

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ HIOUtilityMagick()

Member Function Documentation

◆ FileInputToImageKey() [1/3]

◆ FileInputToImageKey() [2/3]

◆ FileInputToImageKey() [3/3]

◆ FileOutputFromImageKey() [1/2]

◆ FileOutputFromImageKey() [2/2]

◆ GetInputName()

◆ GetInputStyle()

◆ GetInputTypesString()

◆ GetOutputName()

◆ GetOutputStyle()

◆ GetOutputTypesString()

◆ RegisterInputHandlerTypes()

◆ RegisterOutputHandlerTypes()