|
virtual HFileInputResult | FileInputByKey (const char *filename, HC_KEY key, HInputHandlerOptions *options) |
|
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 () |
|
virtual const char * | GetInputName ()=0 |
|
unsigned long | GetInputOps () |
|
float | GetInputPercentProgress () |
|
const __wchar_t * | GetInputProgress () |
|
virtual HInputHandlerStyle | GetInputStyle ()=0 |
|
virtual const char * | GetInputTypesString ()=0 |
|
| HInputHandler () |
|
virtual void | RegisterInputHandlerTypes ()=0 |
|
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) |
|
HIONoticeCallback * | SetInputInformationNoticeCallback (HIONoticeCallback *notice_callback) |
|
HIOPercentNoticeCallback * | SetInputPercentProgressNoticeCallback (HIOPercentNoticeCallback *percent_notice_callback) |
|
HIONoticeCallback * | SetInputProgressNoticeCallback (HIONoticeCallback *notice_callback) |
|
void | SetModuleDirectory (const char *module_directory) |
|
void | SetModuleDirectory (const __wchar_t *module_directory) |
|
HInputHandler an abstract base class for model and image input.
HInputHandler is an abstract base class that performs model and image file input. HIOManager::RegisterInputHandler is used to register an input handler for a file extension type with the HIOManager. To make a new input handler, create a child class that inherits from this class and implements the abstract interfaces.
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.
Reimplemented in HIOUtilityPublish, HIOUtilityPointCloud, HIOUtilityPly, HIOUtilityObj, HIOUtilityDWG, HIOUtilityStl, HIOUtilityU3D, HIOUtilityDGN, HIOUtilityExchange, HIOUtilityHMF, HIOUtilityHsf, HIOUtilityDwfImport, HIOUtilityIV, and HIOUtilityOOC.
Referenced by HIOUtilityIV::FileInputByKey(), HIOUtilityDwfImport::FileInputByKey(), HIOUtilityHsf::FileInputByKey(), HIOUtilityHMF::FileInputByKey(), HIOUtilityExchange::FileInputByKey(), HIOUtilityU3D::FileInputByKey(), HIOUtilityStl::FileInputByKey(), HIOUtilityObj::FileInputByKey(), HIOUtilityPly::FileInputByKey(), HIOUtilityPointCloud::FileInputByKey(), and HIOUtilityPublish::FileInputByKey().
virtual HFileInputResult HInputHandler::FileInputByKey |
( |
const unsigned short * |
filename, |
|
|
HC_KEY |
key, |
|
|
HInputHandlerOptions * |
options |
|
) |
| |
|
virtual |
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.
Reimplemented in HIOUtilityPublish, HIOUtilityPly, HIOUtilityPointCloud, HIOUtilityObj, HIOUtilityDWG, HIOUtilityStl, HIOUtilityU3D, HIOUtilityDGN, HIOUtilityExchange, HIOUtilityHMF, HIOUtilityHsf, and HIOUtilityIV.
virtual const char* HInputHandler::GetInputTypesString |
( |
| ) |
|
|
pure virtual |
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:
The following line of code can be used to specify that the jpg, bmp and gif extension are handled:
Implemented in HIOUtilityPublish, HIOUtilityPointCloud, HIOUtilityPly, HIOUtilityObj, HIOUtilityLeadTools, HIOUtilityDWG, HIOUtilityU3D, HIOUtilityDGN, HIOUtilityHMF, HIOUtilityOOC, HIOUtilityStl, HIOUtilityExchange, HIOUtilityMagick, HIOUtilityDwfImport, HIOUtilityHsf, and HIOUtilityIV.
virtual void HInputHandler::RegisterInputHandlerTypes |
( |
| ) |
|
|
pure 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:
Implemented in HIOUtilityPublish, HIOUtilityPointCloud, HIOUtilityPly, HIOUtilityObj, HIOUtilityOOC, HIOUtilityDWG, HIOUtilityU3D, HIOUtilityHMF, HIOUtilityDGN, HIOUtilityStl, HIOUtilityMagick, HIOUtilityExchange, HIOUtilityHsf, HIOUtilityLeadTools, HIOUtilityDwfImport, and HIOUtilityIV.