Alphabetical Class Index  Class Hierarchy   File Members   Compound Members   File List  

HIOUtilityMagick Class Reference

#include <HIOUtilityMagick.h>

Inheritance diagram for HIOUtilityMagick:

HInputHandler HOutputHandler

List of all members.

Public Member Functions

HFileInputResult FileInputToImageKey (const char *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 __wchar_t *filename, HC_KEY *image_key, HC_KEY segment_key, HInputHandlerOptions *options)
HFileOutputResult FileOutputFromImageKey (const char *filename, HC_KEY image_key, HOutputHandlerOptions *options)
HFileOutputResult FileOutputFromImageKey (const unsigned short *filename, HC_KEY image_key, HOutputHandlerOptions *options)
HFileOutputResult FileOutputFromImageKey (const __wchar_t *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 ()


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

Constructs an HIOUtilityMagick object.


Member Function Documentation

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 infromation for operation.
Returns:
The HFileInputResult result of the input operation.

Reimplemented from HInputHandler.

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 ie. the working segment.
options An options class containing any needed extra infromation for operation.
Returns:
The HFileInputResult result of the input operation.

Reimplemented from HInputHandler.

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.

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 implimented 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.

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.

const char* HIOUtilityMagick::GetInputName (  )  [virtual]

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

Implements HInputHandler.

HInputHandlerStyle HIOUtilityMagick::GetInputStyle (  )  [virtual]

Returns:
The type of input style which is HInputHandlerStyleImage.

Implements HInputHandler.

const char* HIOUtilityMagick::GetInputTypesString (  )  [virtual]

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

Implements HInputHandler.

const char* HIOUtilityMagick::GetOutputName (  )  [virtual]

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

Implements HOutputHandler.

HOutputHandlerStyle HIOUtilityMagick::GetOutputStyle (  )  [virtual]

Returns:
The type of output style which is HOutputHandlerStyleImage.

Implements HOutputHandler.

const char* HIOUtilityMagick::GetOutputTypesString (  )  [virtual]

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

Implements HOutputHandler.

void HIOUtilityMagick::RegisterInputHandlerTypes (  )  [virtual]

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

Implements HInputHandler.

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: