#include <HIOUtilityPDF.h>

Public Member Functions

HFileOutputResult FileOutputByKey (const __wchar_t *filename, HC_KEY key, HOutputHandlerOptions *options)
 
HFileOutputResult FileOutputByKey (const char *filename, HC_KEY key, HOutputHandlerOptions *options)
 
const char * GetOutputDefaultHSRA ()
 
const char * GetOutputName ()
 
HOutputHandlerStyle GetOutputStyle ()
 
const char * GetOutputTypesString ()
 
bool Has3dSupport ()
 
 HIOUtilityPDF ()
 
void RegisterOutputHandlerTypes ()
 
- Public Member Functions inherited from HOutputHandler
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)
 
const __wchar_t * GetOutputInformation ()
 
unsigned long GetOutputOps ()
 
float GetOutputPercentProgress ()
 
const char * GetOutputProgress ()
 
 HOutputHandler ()
 
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)
 
HIONoticeCallbackSetOutputInformationNoticeCallback (HIONoticeCallback *notice_callback)
 
HIOPercentNoticeCallbackSetOutputPercentProgressNoticeCallback (HIOPercentNoticeCallback *percent_notice_callback)
 
HIONoticeCallbackSetOutputProgressNoticeCallback (HIONoticeCallback *notice_callback)
 

Protected Member Functions

HFileOutputResult FileOutputByKey2D (const __wchar_t *filename, HC_KEY key, HOutputHandlerOptions *options)
 
HFileOutputResult FileOutputByKey2D (const char *filename, HC_KEY key, HOutputHandlerOptions *options)
 
- Protected Member Functions inherited from HOutputHandler
void SetFinishedOutput ()
 
void SetOutputOps (unsigned long ops)
 This sets the HOutputOp.
 
void SetStartingOutput ()
 

Additional Inherited Members

- Protected Attributes inherited from HOutputHandler
char * m_module_directory
 
unsigned long m_OutputOps
 This is the HOutputOp set for a subclassed instance.
 

Detailed Description

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

Constructor & Destructor Documentation

◆ HIOUtilityPDF()

HIOUtilityPDF::HIOUtilityPDF ( )
inline

Member Function Documentation

◆ FileOutputByKey() [1/2]

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
filenameThe name of the file to output.
keyThe HOOPS segment key to output model data from.
optionsPass 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.

◆ FileOutputByKey() [2/2]

HFileOutputResult HIOUtilityPDF::FileOutputByKey ( const char *  filename,
HC_KEY  key,
HOutputHandlerOptions options 
)
inlinevirtual

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
filenameThe name of the file to output.
keyThe HOOPS segment key to output model data from.
optionsThe options class containing any needed extra information for the operation.
Returns
The #HFileOutputResult result of the output operation.

Reimplemented from HOutputHandler.

◆ FileOutputByKey2D()

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
filenameThe name of the file to output.
keyThe HOOPS segment key to output model data from.
optionsPass 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.

◆ GetOutputDefaultHSRA()

const char* HIOUtilityPDF::GetOutputDefaultHSRA ( )
inlinevirtual
Returns
The default HSRA for the HIOUtilityPDF instance.

Reimplemented from HOutputHandler.

◆ GetOutputName()

const char* HIOUtilityPDF::GetOutputName ( )
inlinevirtual
Returns
A character pointer denoting the name of the handler.

Implements HOutputHandler.

◆ GetOutputStyle()

HOutputHandlerStyle HIOUtilityPDF::GetOutputStyle ( )
inlinevirtual
Returns
The type of output style which is HOutputHandlerStyleHardcopy.

Implements HOutputHandler.

References HOutputHandlerStyleHardcopy.

◆ GetOutputTypesString()

const char* HIOUtilityPDF::GetOutputTypesString ( )
inlinevirtual
Returns
The string of the type of output this handler creates which is "pdf".

Implements HOutputHandler.

◆ Has3dSupport()

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(), and HIOManager::GetOutputHandler().

◆ RegisterOutputHandlerTypes()

void HIOUtilityPDF::RegisterOutputHandlerTypes ( )
inlinevirtual

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

Implements HOutputHandler.

References HIORegisterOutputType.


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