|
void | ActivateContext (ID_Key key) |
|
void | AddExcludedSegment (HC_KEY key) alter |
|
void | AddExcludedSegments (int count, HC_KEY const *keys) alter |
|
void | ClearExcludedSegments () alter |
|
unsigned POINTER_SIZED_INT | CountObjects (char const *start_segment=0) alter |
|
void | DeactivateContext (ID_Key key) |
|
TK_Status | GenerateBuffer (char *b, int s, int alter &f, char const *start_segment=0) alter |
|
TK_Status | GenerateOneItemBuffer (char *b, int s, int alter &f, HC_KEY item) alter |
|
int | GetExcludedSegmentCount () const |
|
HC_KEY const * | GetExcludedSegments () const |
|
int | GetHoopsVersion () |
|
const char * | GetPrependRootSegment () |
|
| HStreamFileToolkit () |
|
bool | MatchPreviousExRef () const |
|
void | NewFileContext (ID_Key key) |
|
void | Restart () alter |
|
bool | SegmentIsExcluded (HC_KEY key) const |
|
void | SetPrependRootSegment (const char *segment) |
|
void | SetThumbnail (BBaseOpcodeHandler *handler) alter |
|
void | SetThumbnail (int format, int width, int height, unsigned char const *data) alter |
|
TK_Status | StringToHandler (char const *type, BBaseOpcodeHandler **handler) |
|
TK_Status | StringToOpcode (char const *type, unsigned char *opcode_out) |
|
TK_Status | Write_Stream_File () |
|
TK_Status | AddBounds (ID_Key key, float const *bounds) alter |
|
bool | AddExternalReference (char const *ref, ID_Key context) alter |
|
bool | AddExternalReference (__wchar_t const *ref, ID_Key context) alter |
|
TK_Status | AddIndexKeyPair (int index, ID_Key key) alter |
|
void | AddSegment (ID_Key key) alter |
|
TK_Status | AddVariant (ID_Key key, int variant, int value1, int value2=-1) alter |
|
TK_Status | AppendLastKey (ID_Key key) alter |
|
| BStreamFileToolkit () |
|
void | ClearLastKey () alter |
|
void | ClearPauses () alter |
|
virtual TK_Status | CloseFile () alter |
|
TK_Status | CloseGeometry () alter |
|
void | CloseLogFile () alter |
|
int | CurrentBufferLength () |
|
ID_Key | CurrentSegment () alter |
|
virtual TK_Status | Error (char const *msg=0) const |
|
int | GeneratedSoFar () const |
|
bool | GeometryIsOpen () const |
|
bool | GetAsciiMode () |
|
TK_Status | GetBounds (ID_Key key, float alter *bounds) const |
|
int | GetBufferLimit () const |
|
__wchar_t const * | GetCurrentFile () const |
|
int | GetDictionaryFormat () const |
|
int | GetDictionaryOffset () const |
|
int | GetDictionaryOptions () const |
|
int | GetDictionarySize () const |
|
__wchar_t const * | GetExternalReference () const |
|
ID_Key | GetExternalReferenceContext () const |
|
unsigned int | GetFileOffset () const |
| Gets the file offset, a displacement to be added to positions used in the dictionary (for example, in case the data is appended to another file)
|
|
virtual TK_Status | GetFileSize (unsigned HLONG &size) alter |
|
int | GetFirstPause () const |
|
int | GetFlags () const |
|
int | GetJpegQuality () const |
|
TK_Status | GetLastKey (ID_Key &key) const |
|
char const * | GetLogFile () const |
|
bool | GetLogging () const |
|
unsigned int | GetLoggingOptions (unsigned int mask=~0) const |
|
int | GetNumColorBits () const |
|
int | GetNumIndexBits () const |
|
int | GetNumNormalBits () const |
|
int | GetNumParameterBits () const |
|
int | GetNumVertexBits () const |
|
TK_Status | GetOffset (ID_Key key, int variant, int alter &offset) const |
|
TK_Status | GetOffset (ID_Key key, int variant, int alter &offset, int alter &length) const |
|
TK_Status | GetOffset (ID_Key key, int variant, int alter &offset, int alter &length, __wchar_t const *alter &filename) const |
|
BBaseOpcodeHandler * | GetOpcodeHandler (int which) const |
|
int | GetPauseCount () const |
|
int const * | GetPauseTable () const |
|
int | GetPosition () const |
|
TK_Progress_Callback | GetProgressCallback () const |
|
void * | GetProgressValue () const |
|
float | GetQuantizationError () const |
|
int | GetReadFlags (int mask=~0) const |
|
int | GetTabs () |
|
int | GetTargetVersion () const |
|
int | GetVersion () const |
|
float const * | GetWorldBounding () const |
|
int | GetWriteFlags (int mask=~0) const |
|
bool | HeaderCommentSeen () const |
|
TK_Status | IndexToKey (int index, ID_Key alter &key) const |
|
TK_Status | KeyToIndex (ID_Key key, int alter &index) const |
|
virtual TK_Status | LocateDictionary () alter |
|
virtual TK_Status | LocateEntity (ID_Key key, int variant) alter |
|
void | LogEntry (char const *string) const |
|
void | LogEntry (__wchar_t const *string) const |
|
bool | NextExternalReference () alter |
|
unsigned int | NextOpcodeSequence () alter |
|
int | NextTagIndex () alter |
|
unsigned int | ObjectsSoFar () const |
|
virtual TK_Status | OpenFile (char const *name, bool write=false) alter |
|
virtual TK_Status | OpenFile (__wchar_t const *name, bool write=false) alter |
|
TK_Status | OpenGeometry () alter |
|
TK_Status | OpenLogFile (char const *filename, char const *mode) alter |
|
TK_Status | ParseBuffer (char const *b, int s, TK_Status mode=TK_Normal) alter |
|
int | PeekTagIndex () const |
|
virtual TK_Status | PositionFile (int offset) alter |
|
TK_Status | PrepareBuffer (char *b, int s) alter |
|
TK_Status | Read_Stream_File () |
|
virtual TK_Status | ReadBuffer (char alter *buffer, int size, int alter &amount_read) alter |
|
void | RecordPause (int offset) alter |
|
ID_Key | RemoveSegment () alter |
|
void | ReportQuantizationError (float error) |
|
void | ReportQuantizationError (int bits_per_sample, float const *bounding, int num_dimensions=3) |
|
void | ResetQuantizationError () |
|
ID_Key | RevisitKey () const |
|
ID_Key | RevisitOwner () const |
|
TK_Status | SelectFile (char const *name) alter |
|
TK_Status | SelectFile (__wchar_t const *name) alter |
|
TK_Status | SetAsciiMode (bool whether) |
|
void | SetBufferLimit (int limit) alter |
|
void | SetDictionaryFormat (int format=3, int options=TK_Dictionary_Bounding_Volumes) alter |
|
void | SetDictionaryOffset (int offset) alter |
|
void | SetDictionarySize (int size) alter |
|
void | SetFilename (char const *name) alter |
|
void | SetFilename (__wchar_t const *name) alter |
|
void | SetFileOffset (unsigned int offset) alter |
| Sets the file offset, a displacement to be added to positions used in the dictionary (for example, in case the data is appended to another file)
|
|
void | SetFirstPause (int offset) alter |
|
void | SetFlags (int flags) alter |
|
void | SetJpegQuality (int quality=75) alter |
|
void | SetLastKey (ID_Key key) alter |
|
void | SetLogFile (char const *filename=0) alter |
|
void | SetLogging (bool setting) alter |
|
void | SetLoggingOptions (unsigned int options=~0) alter |
|
void | SetNewFile (char const *name) alter |
|
void | SetNewFile (__wchar_t const *name) alter |
|
void | SetNumColorBits (int numbits) alter |
|
void | SetNumIndexBits (int numbits) alter |
|
void | SetNumNormalBits (int numbits) alter |
|
void | SetNumParameterBits (int numbits) alter |
|
void | SetNumVertexBits (int numbits) alter |
|
void | SetOpcodeHandler (int which, BBaseOpcodeHandler *handler) alter |
|
void | SetOpcodeSequence (unsigned int seq=0) alter |
|
void | SetPostwalkHandler (BBaseOpcodeHandler *handler) alter |
|
void | SetPrewalkHandler (BBaseOpcodeHandler *handler) alter |
|
void | SetProgressCallback (TK_Progress_Callback cb=0) alter |
|
void | SetProgressValue (void *value) alter |
|
void | SetReadFlags (int flags) alter |
|
void | SetReadVersion (int version) |
|
void | SetTabs (int) |
|
void | SetTargetVersion (int version) alter |
|
void | SetWorldBounding (float const *bbox) |
|
void | SetWorldBoundingBySphere (float const *pt, float radius) |
|
void | SetWriteFlags (int flags) alter |
|
int | Unused () const |
|
virtual TK_Status | WriteBuffer (char alter *buffer, int size) alter |
|
void | operator delete (void *p) |
| force deallocation to happen in the stream toolkit's scope
|
|
void * | operator new (size_t size) |
| force allocation to happen in the stream toolkit's scope
|
|
The HStreamFileToolkit class provides support for exporting/importing HOOPS Stream File information from/to a HOOPS/3dGS scene-graph.
The HSF file reading process involves reading the opcode at the start of each piece of binary information, and calling the Read method of the associated opcode handler. After the opcode handler reports that reading is complete, the Execute method should be called. The ParseBuffer method of the BStreamFileToolkit object encapsulates this process.
The HSF file writing process involves determining the proper opcode for each piece of binary information, and calling the Interpret method of the associated opcode handler. After interpretation is complete, the Write method of the opcode handler should be called until writing is complete. The GenerateBuffer method of the HStreamFileToolkit encapsualetes this process.
This class provides a HOOPS/3dGS-specific implementation of the BStreamFileToolkit object. It has HOOPS/3dGS-specific opcode handlers registered with it (of the naming convention HTK_XXX). These opcode handlers overload the following two methods of the base opcode handler:
- Interpret : this method will query the HOOPS/3dGS scene-graph (meaning, extract the graphics data); the data will then be written out to an HSF via the Write method
- Execute : this method will map the HSF data to custom data structures after it has been read in from the HSF file via the Read method