|
virtual HFileOutputResult | FileOutputByKey (const char *filename, HC_KEY key, HOutputHandlerOptions *options) |
|
virtual HFileOutputResult | FileOutputByKey (const __wchar_t *filename, HC_KEY key, HOutputHandlerOptions *options) |
|
virtual HFileOutputResult | FileOutputByKey (const unsigned short *filename, HC_KEY key, HOutputHandlerOptions *options) |
|
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 () |
|
virtual const char * | GetOutputName ()=0 |
|
unsigned long | GetOutputOps () |
|
float | GetOutputPercentProgress () |
|
const char * | GetOutputProgress () |
|
virtual HOutputHandlerStyle | GetOutputStyle ()=0 |
|
virtual const char * | GetOutputTypesString ()=0 |
|
| HOutputHandler () |
|
virtual void | RegisterOutputHandlerTypes ()=0 |
|
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) |
|
HIONoticeCallback * | SetOutputInformationNoticeCallback (HIONoticeCallback *notice_callback) |
|
HIOPercentNoticeCallback * | SetOutputPercentProgressNoticeCallback (HIOPercentNoticeCallback *percent_notice_callback) |
|
HIONoticeCallback * | SetOutputProgressNoticeCallback (HIONoticeCallback *notice_callback) |
|
HOutputHandler an abstract base class for model and image output.
HInputHandler is an abstract base class that performs model, image, hardcopy and html file output. HIOManager::RegisterOutputHandler is used to register an output handler for a file extension type with the HIOManager. To make a new output handler, create a child class that inherits from this class and implements the abstract interfaces.
This method writes model data from a given HOOPS key to a given output file. Note that this must be implimented in a subclassed HOutputHandler instance handling models.
- Parameters
-
filename | The name of the file to output. |
key | The HOOPS segment key to output model data from. |
options | The options class containing any needed extra information for the operation. |
- Returns
- The #HFileOutputResult result of the output operation.
Reimplemented in HIOUtilityPublish, HIOUtilityCGM, HIOUtilityHPGL2, HIOUtilityPostscript, HIOUtilityPly, HIOUtilityObj, HIOUtilityPDF, HIOUtilityU3D, HIOUtilityStl, HIOUtilityHMF, HIOUtilityHsf, HIOUtilityExchange, and HIOUtilityHTML.
Referenced by HIOUtilityDwfExport::FileOutputByKey(), HIOUtilityHTML::FileOutputByKey(), HIOUtilityExchange::FileOutputByKey(), HIOUtilityHsf::FileOutputByKey(), HIOUtilityHMF::FileOutputByKey(), HIOUtilityStl::FileOutputByKey(), HIOUtilityWhip2D::FileOutputByKey(), HIOUtilityU3D::FileOutputByKey(), HIOUtilityPDF::FileOutputByKey(), HIOUtilityObj::FileOutputByKey(), HIOUtilityPly::FileOutputByKey(), HIOUtilityPostscript::FileOutputByKey(), HIOUtilityHPGL2::FileOutputByKey(), HIOUtilityCGM::FileOutputByKey(), and HIOUtilityPublish::FileOutputByKey().
virtual HFileOutputResult HOutputHandler::FileOutputByKey |
( |
const unsigned short * |
filename, |
|
|
HC_KEY |
key, |
|
|
HOutputHandlerOptions * |
options |
|
) |
| |
|
virtual |
This method writes model data from a given HOOPS key to a given output file. Note that this must be implimented in a subclassed HOutputHandler instance handling models.
- Parameters
-
filename | The wide character name of the file to output. |
key | The HOOPS segment key to get output model data from. |
options | The options class containing any needed extra information for the operation. |
- Returns
- The #HFileOutputResult result of the output operation.
Reimplemented in HIOUtilityPublish, HIOUtilityCGM, HIOUtilityHPGL2, HIOUtilityPostscript, HIOUtilityPly, HIOUtilityObj, HIOUtilityU3D, HIOUtilityWhip2D, HIOUtilityStl, HIOUtilityHMF, HIOUtilityHsf, HIOUtilityExchange, HIOUtilityHTML, and HIOUtilityDwfExport.
virtual const char* HOutputHandler::GetOutputTypesString |
( |
| ) |
|
|
pure virtual |
This must be implemented in a subclassed HOutputHandler
- Returns
- The extension type or types that can be handled by this HOutputHandler.
For example: the following line of code can be use to specify the stl extenstion:
The following line of code can be used to specify that jpg, bmp and gif extension are handled:
Implemented in HIOUtilityPublish, HIOUtilityCGM, HIOUtilityHPGL2, HIOUtilityPostscript, HIOUtilityLeadTools, HIOUtilityObj, HIOUtilityExchange, HIOUtilityU3D, HIOUtilityPly, HIOUtilityWhip2D, HIOUtilityPDF, HIOUtilityHMF, HIOUtilityHsf, HIOUtilityMagick, HIOUtilityStl, HIOUtilityHTML, and HIOUtilityDwfExport.
virtual void HOutputHandler::RegisterOutputHandlerTypes |
( |
| ) |
|
|
pure virtual |
This abstract function must register extension types to be handled by subclassed HOutputHandler instance.
For example, the following lines of code can be used to specify a class that will handle files with "tiff" and "tif" extensions:
Implemented in HIOUtilityPublish, HIOUtilityCGM, HIOUtilityHPGL2, HIOUtilityPostscript, HIOUtilityObj, HIOUtilityLeadTools, HIOUtilityExchange, HIOUtilityU3D, HIOUtilityPly, HIOUtilityWhip2D, HIOUtilityHMF, HIOUtilityPDF, HIOUtilityHsf, HIOUtilityMagick, HIOUtilityStl, HIOUtilityHTML, and HIOUtilityDwfExport.