Introduction

Getting Started

Programming Guides

API Reference

Additional Resources

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)
 

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 
)
inline

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

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 ( )
inline
HInputHandlerStyle HIOUtilitySpheres::GetInputStyle ( )
inline
const char* HIOUtilitySpheres::GetInputTypesString ( )
inline
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 ( )
inline
void HIOUtilitySpheres::RegisterOutputHandlerTypes ( )
inline

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