Alphabetical Class Index  Class Hierarchy   File Members   Compound Members   File List  

HIOUtilityCGM Class Reference

#include <HIOUtilityHOOPS.h>

List of all members.

Public Member Functions

HFileOutputResult FileOutputByKey (const __wchar_t *filename, HC_KEY key, HOutputHandlerOptions *options)
HFileOutputResult FileOutputByKey (const unsigned short *filename, HC_KEY key, HOutputHandlerOptions *options)
HFileOutputResult FileOutputByKey (const char *filename, HC_KEY key, HOutputHandlerOptions *options)
const char * GetOutputDefaultHSRA ()
const char * GetOutputName ()
HOutputHandlerStyle GetOutputStyle ()
const char * GetOutputTypesString ()
 HIOUtilityCGM ()
void RegisterOutputHandlerTypes ()

Detailed Description

The HIOUtilityCGM is the class for writing CGM files using the HOOPS CGM driver.


Constructor & Destructor Documentation

HIOUtilityCGM::HIOUtilityCGM ( ) [inline]

Member Function Documentation

HFileOutputResult HIOUtilityCGM::FileOutputByKey ( const __wchar_t *  filename,
HC_KEY  key,
HOutputHandlerOptions options 
) [virtual]

This method writes a CGM file out of the segment tree underneath the given key.

Parameters:
filenameThe name of the file to output.
keyThe HOOPS segment key to get output data from.
optionsThe options class containing any needed extra information for the operation.
Returns:
The #HFileOutputResult result of the output operation.

Reimplemented from HOutputHandler.

HFileOutputResult HIOUtilityCGM::FileOutputByKey ( const unsigned short *  filename,
HC_KEY  key,
HOutputHandlerOptions options 
) [inline, virtual]

This method writes model data from a given HOOPS key to a given output file. Note that this must be implimented in a subclassed HOutputHandler instance handling models.

Parameters:
filenameThe wide character name of the file to output.
keyThe HOOPS segment key to get output model 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::FileOutputByKey().

HFileOutputResult HIOUtilityCGM::FileOutputByKey ( const char *  filename,
HC_KEY  key,
HOutputHandlerOptions options 
) [inline, virtual]

This method writes model data from a given HOOPS key to a given output file. Note that this must be implimented in a subclassed HOutputHandler instance handling models.

Parameters:
filenameThe name of the file to output.
keyThe HOOPS segment key to output model 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::FileOutputByKey().

const char* HIOUtilityCGM::GetOutputDefaultHSRA ( ) [inline, virtual]
Returns:
The default HSRA for the HIOUtilityCGM instance.

Reimplemented from HOutputHandler.

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

Implements HOutputHandler.

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

Implements HOutputHandler.

References HOutputHandlerStyleHardcopy.

const char* HIOUtilityCGM::GetOutputTypesString ( ) [inline, virtual]
Returns:
The string of the type of output this handler creates which is "cgm".

Implements HOutputHandler.

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

This method registers the "cgm" extension to this handler as an output handler.

Implements HOutputHandler.

References HC_Begin_Segment_Search(), HC_End_Segment_Search(), HC_Find_Segment(), and HIORegisterOutputType.


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