Alphabetical Class Index  Class Hierarchy   File Members   Compound Members   File List  

HIOUtilityTiff Class Reference

#include <HIOUtilityTiff.h>

List of all members.

Public Member Functions

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 * GetOutputName ()
HOutputHandlerStyle GetOutputStyle ()
const char * GetOutputTypesString ()
 HIOUtilityTiff ()
void RegisterOutputHandlerTypes ()

Detailed Description

The HIOUtilityTiff allows you to export TIFF images. This class is currently unsupported with the LeadTools Raster Pro Toolkit being the recommended way of importing or exporting raster data.


Constructor & Destructor Documentation

HIOUtilityTiff::HIOUtilityTiff ( ) [inline]

Member Function Documentation

HFileOutputResult HIOUtilityTiff::FileOutputFromImageKey ( const __wchar_t *  filename,
HC_KEY  image_key,
HOutputHandlerOptions options 
) [virtual]

This method exports the raster data defined in the HOOPS Image from the given image_key to a TIFF file.

Parameters:
FileNameA character pointer denoting the name of the image file to read from.
image_keyThe pointer to a HOOPS key that will be filled in with a HOOPS image key.
segment_keyThe HOOPS segment key to create the image_key in i.e. the working segment.
optionsThis parameter is currently not being used.
Returns:
The #HFileOutputResult result of the operation.

Reimplemented from HOutputHandler.

HFileOutputResult HIOUtilityTiff::FileOutputFromImageKey ( const char *  filename,
HC_KEY  image_key,
HOutputHandlerOptions options 
) [inline, 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:
filenameThe name of the file to output.
image_keyThe HOOPS image key to get output image data from.
optionsThe options class containing any needed extra information for the operation.
Returns:
The #HFileOutputResult result of the output operation.

Reimplemented from HOutputHandler.

References HOutputHandler::FileOutputFromImageKey().

const char* HIOUtilityTiff::GetOutputName ( ) [inline, virtual]
Returns:
A character pointer denoting the name of the handler.

Implements HOutputHandler.

HOutputHandlerStyle HIOUtilityTiff::GetOutputStyle ( ) [inline, virtual]
Returns:
The type of output style which is HOutputHandlerStyleImage.

Implements HOutputHandler.

References HOutputHandlerStyleImage.

const char* HIOUtilityTiff::GetOutputTypesString ( ) [inline, virtual]
Returns:
The string of the type of output this handler creates which are "tiff" and "tif".

Implements HOutputHandler.

void HIOUtilityTiff::RegisterOutputHandlerTypes ( ) [inline, virtual]

This method registers the "tiff" and "tif" extensions to this handler as an output handler.

Implements HOutputHandler.

References HIORegisterOutputType.


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