HIOUtilityPostscript Class Reference

#include <HIOUtilityHOOPS.h>

Public Member Functions

HFileOutputResult FileOutputByKey (const __wchar_t *filename, HC_KEY key, HOutputHandlerOptions *options)
 
HFileOutputResult FileOutputByKey (const unsigned short *filename, HC_KEY key, HOutputHandlerOptions *options)
 
HFileOutputResult FileOutputByKey (const char *filename, HC_KEY key, HOutputHandlerOptions *options)
 
const char * GetInputName ()
 
const char * GetOutputDefaultHSRA ()
 
const char * GetOutputName ()
 
HOutputHandlerStyle GetOutputStyle ()
 
const char * GetOutputTypesString ()
 
 HIOUtilityPostscript ()
 
void RegisterOutputHandlerTypes ()
 
- Public Member Functions inherited from HOutputHandler
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)
 

Additional Inherited Members

- Protected Member Functions inherited from HOutputHandler
void SetFinishedOutput ()
 
void SetOutputOps (unsigned long ops)
 This sets the HOutputOp.
 
void SetStartingOutput ()
 
- 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 HIOUtilityPostscript is the class for writing postscript files using the HOOPS postscript driver.

Constructor & Destructor Documentation

◆ HIOUtilityPostscript()

HIOUtilityPostscript::HIOUtilityPostscript ( )
inline

Member Function Documentation

◆ FileOutputByKey() [1/3]

HFileOutputResult HIOUtilityPostscript::FileOutputByKey ( const __wchar_t *  filename,
HC_KEY  key,
HOutputHandlerOptions options 
)
virtual

This method writes a postscript file out of the segment tree underneath the given key.

Parameters
filenameThe name of the file to output.
keyThe HOOPS segment key to get output data from.
optionsThe options class containing any needed extra information for the operation.
Returns
The #HFileOutputResult result of the output operation.

Reimplemented from HOutputHandler.

◆ FileOutputByKey() [2/3]

HFileOutputResult HIOUtilityPostscript::FileOutputByKey ( const unsigned short *  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 wide character name of the file to output.
keyThe HOOPS segment key to get 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.

◆ FileOutputByKey() [3/3]

HFileOutputResult HIOUtilityPostscript::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.

◆ GetOutputDefaultHSRA()

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

Reimplemented from HOutputHandler.

◆ GetOutputName()

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

Implements HOutputHandler.

◆ GetOutputStyle()

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

Implements HOutputHandler.

References HOutputHandlerStyleHardcopy.

◆ GetOutputTypesString()

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

Implements HOutputHandler.

◆ RegisterOutputHandlerTypes()

void HIOUtilityPostscript::RegisterOutputHandlerTypes ( )
inlinevirtual

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

Implements HOutputHandler.

References HIORegisterOutputType.


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