HIOUtilityImage

class HIOUtilityImage

HIOUtilityImage handles reading and writing raster images. PNG files are processed directly via libpng. All other formats (JPEG, BMP, GIF, TIFF, TGA) are delegated to ImageMagick.

Inherits from: HInputHandler, HOutputHandler

Methods

HIOUtilityImage::~HIOUtilityImage()
char const *HIOUtilityImage::GetOutputName()

Returns

A character pointer denoting the name of the handler.
char const *HIOUtilityImage::GetInputName()
void HIOUtilityImage::RegisterInputHandlerTypes()

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

HInputHandlerStyle HIOUtilityImage::GetInputStyle()

Returns

The type of input style which is #HInputHandlerStyleImage.
char const *HIOUtilityImage::GetInputTypesString()

Returns

The input extension types that are handled by HIOUtilityImage which include “jpeg”, “gif”, “bmp” and “tif”.
HFileInputResult HIOUtilityImage::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.
HFileInputResult HIOUtilityImage::FileInputToImageKey(unsigned short const *filename, HC_KEY *image_key, HC_KEY segment_key, HInputHandlerOptions *options)
HFileInputResult HIOUtilityImage::FileInputToImageKey(char const *filename, HC_KEY *image_key, HC_KEY segment_key, HInputHandlerOptions *options)
void HIOUtilityImage::RegisterOutputHandlerTypes()

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

HOutputHandlerStyle HIOUtilityImage::GetOutputStyle()

Returns

The type of output style which is #HOutputHandlerStyleImage.
char const *HIOUtilityImage::GetOutputTypesString()

Returns

The output extension types that are handled by HIOUtilityImage which include “jpeg”, “gif”, “bmp” and “tif”.
HFileOutputResult HIOUtilityImage::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.
HFileOutputResult HIOUtilityImage::FileOutputFromImageKey(unsigned short const *filename, HC_KEY image_key, HOutputHandlerOptions *options)
HFileOutputResult HIOUtilityImage::FileOutputFromImageKey(char const *filename, HC_KEY image_key, HOutputHandlerOptions *options)
HIOUtilityImage::HIOUtilityImage()

Constructs an HIOUtilityImage object.