HIOUtilityPDF

Functions

HIOUtilityPDF

~HIOUtilityPDF

const char *

GetOutputName

void

RegisterOutputHandlerTypes

const char *

GetOutputTypesString

HOutputHandlerStyle

GetOutputStyle

const char *

GetOutputDefaultHSRA

bool

Has3dSupport

HFileIOResult

FileOutputByKey

HFileIOResult

FileOutputByKey

Detailed Description

class HIOUtilityPDF : public HOutputHandler

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

Public Functions

inline HIOUtilityPDF()

Constructs an HIOUtilityPDF object.

inline ~HIOUtilityPDF()
inline virtual const char *GetOutputName()
Returns

A character pointer denoting the name of the handler.

inline virtual void RegisterOutputHandlerTypes()

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

inline virtual const char *GetOutputTypesString()
Returns

The string of the type of output this handler creates which is “pdf”.

inline virtual HOutputHandlerStyle GetOutputStyle()
Returns

The type of output style which is HOutputHandlerStyleHardcopy.

inline virtual const char *GetOutputDefaultHSRA()
Returns

The default HSRA for the HIOUtilityPDF instance.

inline bool Has3dSupport()

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.

virtual HFileIOResult FileOutputByKey(const __wchar_t *filename, HC_KEY key, HOutputHandlerOptions *options)

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.

inline virtual HFileIOResult FileOutputByKey(const char *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 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.