HIOUtilityStl Class Reference

#include <HIOUtilityStl.h>

Public Member Functions
HFileInputResult	FileInputByKey (const __wchar_t *FileName, HC_KEY key, HInputHandlerOptions *options)
HFileInputResult	FileInputByKey (const char *FileName, HC_KEY key, HInputHandlerOptions *options)
HFileInputResult	FileInputByKey (const unsigned short *FileName, HC_KEY key, HInputHandlerOptions *options)
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 ()
HInputHandlerStyle	GetInputStyle ()
const char *	GetInputTypesString ()
const char *	GetOutputName ()
HOutputHandlerStyle	GetOutputStyle ()
const char *	GetOutputTypesString ()
	HIOUtilityStl ()
void	RegisterInputHandlerTypes ()
void	RegisterOutputHandlerTypes ()
Public Member Functions inherited from HInputHandler
virtual HFileInputResult	FileInputToImageKey (const char *filename, HC_KEY *image_key, HC_KEY segment_key, HInputHandlerOptions *options)
virtual HFileInputResult	FileInputToImageKey (const __wchar_t *filename, HC_KEY *image_key, HC_KEY segment_key, HInputHandlerOptions *options)
virtual HFileInputResult	FileInputToImageKey (const unsigned short *filename, HC_KEY *image_key, HC_KEY segment_key, HInputHandlerOptions *options)
const __wchar_t *	GetInputInformation ()
unsigned long	GetInputOps ()
float	GetInputPercentProgress ()
const __wchar_t *	GetInputProgress ()
	HInputHandler ()
void	ReportInputInformation (const char *information)
	This posts information to the information queue.
void	ReportInputInformation (const __wchar_t *information)
void	ReportInputPercentProgress (float percent_progress)
	This posts the current percent progress should be between 0.0 and 1.0.
void	ReportInputProgress (const char *progress)
	This posts the current progress message.
void	ReportInputProgress (const __wchar_t *progress)
HIONoticeCallback *	SetInputInformationNoticeCallback (HIONoticeCallback *notice_callback)
HIOPercentNoticeCallback *	SetInputPercentProgressNoticeCallback (HIOPercentNoticeCallback *percent_notice_callback)
HIONoticeCallback *	SetInputProgressNoticeCallback (HIONoticeCallback *notice_callback)
void	SetModuleDirectory (const char *module_directory)
void	SetModuleDirectory (const __wchar_t *module_directory)
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)
HIONoticeCallback *	SetOutputInformationNoticeCallback (HIONoticeCallback *notice_callback)
HIOPercentNoticeCallback *	SetOutputPercentProgressNoticeCallback (HIOPercentNoticeCallback *percent_notice_callback)
HIONoticeCallback *	SetOutputProgressNoticeCallback (HIONoticeCallback *notice_callback)

Additional Inherited Members
Protected Member Functions inherited from HInputHandler
void	SetFinishedInput ()
void	SetInputOps (unsigned long ops)
	This sets the HInputOp.
void	SetStartingInput (const char *filename)
void	SetStartingInput (const __wchar_t *filename=0)
Protected Member Functions inherited from HOutputHandler
void	SetFinishedOutput ()
void	SetOutputOps (unsigned long ops)
	This sets the HOutputOp.
void	SetStartingOutput ()
Protected Attributes inherited from HInputHandler
unsigned long	m_InputOps
	This is the HInputOp set for a subclassed instance.
__wchar_t *	m_module_directory
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 HIOUtilitySTL allows you to read and write binary and ASCII stereolithography or STL files.

Constructor & Destructor Documentation

HIOUtilityStl()

HIOUtilityStl::HIOUtilityStl ( )

inline

Constructs an HIOUtilityStl object.

References HInputOpFileInputByKey, HOutputOpFileOutputByKey, HInputHandler::SetInputOps(), and HOutputHandler::SetOutputOps().

Member Function Documentation

FileInputByKey() [1/3]

HFileInputResult HIOUtilityStl::FileInputByKey ( const __wchar_t *  FileName, HC_KEY  key, HInputHandlerOptions *  options  )

virtual

This method reads a stereolithography file. The file contents are mapped to a HOOPS shell primitive that is inserted into the currently open HOOPS segment. Both ASCII and binary .stl files are supported.

Parameters

filename	The name of the file to load.
key	The HOOPS segment key to load model data into.
options	This parameter is currently not being used.

Returns

The #HFileInputResult result of the input operation.

Reimplemented from HInputHandler.

FileInputByKey() [2/3]

HFileInputResult HIOUtilityStl::FileInputByKey ( const char *  filename, HC_KEY  key, HInputHandlerOptions *  options  )

inlinevirtual

This method loads model data from a given file to a given HOOPS segment key. Note that this must be implemented in a subclassed HInputHandler instance handling models.

Parameters

filename	The name of the file to load.
key	The HOOPS segment key to load model data into.
options	An options class containing any needed extra information for the operation.

Returns

The #HFileInputResult result of the input operation.

Reimplemented from HInputHandler.

FileInputByKey() [3/3]

HFileInputResult HIOUtilityStl::FileInputByKey ( const unsigned short *  filename, HC_KEY  key, HInputHandlerOptions *  options  )

inlinevirtual

This method loads model data from a given file to a given HOOPS segment key. Note that this must be implemented in a subclassed HInputHandler instance handling models.

Parameters

filename	The UNICODE name of the file to load.
key	The HOOPS segment key to load model data into.
options	An options class containing any needed extra information for the operation.

Returns

The #HFileInputResult result of the input operation.

Reimplemented from HInputHandler.

FileOutputByKey() [1/3]

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

virtual

This method writes a stereolithography file out of the segment tree underneath the given key. Both ASCII and binary .stl files are supported.

Parameters

filename	The name of the file to output.
key	The HOOPS segment key to output model data from.
options	Set this parameter's m_bAscii member to true if you want to write an ASCII .stl file or false to write a binary .stl file.

Returns

The #HFileOutputResult result of the output operation.

Reimplemented from HOutputHandler.

FileOutputByKey() [2/3]

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

Returns

The #HFileOutputResult result of the output operation.

Reimplemented from HOutputHandler.

GetInputName()

const char* HIOUtilityStl::GetInputName ( )

inlinevirtual

Returns

A character pointer denoting the name of the input handler.

Implements HInputHandler.

GetInputStyle()

HInputHandlerStyle HIOUtilityStl::GetInputStyle ( )

inlinevirtual

Returns

The type of input style which is HInputHandlerStyleModel.

Implements HInputHandler.

References HInputHandlerStyleModel.

GetInputTypesString()

const char* HIOUtilityStl::GetInputTypesString ( )

inlinevirtual

Returns

The input extension type that is handled by HIOUtilityStl which is "stl".

Implements HInputHandler.

GetOutputName()

const char* HIOUtilityStl::GetOutputName ( )

inlinevirtual

Returns

A character pointer denoting the name of the handler.

Implements HOutputHandler.

GetOutputStyle()

HOutputHandlerStyle HIOUtilityStl::GetOutputStyle ( )

inlinevirtual

Returns

The type of output style which is HOutputHandlerStyleModel.

Implements HOutputHandler.

GetOutputTypesString()

const char* HIOUtilityStl::GetOutputTypesString ( )

inlinevirtual

Returns

The string of the type of output this handler creates which is "stl".

Implements HOutputHandler.

RegisterInputHandlerTypes()

void HIOUtilityStl::RegisterInputHandlerTypes ( )

inlinevirtual

This method registers the "stl" extension to this handler as an input handler.

Implements HInputHandler.

References HIORegisterInputType.

RegisterOutputHandlerTypes()

void HIOUtilityStl::RegisterOutputHandlerTypes ( )

inlinevirtual

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

Implements HOutputHandler.

References HIORegisterOutputType.

---

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

• HIOUtilityStl.h