Alphabetical Class Index  Class Hierarchy   File Members   Compound Members   File List  

HIOUtilityHMF Class Reference

#include <HIOUtilityHOOPS.h>

List of all members.

Public Member Functions

HFileInputResult FileInputByKey (const __wchar_t *FileName, HC_KEY key, HInputHandlerOptions *options)
HFileInputResult FileInputByKey (const char *FileName, HC_KEY key, HInputHandlerOptions *options)
HFileInputResult FileInputByKey (const unsigned short *FileName, HC_KEY key, HInputHandlerOptions *options)
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 * GetInputName ()
HInputHandlerStyle GetInputStyle ()
const char * GetInputTypesString ()
const char * GetOutputName ()
HOutputHandlerStyle GetOutputStyle ()
const char * GetOutputTypesString ()
 HIOUtilityHMF ()
void RegisterInputHandlerTypes ()
void RegisterOutputHandlerTypes ()

Detailed Description

The HIOUtilityHMF is the class for reading and writing HOOPS Metafiles (HMFs). HMFs are the ASCII definition of a HOOPS Scene Graph and are primarily used for debugging purposes.


Constructor & Destructor Documentation

HIOUtilityHMF::HIOUtilityHMF ( ) [inline]

Member Function Documentation

HFileInputResult HIOUtilityHMF::FileInputByKey ( const __wchar_t *  FileName,
HC_KEY  key,
HInputHandlerOptions options 
) [virtual]

This method reads the HMF into the segment defined by key.

Parameters:
filenameThe name of the file to load.
keyThe HOOPS segment key to load model data into.
optionsAn options class containing any needed extra information for operation.
Returns:
The #HFileInputResult result of the input operation.

Reimplemented from HInputHandler.

HFileInputResult HIOUtilityHMF::FileInputByKey ( const char *  filename,
HC_KEY  key,
HInputHandlerOptions options 
) [inline, virtual]

This method loads model data from a given file to a given HOOPS segment key. Note that this must be implemented in a subclassed HInputHandler instance handling models.

Parameters:
filenameThe name of the file to load.
keyThe HOOPS segment key to load model data into.
optionsAn options class containing any needed extra information for the operation.
Returns:
The #HFileInputResult result of the input operation.

Reimplemented from HInputHandler.

References HInputHandler::FileInputByKey().

HFileInputResult HIOUtilityHMF::FileInputByKey ( const unsigned short *  filename,
HC_KEY  key,
HInputHandlerOptions options 
) [inline, virtual]

This method loads model data from a given file to a given HOOPS segment key. Note that this must be implemented in a subclassed HInputHandler instance handling models.

Parameters:
filenameThe UNICODE name of the file to load.
keyThe HOOPS segment key to load model data into.
optionsAn options class containing any needed extra information for the operation.
Returns:
The #HFileInputResult result of the input operation.

Reimplemented from HInputHandler.

References HInputHandler::FileInputByKey().

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

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

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.

HFileOutputResult HIOUtilityHMF::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 HIOUtilityHMF::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* HIOUtilityHMF::GetInputName ( ) [inline, virtual]
Returns:
A character pointer denoting the name of the input handler.

Implements HInputHandler.

HInputHandlerStyle HIOUtilityHMF::GetInputStyle ( ) [inline, virtual]
Returns:
The type of input style which is HInputHandlerStyleModel.

Implements HInputHandler.

References HInputHandlerStyleModel.

const char* HIOUtilityHMF::GetInputTypesString ( ) [inline, virtual]
Returns:
The input extension type that is handled by HIOUtilityHMF which is "hmf".

Implements HInputHandler.

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

Implements HOutputHandler.

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

Implements HOutputHandler.

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

Implements HOutputHandler.

void HIOUtilityHMF::RegisterInputHandlerTypes ( ) [inline, virtual]

This method registers the "hmf" extension to this handler as an input handler.

Implements HInputHandler.

References HIORegisterInputType.

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

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

Implements HOutputHandler.

References HIORegisterOutputType.


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