HIOUtilityHsf

class HIOUtilityHsf

The HIOUtilityHsf used for reading and writing HOOPS Stream Files (HSFs) in a non-streaming way.

Inherits from: HInputHandler, HOutputHandler

Methods

HIOUtilityHsf::HIOUtilityHsf()

Constructs an HIOUtilityHsf object.

virtual HIOUtilityHsf::~HIOUtilityHsf()

virtual

char const *HIOUtilityHsf::GetOutputName()

Returns

A character pointer denoting the name of the handler.
char const *HIOUtilityHsf::GetInputName()
void HIOUtilityHsf::RegisterInputHandlerTypes()

This method registers the “hsf” extensions to this handler as an input handler.

char const *HIOUtilityHsf::GetInputTypesString()

Returns

The input extension type that is handled by HIOUtilityHsf.
HInputHandlerStyle HIOUtilityHsf::GetInputStyle()

Returns

The type of input style which is #HInputHandlerStyleModel.
HFileInputResult HIOUtilityHsf::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.
HFileInputResult HIOUtilityHsf::FileInputByKey(char const *FileName, HC_KEY key, HInputHandlerOptions *options)
HFileInputResult HIOUtilityHsf::FileInputByKey(unsigned short const *FileName, HC_KEY key, HInputHandlerOptions *options)
void HIOUtilityHsf::RegisterOutputHandlerTypes()

This method registers the “hsf” extensions to this handler as an output handler.

char const *HIOUtilityHsf::GetOutputTypesString()

Returns

The string of the type of output this handler creates.
HOutputHandlerStyle HIOUtilityHsf::GetOutputStyle()

Returns

The type of output style which is HOutputHandlerStyleModel.
HFileOutputResult HIOUtilityHsf::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.
HFileOutputResult HIOUtilityHsf::FileOutputByKey(unsigned short const *filename, HC_KEY key, HOutputHandlerOptions *options)
HFileOutputResult HIOUtilityHsf::FileOutputByKey(char const *filename, HC_KEY key, HOutputHandlerOptions *options)
HFileOutputResult HIOUtilityHsf::FileOutputCommon(__wchar_t const *FileName, HC_KEY key, HOutputHandlerOptions *options)

private