#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 () |
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/
HIOUtilityMagick::HIOUtilityMagick | ( | ) |
Constructs an HIOUtilityMagick object.
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.
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. |
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.
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. |
Reimplemented from HInputHandler.
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.
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. |
Reimplemented from HInputHandler.
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.
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. |
Reimplemented from HOutputHandler.
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.
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. |
Reimplemented from HOutputHandler.
const char* HIOUtilityMagick::GetInputName | ( | ) | [virtual] |
Implements HInputHandler.
HInputHandlerStyle HIOUtilityMagick::GetInputStyle | ( | ) | [virtual] |
Implements HInputHandler.
const char* HIOUtilityMagick::GetInputTypesString | ( | ) | [virtual] |
Implements HInputHandler.
const char* HIOUtilityMagick::GetOutputName | ( | ) | [virtual] |
Implements HOutputHandler.
HOutputHandlerStyle HIOUtilityMagick::GetOutputStyle | ( | ) | [virtual] |
Implements HOutputHandler.
const char* HIOUtilityMagick::GetOutputTypesString | ( | ) | [virtual] |
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.