HIOUtilityHsf
Functions
char const * |
|
char const * |
|
void |
|
char const * |
|
void |
|
char const * |
|
Detailed Description
-
class HIOUtilityHsf : public HInputHandler, public HOutputHandler
The HIOUtilityHsf used for reading and writing HOOPS Stream Files (HSFs) in a non-streaming way.
Public Functions
-
inline HIOUtilityHsf()
Constructs an HIOUtilityHsf object.
-
inline virtual ~HIOUtilityHsf()
-
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.
-
virtual void RegisterInputHandlerTypes()
This method registers the “hsf” extensions to this handler as an input handler.
-
virtual char const *GetInputTypesString()
- Returns
The input extension type that is handled by HIOUtilityHsf.
-
inline virtual HInputHandlerStyle GetInputStyle()
- Returns
The type of input style which is HInputHandlerStyleModel.
-
virtual HFileIOResult FileInputByKey(__wchar_t const *FileName, HC_KEY key, HInputHandlerOptions *options)
This method reads a HSF file into the segment defined by key. To facilitate streaming most applications implement their own HSF import on the application side. This is here for completeness and currently creates it’s own stream toolkit object.
- 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.
-
virtual void RegisterOutputHandlerTypes()
This method registers the “hsf” extensions to this handler as an output handler.
-
virtual char const *GetOutputTypesString()
- Returns
The string of the type of output this handler creates.
-
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 creates a HSF file of the segment tree defined under key. The StreamToolkit object associated with the HBaseView object, which is passed in via the options structure is used to create the HSF.
- Parameters
filename – The name of the file to output.
key – The HOOPS segment key to output model data from.
options – The options class containing a pointer the HStreamFileToolkit object in m_pExtendedData.
- 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.
-
inline HIOUtilityHsf()
