Alphabetical Class Index  Class Hierarchy   File Members   Compound Members   File List  

HIOUtilityCGM Class Reference

#include <HIOUtilityHOOPS.h>

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

Constructs an HIOUtilityCGM object.

References HOutputOpFileOutputByKey.

Member Function Documentation

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

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.
const char* HIOUtilityCGM::GetOutputDefaultHSRA ( )
inline
Returns
The default HSRA for the HIOUtilityCGM instance.
const char* HIOUtilityCGM::GetOutputName ( )
inline
Returns
A character pointer denoting the name of the handler.
HOutputHandlerStyle HIOUtilityCGM::GetOutputStyle ( )
inline
Returns
The type of output style which is HOutputHandlerStyleHardcopy.

References HOutputHandlerStyleHardcopy.

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

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

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: