HIOUtilityHTML Class Reference

#include <HIOUtilityHTML.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 * GetOutputName ()
 
HOutputHandlerStyle GetOutputStyle ()
 
const char * GetOutputTypesString ()
 
 HIOUtilityHTML ()
 
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)
 
virtual const char * GetOutputDefaultHSRA ()
 
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 HIOUtilityHTML class is used for exporting models from the Visualize Database to HTML format. Please note, this feature is only available for 64-bit Windows, and is only available through pre-compiled binaries (i.e., source code isn't available for HIOUtilityHTML).

Constructor & Destructor Documentation

◆ HIOUtilityHTML()

HIOUtilityHTML::HIOUtilityHTML ( )
inline

Constructs an HIOUtility object.

References HOutputOpFileOutputByKey, and HOutputHandler::SetOutputOps().

Member Function Documentation

◆ FileOutputByKey() [1/3]

HFileOutputResult HIOUtilityHTML::FileOutputByKey ( const __wchar_t *  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 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 HOutputHandlerOptions object containing any additional information for the operation.
Returns
The HFileOutputResult result of the output operation.

Reimplemented from HOutputHandler.

◆ FileOutputByKey() [2/3]

HFileOutputResult HIOUtilityHTML::FileOutputByKey ( const unsigned short *  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 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 HOutputHandlerOptions object containing any additional information for the operation.
Returns
The HFileOutputResult result of the output operation.

Reimplemented from HOutputHandler.

◆ FileOutputByKey() [3/3]

HFileOutputResult HIOUtilityHTML::FileOutputByKey ( const char *  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 HOutputHandler instance handling models.

Parameters
filenameThe name of the file to output.
keyThe HOOPS segment key to get output model data from.
optionsThe HOutputHandlerOptions object containing any additional information for the operation.
Returns
The HFileOutputResult result of the output operation.

Reimplemented from HOutputHandler.

◆ GetOutputName()

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

Implements HOutputHandler.

◆ GetOutputStyle()

HOutputHandlerStyle HIOUtilityHTML::GetOutputStyle ( )
inlinevirtual
Returns
The HOutputHandlerStyle that this instance will use. Currently, this will always be HOutputHandlerStyleModel.

Implements HOutputHandler.

◆ GetOutputTypesString()

const char* HIOUtilityHTML::GetOutputTypesString ( )
inlinevirtual
Returns
The output extension type.

Implements HOutputHandler.

◆ RegisterOutputHandlerTypes()

void HIOUtilityHTML::RegisterOutputHandlerTypes ( )
virtual

This method registers the appropriate extensions to this handler as an input handler.

Implements HOutputHandler.


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