HIOUtilityWhip2D
-
class
HIOUtilityWhip2D The
HIOUtilityWhip2Dis the class for writing DWF Whip 2D files using the HOOPS Whip 2D driver.Inherits from:
HOutputHandler
Methods
-
HIOUtilityWhip2D::HIOUtilityWhip2D()
-
HIOUtilityWhip2D::~HIOUtilityWhip2D()
-
void
HIOUtilityWhip2D::RegisterOutputHandlerTypes() virtual
This abstract function must register extension types to be handled by subclassed
HOutputHandlerinstance.{HIORegisterOutputType("tif",this); HIORegisterOutputType("tiff",this);};
For example, the following lines of code can be used to specify a class that will handle files with “tiff” and “tif” extensions:
-
char const *
HIOUtilityWhip2D::GetOutputName() virtual
Returns
A character pointer denoting the name of the handler.
-
char const *
HIOUtilityWhip2D::GetOutputTypesString() virtual
{return "stl";};
This must be implemented in a subclassed
HOutputHandlerFor example: the following line of code can be use to specify the stl extension:{return "jpg;bmp;gif";};
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 thisHOutputHandler.
-
HOutputHandlerStyle
HIOUtilityWhip2D::GetOutputStyle() virtual
{return HOutputHandlerStyleModel;}
For example: the following code can be used for an
HOutputHandlerthat outputs model:Returns
TheHOutputHandlerStylethat this instance will use. It can be HOutputHandlerStyleModel for geometry data,HOutputHandlerStyleImagefor images,HOutputHandlerStyleHardcopyfor hardcopy orHOutputHandlerStyleHTMLfor MVO style html page.
-
char const *
HIOUtilityWhip2D::GetOutputDefaultHSRA() virtual
{return "painters";};
For example: the following line of code might be used for an output handler needing painters:
Returns
A default HSRA forHOutputHandlerinstance if needed.
-
HFileOutputResult
HIOUtilityWhip2D::FileOutputByKey(__wchar_t const *filename, HC_KEY key, HOutputHandlerOptions *options) virtual
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
-
HFileOutputResult
HIOUtilityWhip2D::FileOutputByKey(unsigned short const *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 implemented in a subclassed
HOutputHandlerinstance 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.