HIOUtilityMagick

Functions

~HIOUtilityMagick

char const *

GetOutputName

char const *

GetInputName

void

RegisterInputHandlerTypes

HInputHandlerStyle

GetInputStyle

char const *

GetInputTypesString

HFileIOResult

FileInputToImageKey

HFileIOResult

FileInputToImageKey

HFileIOResult

FileInputToImageKey

void

RegisterOutputHandlerTypes

HOutputHandlerStyle

GetOutputStyle

char const *

GetOutputTypesString

HFileIOResult

FileOutputFromImageKey

HFileIOResult

FileOutputFromImageKey

HFileIOResult

FileOutputFromImageKey

HIOUtilityMagick

Detailed Description

class HIOUtilityMagick : public HInputHandler, public HOutputHandler

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/

Public Functions

~HIOUtilityMagick()
virtual char const *GetOutputName()
Returns

A character pointer denoting the name of the handler.

virtual char const *GetInputName()
Returns

A character pointer denoting the name of the input handler.

virtual void RegisterInputHandlerTypes()

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

virtual HInputHandlerStyle GetInputStyle()
Returns

The type of input style which is HInputHandlerStyleImage.

virtual char const *GetInputTypesString()
Returns

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

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

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.

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

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.

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

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.

virtual void RegisterOutputHandlerTypes()

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

virtual HOutputHandlerStyle GetOutputStyle()
Returns

The type of output style which is HOutputHandlerStyleImage.

virtual char const *GetOutputTypesString()
Returns

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

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

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.

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

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.

HIOUtilityMagick()

Constructs an HIOUtilityMagick object.