HIOUtilityOOC Class Reference

#include <HIOUtilityOOC.h>

Public Member Functions

virtual HFileInputResult FileInputByKey (wchar_t const *filename, HC_KEY key, HInputHandlerOptions *options)
 
virtual HFileInputResult FileInputByKey (char const *filename, HC_KEY key, HInputHandlerOptions *options)
 
virtual char const * GetInputName ()
 
virtual HInputHandlerStyle GetInputStyle ()
 
virtual char const * GetInputTypesString ()
 
 HIOUtilityOOC ()
 
virtual void RegisterInputHandlerTypes ()
 
- Public Member Functions inherited from HInputHandler
virtual HFileInputResult FileInputByKey (const __wchar_t *filename, HC_KEY key, HInputHandlerOptions *options)
 
virtual HFileInputResult FileInputByKey (const unsigned short *filename, HC_KEY key, HInputHandlerOptions *options)
 
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 HIOUtilityOOC is the HIO plug-in class for the HOOPS/OOC module. Using this input handler, you can load OOC files that have been preprocess by ooc.exe into the HOOPS database.

Constructor & Destructor Documentation

◆ HIOUtilityOOC()

HIOUtilityOOC::HIOUtilityOOC ( )

Constructs an HIOUtilitySKP object.

Member Function Documentation

◆ FileInputByKey() [1/2]

virtual HFileInputResult HIOUtilityOOC::FileInputByKey ( wchar_t const *  filename,
HC_KEY  key,
HInputHandlerOptions options 
)
virtual

This method reads the OOC file into the segment tree underneath given key.

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 operation.
Returns
The #HFileInputResult result of the input operation.

◆ FileInputByKey() [2/2]

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

This method reads the OOC file into the segment tree underneath 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.

◆ GetInputName()

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

Implements HInputHandler.

◆ GetInputStyle()

virtual HInputHandlerStyle HIOUtilityOOC::GetInputStyle ( )
inlinevirtual

This abstract method returns the HInputHandlerStyle the HInputHandler.

For example, the following line of code can be used for an HInputHandler that handles models:

Implements HInputHandler.

References HInputHandlerStyleModel.

◆ GetInputTypesString()

virtual char const* HIOUtilityOOC::GetInputTypesString ( )
inlinevirtual

This method must be implemented in a subclassed HInputHandler.

Returns
The extension type or types that are handled by this HInputHandler.

Examples:

The following line of code can be used to specify the stl extension:

{return "stl";};

The following line of code can be used to specify that the jpg, bmp and gif extension are handled:

{return "jpg;bmp;gif";};

Implements HInputHandler.

◆ RegisterInputHandlerTypes()

virtual void HIOUtilityOOC::RegisterInputHandlerTypes ( )
virtual

This abstract function must register extension types to be handled by subclassed HInputHandler instance.

For example, the following line of code can be used to specify a class that will handle files with "stl" extensions:

{HIORegisterInputType("stl",this);};

Implements HInputHandler.


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