HIOUtilityIV Class Reference

#include <HIOUtilityIV.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)
 
const char * GetInputName ()
 
HInputHandlerStyle GetInputStyle ()
 
const char * GetInputTypesString ()
 
 HIOUtilityIV ()
 
void RegisterInputHandlerTypes ()
 
- 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)
 

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 Attributes inherited from HInputHandler
unsigned long m_InputOps
 This is the HInputOp set for a subclassed instance.
 
__wchar_t * m_module_directory
 

Detailed Description

The HIOUtilityIV is used for reading Open Inventor (.iv) files.

Constructor & Destructor Documentation

◆ HIOUtilityIV()

HIOUtilityIV::HIOUtilityIV ( )
inline

Constructs an HIOUtilityIV object.

References HInputOpFileInputByKey, and HInputHandler::SetInputOps().

Member Function Documentation

◆ FileInputByKey() [1/3]

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

This method reads the .iv file 'filename' into the segment tree underneath the given key.

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

◆ GetInputName()

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

Implements HInputHandler.

◆ GetInputStyle()

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

Implements HInputHandler.

References HInputHandlerStyleModel.

◆ GetInputTypesString()

const char* HIOUtilityIV::GetInputTypesString ( )
inlinevirtual
Returns
The string of the type of input this handler creates which is "iv".

Implements HInputHandler.

◆ RegisterInputHandlerTypes()

void HIOUtilityIV::RegisterInputHandlerTypes ( )
inlinevirtual

This method registers the "iv" extension to this handler.

Implements HInputHandler.

References HIORegisterInputType.


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