HIOUtilitySpheres Class Reference

#include <HIOUtilitySpheres.h>

Public Member Functions

 HIOUtilitySpheres ()
 
virtual ~HIOUtilitySpheres ()
 
void RegisterInputHandlerTypes ()
 
const char * GetOutputName ()
 
const char * GetInputName ()
 
const char * GetInputTypesString ()
 
HInputHandlerStyle GetInputStyle ()
 
HFileInputResult FileInputByKey (const char *FileName, HC_KEY key, HInputHandlerOptions *options)
 
HFileInputResult FileInputByKey (const __wchar_t *FileName, HC_KEY key, HInputHandlerOptions *options)
 
void RegisterOutputHandlerTypes ()
 
const char * GetOutputTypesString ()
 
HOutputHandlerStyle GetOutputStyle ()
 
HFileOutputResult FileOutputByKey (const char *FileName, HC_KEY key, HOutputHandlerOptions *options)
 
HFileOutputResult FileOutputByKey (const __wchar_t *FileName, HC_KEY key, HOutputHandlerOptions *options)
 
- Public Member Functions inherited from HInputHandler
virtual HFileInputResult FileInputByKey (const unsigned short *filename, HC_KEY key, HInputHandlerOptions *options)
 
virtual HFileInputResult FileInputToImageKey (const char *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)
 
void ReportInputPercentProgress (float percent_progress)
 
void ReportInputProgress (const char *progress)
 
HIONoticeCallbackSetInputInformationNoticeCallback (HIONoticeCallback *notice_callback)
 
HIOPercentNoticeCallbackSetInputPercentProgressNoticeCallback (HIOPercentNoticeCallback *percent_notice_callback)
 
HIONoticeCallbackSetInputProgressNoticeCallback (HIONoticeCallback *notice_callback)
 

Additional Inherited Members

- Protected Member Functions inherited from HInputHandler
void SetFinishedInput ()
 
void SetInputOps (unsigned long ops)
 
void SetStartingInput (const char *filename)
 
- Protected Attributes inherited from HInputHandler
unsigned long m_InputOps
 

Detailed Description

The HIOUtilitySpheres class is used for reading and writing Sphere Files (.sph)

Constructor & Destructor Documentation

HIOUtilitySpheres::HIOUtilitySpheres ( )
inline
virtual HIOUtilitySpheres::~HIOUtilitySpheres ( )
inlinevirtual

Member Function Documentation

HFileInputResult HIOUtilitySpheres::FileInputByKey ( const char *  FileName,
HC_KEY  key,
HInputHandlerOptions options 
)
inlinevirtual

This method reads an .sph file into the segment referenced by 'key'.

Reimplemented from HInputHandler.

HFileInputResult HIOUtilitySpheres::FileInputByKey ( const __wchar_t *  FileName,
HC_KEY  key,
HInputHandlerOptions options 
)
HFileOutputResult HIOUtilitySpheres::FileOutputByKey ( const char *  FileName,
HC_KEY  key,
HOutputHandlerOptions *  options 
)
inline

This method creates an .sph file of the segment tree defined under the segment referened by 'key'.

HFileOutputResult HIOUtilitySpheres::FileOutputByKey ( const __wchar_t *  FileName,
HC_KEY  key,
HOutputHandlerOptions *  options 
)
const char* HIOUtilitySpheres::GetInputName ( )
inlinevirtual

Implements HInputHandler.

HInputHandlerStyle HIOUtilitySpheres::GetInputStyle ( )
inlinevirtual

Implements HInputHandler.

References HInputHandlerStyleModel.

const char* HIOUtilitySpheres::GetInputTypesString ( )
inlinevirtual

Implements HInputHandler.

const char* HIOUtilitySpheres::GetOutputName ( )
inline
Returns
A character pointer denoting the name of the handler.
HOutputHandlerStyle HIOUtilitySpheres::GetOutputStyle ( )
inline
const char* HIOUtilitySpheres::GetOutputTypesString ( )
inline
void HIOUtilitySpheres::RegisterInputHandlerTypes ( )
inlinevirtual

Implements HInputHandler.

References HIORegisterInputType.

void HIOUtilitySpheres::RegisterOutputHandlerTypes ( )
inline

References HIORegisterOutputType.


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