HIOUtilityHMF

Detailed Description

class HIOUtilityHMF : public HInputHandler, public HOutputHandler

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.

Public Functions

inline HIOUtilityHMF()

Constructs an HIOUtilityHMF object.

inline ~HIOUtilityHMF()
inline virtual char const *GetOutputName()
Returns:A character pointer denoting the name of the handler.
inline virtual char const *GetInputName()
Returns:A character pointer denoting the name of the input handler.
inline virtual void RegisterInputHandlerTypes()

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

inline virtual HInputHandlerStyle GetInputStyle()
Returns:The type of input style which is HInputHandlerStyleModel.
inline virtual char const *GetInputTypesString()
Returns:The input extension type that is handled by HIOUtilityHMF which is “hmf”.
virtual HFileIOResult FileInputByKey(__wchar_t const *FileName, HC_KEY key, HInputHandlerOptions *options)

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

Parameters:
  • filename – The name of the file to load.
  • key – The HOOPS segment key to load model data into.
  • options – An options class containing any needed extra information for operation.
Returns:

The #HFileInputResult result of the input operation.

inline virtual HFileIOResult FileInputByKey(char const *FileName, HC_KEY key, HInputHandlerOptions *options)

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:
  • filename – The name of the file to load.
  • key – The HOOPS segment key to load model data into.
  • options – An options class containing any needed extra information for the operation.
Returns:

The #HFileInputResult result of the input operation.

inline virtual HFileIOResult FileInputByKey(unsigned short const *FileName, HC_KEY key, HInputHandlerOptions *options)

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:
  • filename – The UNICODE name of the file to load.
  • key – The HOOPS segment key to load model data into.
  • options – An options class containing any needed extra information for the operation.
Returns:

The #HFileInputResult result of the input operation.

inline virtual void RegisterOutputHandlerTypes()

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

inline virtual char const *GetOutputTypesString()
Returns:The string of the type of output this handler creates which is “hmf”.
inline virtual HOutputHandlerStyle GetOutputStyle()
Returns:The type of output style which is HOutputHandlerStyleModel.
virtual HFileIOResult FileOutputByKey(__wchar_t const *filename, HC_KEY key, HOutputHandlerOptions *options)

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

Parameters:
  • filename – The name of the file to output.
  • key – The HOOPS segment key to output model data from.
  • options – The options class containing any needed extra information for the operation.
Returns:

The #HFileOutputResult result of the output operation.

inline virtual HFileIOResult FileOutputByKey(unsigned short const *filename, HC_KEY key, HOutputHandlerOptions *options)

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

Parameters:
  • filename – The wide character name of the file to output.
  • key – The HOOPS segment key to get output model data from.
  • options – The options class containing any needed extra information for the operation.
Returns:

The #HFileOutputResult result of the output operation.

inline virtual HFileIOResult FileOutputByKey(char const *filename, HC_KEY key, HOutputHandlerOptions *options)

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

Parameters:
  • filename – The name of the file to output.
  • key – The HOOPS segment key to output model data from.
  • options – The options class containing any needed extra information for the operation.
Returns:

The #HFileOutputResult result of the output operation.