##################
BStreamFileToolkit
##################

.. cpp:namespace:: BStreamFileToolkit

.. default-domain:: cpp

Functions
=========

================================= =========================================================================================================================================================
..                                :cpp:func:`BStreamFileToolkit <BStreamFileToolkit::BStreamFileToolkit>`                                                                                  
..                                :cpp:func:`~BStreamFileToolkit <virtual BStreamFileToolkit::~BStreamFileToolkit>`                                                                        
:cpp:enumerator:`~TK_Status`      :cpp:func:`SetAsciiMode <TK_Status BStreamFileToolkit::SetAsciiMode(bool whether)>`                                                                      
bool                              :cpp:func:`GetAsciiMode <bool BStreamFileToolkit::GetAsciiMode()>`                                                                                       
void                              :cpp:func:`SetTabs <void BStreamFileToolkit::SetTabs(int)>`                                                                                              
int                               :cpp:func:`GetTabs <int BStreamFileToolkit::GetTabs()>`                                                                                                  
:cpp:enumerator:`~TK_Status`      :cpp:func:`ParseBuffer <virtual TK_Status BStreamFileToolkit::ParseBuffer(char const *b, int s, TK_Status mode=TK_Normal)>`                              
:cpp:enumerator:`~TK_Status`      :cpp:func:`PrepareBuffer <TK_Status BStreamFileToolkit::PrepareBuffer(char *b, int s)>`                                                                  
int                               :cpp:func:`CurrentBufferLength <int BStreamFileToolkit::CurrentBufferLength()>`                                                                          
void                              :cpp:func:`ActivateContext <virtual void BStreamFileToolkit::ActivateContext(ID_Key key)>`                                                               
void                              :cpp:func:`DeactivateContext <virtual void BStreamFileToolkit::DeactivateContext(ID_Key key)>`                                                           
void                              :cpp:func:`NewFileContext <virtual void BStreamFileToolkit::NewFileContext(ID_Key key)>`                                                                 
int                               :cpp:func:`GeneratedSoFar <int BStreamFileToolkit::GeneratedSoFar() const>`                                                                              
unsigned int                      :cpp:func:`ObjectsSoFar <unsigned int BStreamFileToolkit::ObjectsSoFar() const>`                                                                         
void                              :cpp:func:`SetOpcodeHandler <void BStreamFileToolkit::SetOpcodeHandler(int which, BBaseOpcodeHandler *handler)>`                                         
void                              :cpp:func:`SetPrewalkHandler <void BStreamFileToolkit::SetPrewalkHandler(BBaseOpcodeHandler *handler)>`                                                  
void                              :cpp:func:`SetPostwalkHandler <void BStreamFileToolkit::SetPostwalkHandler(BBaseOpcodeHandler *handler)>`                                                
:doc:`classBBaseOpcodeHandler` *  :cpp:func:`GetOpcodeHandler <BBaseOpcodeHandler * BStreamFileToolkit::GetOpcodeHandler(int which) const>`                                                
void                              :cpp:func:`Restart <virtual void BStreamFileToolkit::Restart()>`                                                                                         
:cpp:enumerator:`~TK_Status`      :cpp:func:`IndexToKey <TK_Status BStreamFileToolkit::IndexToKey(int index, ID_Key &key) const>`                                                          
:cpp:enumerator:`~TK_Status`      :cpp:func:`KeyToIndex <TK_Status BStreamFileToolkit::KeyToIndex(ID_Key key, int &index) const>`                                                          
:cpp:enumerator:`~TK_Status`      :cpp:func:`AddIndexKeyPair <TK_Status BStreamFileToolkit::AddIndexKeyPair(int index, ID_Key key)>`                                                       
:cpp:enumerator:`~TK_Status`      :cpp:func:`AddVariant <TK_Status BStreamFileToolkit::AddVariant(ID_Key key, int variant, int value1, int value2=-1)>`                                    
:cpp:enumerator:`~TK_Status`      :cpp:func:`AddBounds <TK_Status BStreamFileToolkit::AddBounds(ID_Key key, float const bounds[])>`                                                        
:cpp:enumerator:`~TK_Status`      :cpp:func:`GetOffset <TK_Status BStreamFileToolkit::GetOffset(ID_Key key, int variant, int &offset) const>`                                              
:cpp:enumerator:`~TK_Status`      :cpp:func:`GetOffset <TK_Status BStreamFileToolkit::GetOffset(ID_Key key, int variant, int &offset, int &length) const>`                                 
:cpp:enumerator:`~TK_Status`      :cpp:func:`GetOffset <TK_Status BStreamFileToolkit::GetOffset(ID_Key key, int variant, int &offset, int &length, wchar_t const *&filename) const>`       
:cpp:enumerator:`~TK_Status`      :cpp:func:`GetBounds <TK_Status BStreamFileToolkit::GetBounds(ID_Key key, float bounds[]) const>`                                                        
int                               :cpp:func:`NextTagIndex <int BStreamFileToolkit::NextTagIndex()>`                                                                                        
int                               :cpp:func:`PeekTagIndex <int BStreamFileToolkit::PeekTagIndex() const>`                                                                                  
void                              :cpp:func:`SetFilename <void BStreamFileToolkit::SetFilename(char const *name)>`                                                                         
void                              :cpp:func:`SetFilename <void BStreamFileToolkit::SetFilename(wchar_t const *name)>`                                                                      
:cpp:enumerator:`~TK_Status`      :cpp:func:`Read_Stream_File <TK_Status BStreamFileToolkit::Read_Stream_File()>`                                                                          
void                              :cpp:func:`SetNewFile <void BStreamFileToolkit::SetNewFile(char const *name)>`                                                                           
void                              :cpp:func:`SetNewFile <void BStreamFileToolkit::SetNewFile(wchar_t const *name)>`                                                                        
wchar_t const *                   :cpp:func:`GetCurrentFile <wchar_t const  * BStreamFileToolkit::GetCurrentFile() const>`                                                                 
void                              :cpp:func:`GetCurrentFile <void BStreamFileToolkit::GetCurrentFile(wchar_t const *&filename) const>`                                                     
:cpp:enumerator:`~TK_Status`      :cpp:func:`SelectFile <TK_Status BStreamFileToolkit::SelectFile(char const *name)>`                                                                      
:cpp:enumerator:`~TK_Status`      :cpp:func:`SelectFile <TK_Status BStreamFileToolkit::SelectFile(wchar_t const *name)>`                                                                   
:cpp:enumerator:`~TK_Status`      :cpp:func:`OpenFile <virtual TK_Status BStreamFileToolkit::OpenFile(char const *name, bool write=false)>`                                                
:cpp:enumerator:`~TK_Status`      :cpp:func:`OpenFile <virtual TK_Status BStreamFileToolkit::OpenFile(wchar_t const *name, bool write=false)>`                                             
:cpp:enumerator:`~TK_Status`      :cpp:func:`CloseFile <virtual TK_Status BStreamFileToolkit::CloseFile()>`                                                                                
:cpp:enumerator:`~TK_Status`      :cpp:func:`ReadBuffer <virtual TK_Status BStreamFileToolkit::ReadBuffer(char *buffer, int size, int &amount_read)>`                                      
:cpp:enumerator:`~TK_Status`      :cpp:func:`WriteBuffer <virtual TK_Status BStreamFileToolkit::WriteBuffer(char *buffer, int size)>`                                                      
:cpp:enumerator:`~TK_Status`      :cpp:func:`PositionFile <virtual TK_Status BStreamFileToolkit::PositionFile(int offset)>`                                                                
:cpp:enumerator:`~TK_Status`      :cpp:func:`GetFileSize <virtual TK_Status BStreamFileToolkit::GetFileSize(unsigned long &size)>`                                                         
:cpp:enumerator:`~TK_Status`      :cpp:func:`LocateDictionary <virtual TK_Status BStreamFileToolkit::LocateDictionary()>`                                                                  
:cpp:enumerator:`~TK_Status`      :cpp:func:`LocateEntity <virtual TK_Status BStreamFileToolkit::LocateEntity(ID_Key key, int variant)>`                                                   
int                               :cpp:func:`GetFlags <int BStreamFileToolkit::GetFlags() const>`                                                                                          
void                              :cpp:func:`SetFlags <void BStreamFileToolkit::SetFlags(int flags)>`                                                                                      
void                              :cpp:func:`SetWriteFlags <void BStreamFileToolkit::SetWriteFlags(int flags)>`                                                                            
int                               :cpp:func:`GetWriteFlags <int BStreamFileToolkit::GetWriteFlags(int mask=~0) const>`                                                                     
void                              :cpp:func:`SetReadFlags <void BStreamFileToolkit::SetReadFlags(int flags)>`                                                                              
int                               :cpp:func:`GetReadFlags <int BStreamFileToolkit::GetReadFlags(int mask=~0) const>`                                                                       
int                               :cpp:func:`GetNumNormalBits <int BStreamFileToolkit::GetNumNormalBits() const>`                                                                          
void                              :cpp:func:`SetNumNormalBits <void BStreamFileToolkit::SetNumNormalBits(int numbits)>`                                                                    
int                               :cpp:func:`GetNumVertexBits <int BStreamFileToolkit::GetNumVertexBits() const>`                                                                          
void                              :cpp:func:`SetNumVertexBits <void BStreamFileToolkit::SetNumVertexBits(int numbits)>`                                                                    
int                               :cpp:func:`GetNumParameterBits <int BStreamFileToolkit::GetNumParameterBits() const>`                                                                    
void                              :cpp:func:`SetNumParameterBits <void BStreamFileToolkit::SetNumParameterBits(int numbits)>`                                                              
int                               :cpp:func:`GetNumColorBits <int BStreamFileToolkit::GetNumColorBits() const>`                                                                            
void                              :cpp:func:`SetNumColorBits <void BStreamFileToolkit::SetNumColorBits(int numbits)>`                                                                      
int                               :cpp:func:`GetNumIndexBits <int BStreamFileToolkit::GetNumIndexBits() const>`                                                                            
void                              :cpp:func:`SetNumIndexBits <void BStreamFileToolkit::SetNumIndexBits(int numbits)>`                                                                      
void                              :cpp:func:`SetJpegQuality <void BStreamFileToolkit::SetJpegQuality(int quality=75)>`                                                                     
int                               :cpp:func:`GetJpegQuality <int BStreamFileToolkit::GetJpegQuality() const>`                                                                              
int                               :cpp:func:`GetVersion <int BStreamFileToolkit::GetVersion() const>`                                                                                      
void                              :cpp:func:`SetReadVersion <void BStreamFileToolkit::SetReadVersion(int version)>`                                                                        
void                              :cpp:func:`SetTargetVersion <void BStreamFileToolkit::SetTargetVersion(int version)>`                                                                    
int                               :cpp:func:`GetTargetVersion <int BStreamFileToolkit::GetTargetVersion() const>`                                                                          
unsigned int                      :cpp:func:`GetFileOffset <unsigned int BStreamFileToolkit::GetFileOffset() const>`                                                                       
void                              :cpp:func:`SetFileOffset <void BStreamFileToolkit::SetFileOffset(unsigned int offset)>`                                                                  
int                               :cpp:func:`Unused <int BStreamFileToolkit::Unused() const>`                                                                                              
:cpp:enumerator:`~TK_Status`      :cpp:func:`Error <virtual TK_Status BStreamFileToolkit::Error(char const *msg=0) const>`                                                                 
char const *                      :cpp:func:`GetLogFile <char const  * BStreamFileToolkit::GetLogFile() const>`                                                                            
void                              :cpp:func:`SetLogFile <void BStreamFileToolkit::SetLogFile(char const *filename=0)>`                                                                     
bool                              :cpp:func:`GetLogging <bool BStreamFileToolkit::GetLogging() const>`                                                                                     
void                              :cpp:func:`SetLogging <void BStreamFileToolkit::SetLogging(bool setting)>`                                                                               
unsigned int                      :cpp:func:`GetLoggingOptions <unsigned int BStreamFileToolkit::GetLoggingOptions(unsigned int mask=~0) const>`                                           
void                              :cpp:func:`SetLoggingOptions <void BStreamFileToolkit::SetLoggingOptions(unsigned int options=~0)>`                                                      
:cpp:enumerator:`~TK_Status`      :cpp:func:`OpenLogFile <TK_Status BStreamFileToolkit::OpenLogFile(char const *filename, char const *mode)>`                                              
void                              :cpp:func:`LogEntry <void BStreamFileToolkit::LogEntry(char const *string) const>`                                                                       
void                              :cpp:func:`LogEntry <void BStreamFileToolkit::LogEntry(wchar_t const *string) const>`                                                                    
void                              :cpp:func:`CloseLogFile <void BStreamFileToolkit::CloseLogFile()>`                                                                                       
unsigned int                      :cpp:func:`NextOpcodeSequence <unsigned int BStreamFileToolkit::NextOpcodeSequence()>`                                                                   
void                              :cpp:func:`SetOpcodeSequence <void BStreamFileToolkit::SetOpcodeSequence(unsigned int seq=0)>`                                                           
bool                              :cpp:func:`HeaderCommentSeen <bool BStreamFileToolkit::HeaderCommentSeen() const>`                                                                       
bool                              :cpp:func:`HPSCommentSeen <bool BStreamFileToolkit::HPSCommentSeen() const>`                                                                             
TK_Progress_Callback              :cpp:func:`GetProgressCallback <TK_Progress_Callback BStreamFileToolkit::GetProgressCallback() const>`                                                   
void                              :cpp:func:`SetProgressCallback <void BStreamFileToolkit::SetProgressCallback(TK_Progress_Callback cb=0)>`                                                
void *                            :cpp:func:`GetProgressValue <void * BStreamFileToolkit::GetProgressValue() const>`                                                                       
void                              :cpp:func:`SetProgressValue <void BStreamFileToolkit::SetProgressValue(void *value)>`                                                                    
int                               :cpp:func:`GetBufferLimit <int BStreamFileToolkit::GetBufferLimit() const>`                                                                              
void                              :cpp:func:`SetBufferLimit <void BStreamFileToolkit::SetBufferLimit(int limit)>`                                                                          
void                              :cpp:func:`SetLastKey <void BStreamFileToolkit::SetLastKey(ID_Key key)>`                                                                                 
:cpp:enumerator:`~TK_Status`      :cpp:func:`AppendLastKey <TK_Status BStreamFileToolkit::AppendLastKey(ID_Key key)>`                                                                      
void                              :cpp:func:`ClearLastKey <void BStreamFileToolkit::ClearLastKey()>`                                                                                       
:cpp:enumerator:`~TK_Status`      :cpp:func:`GetLastKey <TK_Status BStreamFileToolkit::GetLastKey(ID_Key &key) const>`                                                                     
void                              :cpp:func:`SetDictionaryFormat <void BStreamFileToolkit::SetDictionaryFormat(int format=3, int options=TK_Dictionary_Bounding_Volumes)>`                 
int                               :cpp:func:`GetDictionaryFormat <int BStreamFileToolkit::GetDictionaryFormat() const>`                                                                    
int                               :cpp:func:`GetDictionaryOptions <int BStreamFileToolkit::GetDictionaryOptions() const>`                                                                  
void                              :cpp:func:`SetDictionaryOffset <void BStreamFileToolkit::SetDictionaryOffset(int offset)>`                                                               
int                               :cpp:func:`GetDictionaryOffset <int BStreamFileToolkit::GetDictionaryOffset() const>`                                                                    
void                              :cpp:func:`SetDictionarySize <void BStreamFileToolkit::SetDictionarySize(int size)>`                                                                     
int                               :cpp:func:`GetDictionarySize <int BStreamFileToolkit::GetDictionarySize() const>`                                                                        
void                              :cpp:func:`RecordPause <void BStreamFileToolkit::RecordPause(int offset)>`                                                                               
void                              :cpp:func:`ClearPauses <void BStreamFileToolkit::ClearPauses()>`                                                                                         
int                               :cpp:func:`GetPauseCount <int BStreamFileToolkit::GetPauseCount() const>`                                                                                
int const *                       :cpp:func:`GetPauseTable <int const  * BStreamFileToolkit::GetPauseTable() const>`                                                                       
void                              :cpp:func:`SetFirstPause <void BStreamFileToolkit::SetFirstPause(int offset)>`                                                                           
int                               :cpp:func:`GetFirstPause <int BStreamFileToolkit::GetFirstPause() const>`                                                                                
int                               :cpp:func:`GetPosition <int BStreamFileToolkit::GetPosition() const>`                                                                                    
void                              :cpp:func:`SetWorldBounding <void BStreamFileToolkit::SetWorldBounding(float const bbox[])>`                                                             
void                              :cpp:func:`SetWorldBoundingBySphere <void BStreamFileToolkit::SetWorldBoundingBySphere(float const pt[], float radius)>`                                 
float const *                     :cpp:func:`GetWorldBounding <float const  * BStreamFileToolkit::GetWorldBounding() const>`                                                               
bool                              :cpp:func:`AddExternalReference <bool BStreamFileToolkit::AddExternalReference(char const *ref, ID_Key context)>`                                        
bool                              :cpp:func:`AddExternalReference <bool BStreamFileToolkit::AddExternalReference(wchar_t const *ref, ID_Key context)>`                                     
bool                              :cpp:func:`NextExternalReference <bool BStreamFileToolkit::NextExternalReference()>`                                                                     
wchar_t const *                   :cpp:func:`GetExternalReference <wchar_t const  * BStreamFileToolkit::GetExternalReference() const>`                                                     
void                              :cpp:func:`GetExternalReference <void BStreamFileToolkit::GetExternalReference(wchar_t const *&exref) const>`                                            
:c:macro:`~ID_Key`                :cpp:func:`GetExternalReferenceContext <ID_Key BStreamFileToolkit::GetExternalReferenceContext() const>`                                                 
bool                              :cpp:func:`MatchPreviousExRef <virtual bool BStreamFileToolkit::MatchPreviousExRef() const>`                                                             
void                              :cpp:func:`AddSegment <void BStreamFileToolkit::AddSegment(ID_Key key)>`                                                                                 
:c:macro:`~ID_Key`                :cpp:func:`RemoveSegment <ID_Key BStreamFileToolkit::RemoveSegment()>`                                                                                   
:c:macro:`~ID_Key`                :cpp:func:`CurrentSegment <ID_Key BStreamFileToolkit::CurrentSegment()>`                                                                                 
void                              :cpp:func:`ResetQuantizationError <void BStreamFileToolkit::ResetQuantizationError()>`                                                                   
void                              :cpp:func:`ReportQuantizationError <void BStreamFileToolkit::ReportQuantizationError(float error)>`                                                      
void                              :cpp:func:`ReportQuantizationError <void BStreamFileToolkit::ReportQuantizationError(int bits_per_sample, float const *bounding, int num_dimensions=3)>` 
float                             :cpp:func:`GetQuantizationError <float BStreamFileToolkit::GetQuantizationError() const>`                                                                
:cpp:enumerator:`~TK_Status`      :cpp:func:`OpenGeometry <virtual TK_Status BStreamFileToolkit::OpenGeometry()>`                                                                          
:cpp:enumerator:`~TK_Status`      :cpp:func:`CloseGeometry <virtual TK_Status BStreamFileToolkit::CloseGeometry()>`                                                                        
bool                              :cpp:func:`GeometryIsOpen <bool BStreamFileToolkit::GeometryIsOpen() const>`                                                                             
:c:macro:`~ID_Key`                :cpp:func:`RevisitKey <ID_Key BStreamFileToolkit::RevisitKey() const>`                                                                                   
:c:macro:`~ID_Key`                :cpp:func:`RevisitOwner <ID_Key BStreamFileToolkit::RevisitOwner() const>`                                                                               
void                              :cpp:func:`RecordTexture <void BStreamFileToolkit::RecordTexture(char const *name)>`                                                                     
bool                              :cpp:func:`suppress_crc_reinit <bool BStreamFileToolkit::suppress_crc_reinit(bool state)>`                                                               
bool                              :cpp:func:`SupportsAsciiMode <static bool BStreamFileToolkit::SupportsAsciiMode()>`                                                                      
int                               :cpp:func:`ParseVersion <static int BStreamFileToolkit::ParseVersion(char const *block)>`                                                                
================================= =========================================================================================================================================================

.. cpp:namespace:: nullptr

Detailed Description
====================

.. doxygenclass:: BStreamFileToolkit
   :project: 3dgs_stream
   :members:
   :undoc-members:



