HIOUtilityHMF
-
class
HIOUtilityHMF The
HIOUtilityHMFis 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.Inherits from: HInputHandler, HOutputHandler
Index
Methods
FileInputByKey()FileInputByKey()FileInputByKey()FileOutputByKey()FileOutputByKey()FileOutputByKey()GetInputName()GetInputStyle()GetInputTypesString()GetOutputName()GetOutputStyle()GetOutputTypesString()HIOUtilityHMF()RegisterInputHandlerTypes()RegisterOutputHandlerTypes()~HIOUtilityHMF()
Methods
-
HIOUtilityHMF::HIOUtilityHMF() Constructs an
HIOUtilityHMFobject.
-
HIOUtilityHMF::~HIOUtilityHMF()
-
char const *
HIOUtilityHMF::GetOutputName() Returns
A character pointer denoting the name of the handler.
-
char const *
HIOUtilityHMF::GetInputName()
-
void
HIOUtilityHMF::RegisterInputHandlerTypes() This method registers the “hmf” extension to this handler as an input handler.
-
HInputHandlerStyle
HIOUtilityHMF::GetInputStyle() Returns
The type of input style which is #HInputHandlerStyleModel.
-
char const *
HIOUtilityHMF::GetInputTypesString() Returns
The input extension type that is handled byHIOUtilityHMFwhich is “hmf”.
-
HFileInputResult
HIOUtilityHMF::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.
-
HFileInputResult
HIOUtilityHMF::FileInputByKey(char const *FileName, HC_KEY key, HInputHandlerOptions *options)
-
HFileInputResult
HIOUtilityHMF::FileInputByKey(unsigned short const *FileName, HC_KEY key, HInputHandlerOptions *options)
-
void
HIOUtilityHMF::RegisterOutputHandlerTypes() This method registers the “hmf” extension to this handler as an output handler.
-
char const *
HIOUtilityHMF::GetOutputTypesString() Returns
The string of the type of output this handler creates which is “hmf”.
-
HOutputHandlerStyle
HIOUtilityHMF::GetOutputStyle() Returns
The type of output style which is HOutputHandlerStyleModel.
-
HFileOutputResult
HIOUtilityHMF::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.
-
HFileOutputResult
HIOUtilityHMF::FileOutputByKey(unsigned short const *filename, HC_KEY key, HOutputHandlerOptions *options)
-
HFileOutputResult
HIOUtilityHMF::FileOutputByKey(char const *filename, HC_KEY key, HOutputHandlerOptions *options)