Alphabetical Class Index  Class Hierarchy   File Members   Compound Members   File List  

HIOUtilityPDF Class Reference

#include <HIOUtilityPDF.h>

Inheritance diagram for HIOUtilityPDF:

HOutputHandler

List of all members.

Public Member Functions

HFileOutputResult FileOutputByKey (const char *filename, HC_KEY key, HOutputHandlerOptions *options)
HFileOutputResult FileOutputByKey (const __wchar_t *filename, HC_KEY key, HOutputHandlerOptions *options)
const char * GetOutputDefaultHSRA ()
const char * GetOutputName ()
HOutputHandlerStyle GetOutputStyle ()
const char * GetOutputTypesString ()
bool Has3dSupport ()
 HIOUtilityPDF ()
void RegisterOutputHandlerTypes ()

Protected Member Functions

HFileOutputResult FileOutputByKey2D (const char *filename, HC_KEY key, HOutputHandlerOptions *options)
HFileOutputResult FileOutputByKey2D (const __wchar_t *filename, HC_KEY key, HOutputHandlerOptions *options)


Detailed Description

The HIOUtilityPDF class provides support for output of 2d and 3d pdf files.

Constructor & Destructor Documentation

HIOUtilityPDF::HIOUtilityPDF (  )  [inline]


Member Function Documentation

HFileOutputResult HIOUtilityPDF::FileOutputByKey ( const char *  filename,
HC_KEY  key,
HOutputHandlerOptions options 
) [inline, 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 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 from HOutputHandler.

References HOutputHandler::FileOutputByKey().

HFileOutputResult HIOUtilityPDF::FileOutputByKey ( const __wchar_t *  filename,
HC_KEY  key,
HOutputHandlerOptions options 
) [virtual]

This method exports the HOOPS segment tree under the given key to a pdf file.

Parameters:
filename The name of the file to output.
key The HOOPS segment key to output model data from.
options Pass a pointer to HPDFOptions with information to specify the dimensions of the output as well as if you want a 3D or 2D output.
Returns:
The HFileOutputResult result of the output operation.

Reimplemented from HOutputHandler.

HFileOutputResult HIOUtilityPDF::FileOutputByKey2D ( const __wchar_t *  filename,
HC_KEY  key,
HOutputHandlerOptions options 
) [protected]

This method exports the HOOPS segment tree under the given key to a 2D pdf file.

Parameters:
filename The name of the file to output.
key The HOOPS segment key to output model data from.
options Pass a pointer to HPDFOptions with information to specify the dimensions of the output as well as if you want a 3D or 2D output.
Returns:
The HFileOutputResult result of the output operation.

const char* HIOUtilityPDF::GetOutputDefaultHSRA (  )  [inline, virtual]

Returns:
The default HSRA for the HIOUtilityPDF instance.

Reimplemented from HOutputHandler.

const char* HIOUtilityPDF::GetOutputName (  )  [inline, virtual]

Returns:
A character pointer denoting the name of the handler.

Implements HOutputHandler.

HOutputHandlerStyle HIOUtilityPDF::GetOutputStyle (  )  [inline, virtual]

Returns:
The type of output style which is HOutputHandlerStyleHardcopy.

Implements HOutputHandler.

References HOutputHandlerStyleHardcopy.

const char* HIOUtilityPDF::GetOutputTypesString (  )  [inline, virtual]

Returns:
The string of the type of output this handler creates which is "pdf".

Implements HOutputHandler.

bool HIOUtilityPDF::Has3dSupport (  )  [inline]

This method checks if there's a u3d handler registered. If there is, then we can output a 3d pdf file.

Returns:
True if this handler can output 3d pdf file or false if it cannot.

References HDB::GetHIOManager().

void HIOUtilityPDF::RegisterOutputHandlerTypes (  )  [inline, virtual]

This method registers the "pdf" extension to this handler as an output handler.

Implements HOutputHandler.

References HC_Begin_Segment_Search(), HC_End_Segment_Search(), HC_Find_Segment(), and HIORegisterOutputType.


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