#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 *	GetOutputDefaultHSRA ()

const char *	GetOutputName ()

HOutputHandlerStyle	GetOutputStyle ()

const char *	GetOutputTypesString ()

	HIOUtilityCGM ()

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)

HIONoticeCallback *	SetOutputInformationNoticeCallback (HIONoticeCallback *notice_callback)

HIOPercentNoticeCallback *	SetOutputPercentProgressNoticeCallback (HIOPercentNoticeCallback *percent_notice_callback)

HIONoticeCallback *	SetOutputProgressNoticeCallback (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 HIOUtilityCGM is the class for writing CGM files using the HOOPS CGM driver.

Constructor & Destructor Documentation

◆ HIOUtilityCGM()

HIOUtilityCGM::HIOUtilityCGM ( )

inline

Constructs an HIOUtilityCGM object.

References HOutputOpFileOutputByKey, and HOutputHandler::SetOutputOps().

Member Function Documentation

◆ FileOutputByKey() [1/3]

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

virtual

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

Parameters

filename	The name of the file to output.
key	The HOOPS segment key to get output 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.

◆ FileOutputByKey() [2/3]

HFileOutputResult HIOUtilityCGM::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

filename	The wide character name of the file to output.
key	The HOOPS segment key to get 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.

◆ FileOutputByKey() [3/3]

HFileOutputResult HIOUtilityCGM::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

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.