HIOUtilityWhip2D
Functions
HIOUtilityWhip2D |
|
~HIOUtilityWhip2D |
|
| void | RegisterOutputHandlerTypes |
| char const * | GetOutputName |
| char const * | GetOutputTypesString |
HOutputHandlerStyle |
GetOutputStyle |
| char const * | GetOutputDefaultHSRA |
| HFileOutputResult | FileOutputByKey |
| HFileOutputResult | FileOutputByKey |
Detailed Description
-
class
HIOUtilityWhip2D: public HOutputHandler The HIOUtilityWhip2D is the class for writing DWF Whip 2D files using the HOOPS Whip 2D driver.
Public Functions
-
inline
HIOUtilityWhip2D()
-
inline
~HIOUtilityWhip2D()
-
inline virtual void
RegisterOutputHandlerTypes() 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:
-
inline virtual char const *
GetOutputName() Returns: A character pointer denoting the name of the handler.
-
inline virtual char const *
GetOutputTypesString() This must be implemented in a subclassed HOutputHandler For example: the following line of code can be use to specify the stl extension:
The following line of code can be used to specify that jpg, bmp and gif extension are handled:
Returns: The extension type or types that can be handled by this HOutputHandler.
-
inline virtual HOutputHandlerStyle
GetOutputStyle() For example: the following code can be used for an HOutputHandler that outputs model:
Returns: The HOutputHandlerStyle that this instance will use. It can be HOutputHandlerStyleModel for geometry data, HOutputHandlerStyleImage for images, HOutputHandlerStyleHardcopy for hardcopy or HOutputHandlerStyleHTML for MVO style html page.
-
inline virtual char const *
GetOutputDefaultHSRA() For example: the following line of code might be used for an output handler needing painters:
Returns: A default HSRA for HOutputHandler instance if needed.
-
virtual HFileOutputResult
FileOutputByKey(__wchar_t const *filename, HC_KEY key, HOutputHandlerOptions *options) This method writes a 2D DWF (Whip) file out of the segment tree underneath key
Parameters: - FileName – A character pointer denoting the name of the file to be written
- key – A hoops key of the segment - the tree underneath which is required to be exported
- options – Export options
Returns: OutputOK if the export succeeds
-
inline virtual HFileOutputResult
FileOutputByKey(unsigned short const *filename, HC_KEY key, HOutputHandlerOptions *options) 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: - 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.
-
inline