HIOUtilityHsf Class Reference

#include <HIOUtilityHsf.h>

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 ()
 
 HIOUtilityHsf ()
 
void RegisterInputHandlerTypes ()
 
void RegisterOutputHandlerTypes ()
 
- Public Member Functions inherited from HInputHandler
virtual HFileInputResult FileInputToImageKey (const char *filename, HC_KEY *image_key, HC_KEY segment_key, HInputHandlerOptions *options)
 
virtual HFileInputResult FileInputToImageKey (const __wchar_t *filename, HC_KEY *image_key, HC_KEY segment_key, HInputHandlerOptions *options)
 
virtual HFileInputResult FileInputToImageKey (const unsigned short *filename, HC_KEY *image_key, HC_KEY segment_key, HInputHandlerOptions *options)
 
const __wchar_t * GetInputInformation ()
 
unsigned long GetInputOps ()
 
float GetInputPercentProgress ()
 
const __wchar_t * GetInputProgress ()
 
 HInputHandler ()
 
void ReportInputInformation (const char *information)
 This posts information to the information queue.
 
void ReportInputInformation (const __wchar_t *information)
 
void ReportInputPercentProgress (float percent_progress)
 This posts the current percent progress should be between 0.0 and 1.0.
 
void ReportInputProgress (const char *progress)
 This posts the current progress message.
 
void ReportInputProgress (const __wchar_t *progress)
 
HIONoticeCallbackSetInputInformationNoticeCallback (HIONoticeCallback *notice_callback)
 
HIOPercentNoticeCallbackSetInputPercentProgressNoticeCallback (HIOPercentNoticeCallback *percent_notice_callback)
 
HIONoticeCallbackSetInputProgressNoticeCallback (HIONoticeCallback *notice_callback)
 
void SetModuleDirectory (const char *module_directory)
 
void SetModuleDirectory (const __wchar_t *module_directory)
 
- Public Member Functions inherited from HOutputHandler
virtual HFileOutputResult FileOutputFromImageKey (const char *filename, HC_KEY image_key, HOutputHandlerOptions *options)
 
virtual HFileOutputResult FileOutputFromImageKey (const __wchar_t *filename, HC_KEY image_key, HOutputHandlerOptions *options)
 
virtual const char * GetOutputDefaultHSRA ()
 
const __wchar_t * GetOutputInformation ()
 
unsigned long GetOutputOps ()
 
float GetOutputPercentProgress ()
 
const char * GetOutputProgress ()
 
 HOutputHandler ()
 
void ReportOutputInformation (const char *information)
 This posts information to the information queue.
 
void ReportOutputPercentProgress (float percent_progress)
 This posts the current percent progress message should be between 0.0 and 1.0.
 
void ReportOutputProgress (const char *progress)
 This posts the current progress message.
 
void SetModuleDirectory (const char *module_directory)
 
void SetModuleDirectory (const __wchar_t *module_directory)
 
HIONoticeCallbackSetOutputInformationNoticeCallback (HIONoticeCallback *notice_callback)
 
HIOPercentNoticeCallbackSetOutputPercentProgressNoticeCallback (HIOPercentNoticeCallback *percent_notice_callback)
 
HIONoticeCallbackSetOutputProgressNoticeCallback (HIONoticeCallback *notice_callback)
 

Additional Inherited Members

- Protected Member Functions inherited from HInputHandler
void SetFinishedInput ()
 
void SetInputOps (unsigned long ops)
 This sets the HInputOp.
 
void SetStartingInput (const char *filename)
 
void SetStartingInput (const __wchar_t *filename=0)
 
- Protected Member Functions inherited from HOutputHandler
void SetFinishedOutput ()
 
void SetOutputOps (unsigned long ops)
 This sets the HOutputOp.
 
void SetStartingOutput ()
 
- Protected Attributes inherited from HInputHandler
unsigned long m_InputOps
 This is the HInputOp set for a subclassed instance.
 
__wchar_t * m_module_directory
 
- Protected Attributes inherited from HOutputHandler
char * m_module_directory
 
unsigned long m_OutputOps
 This is the HOutputOp set for a subclassed instance.
 

Detailed Description

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

Constructor & Destructor Documentation

◆ HIOUtilityHsf()

HIOUtilityHsf::HIOUtilityHsf ( )
inline

Member Function Documentation

◆ FileInputByKey() [1/3]

HFileInputResult HIOUtilityHsf::FileInputByKey ( const __wchar_t *  FileName,
HC_KEY  key,
HInputHandlerOptions options 
)
virtual

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
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.

◆ FileInputByKey() [2/3]

HFileInputResult HIOUtilityHsf::FileInputByKey ( const char *  filename,
HC_KEY  key,
HInputHandlerOptions options 
)
inlinevirtual

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.

◆ FileInputByKey() [3/3]

HFileInputResult HIOUtilityHsf::FileInputByKey ( const unsigned short *  filename,
HC_KEY  key,
HInputHandlerOptions options 
)
inlinevirtual

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.

◆ FileOutputByKey() [1/3]

HFileOutputResult HIOUtilityHsf::FileOutputByKey ( const __wchar_t *  filename,
HC_KEY  key,
HOutputHandlerOptions options 
)
virtual

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
filenameThe name of the file to output.
keyThe HOOPS segment key to output model data from.
optionsThe options class containing a pointer the HStreamFileToolkit object in m_pExtendedData.
Returns
The #HFileOutputResult result of the output operation.

Reimplemented from HOutputHandler.

◆ FileOutputByKey() [2/3]

HFileOutputResult HIOUtilityHsf::FileOutputByKey ( const unsigned short *  filename,
HC_KEY  key,
HOutputHandlerOptions options 
)
inlinevirtual

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
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.

◆ FileOutputByKey() [3/3]

HFileOutputResult HIOUtilityHsf::FileOutputByKey ( const char *  filename,
HC_KEY  key,
HOutputHandlerOptions options 
)
inlinevirtual

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
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.

◆ GetInputName()

const char* HIOUtilityHsf::GetInputName ( )
inlinevirtual
Returns
A character pointer denoting the name of the input handler.

Implements HInputHandler.

◆ GetInputStyle()

HInputHandlerStyle HIOUtilityHsf::GetInputStyle ( )
inlinevirtual
Returns
The type of input style which is HInputHandlerStyleModel.

Implements HInputHandler.

References HInputHandlerStyleModel.

◆ GetInputTypesString()

const char* HIOUtilityHsf::GetInputTypesString ( )
virtual
Returns
The input extension type that is handled by HIOUtilityHsf.

Implements HInputHandler.

◆ GetOutputName()

const char* HIOUtilityHsf::GetOutputName ( )
inlinevirtual
Returns
A character pointer denoting the name of the handler.

Implements HOutputHandler.

◆ GetOutputStyle()

HOutputHandlerStyle HIOUtilityHsf::GetOutputStyle ( )
inlinevirtual
Returns
The type of output style which is HOutputHandlerStyleModel.

Implements HOutputHandler.

◆ GetOutputTypesString()

const char* HIOUtilityHsf::GetOutputTypesString ( )
virtual
Returns
The string of the type of output this handler creates.

Implements HOutputHandler.

◆ RegisterInputHandlerTypes()

void HIOUtilityHsf::RegisterInputHandlerTypes ( )
virtual

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

Implements HInputHandler.

◆ RegisterOutputHandlerTypes()

void HIOUtilityHsf::RegisterOutputHandlerTypes ( )
virtual

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

Implements HOutputHandler.


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