BStreamFileToolkit
-
class
BStreamFileToolkit The
BStreamFileToolkitclass provides support for importing/exporting HOOPS Stream File information.BStreamFileToolkitis the primary support class which manages streaming of HOOPS Stream File data into the HOOPS database. The class also provides support for the user to manage export of information from the HOOPS database to a HOOPS Stream File. It is HOOPS/3dGS-independent; therefore the data does not have to reside in a HOOPS/3dGS scene-graph prior to export and it will not be mapped to a HOOPS/3dGS scene-graph during import. (See the opcode handler notes below)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
BStreamFileToolkitobject 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.
BStreamFileToolkituses a concept of opcode handlers to manage reading and writing of logical pieces of binary information stored in the file. A set of default opcode handlers support standard HOOPS file objects such as segments, attributes and geometry, and the toolkit can be extended by deriving from the existing opcode handlers or adding new ones in order to handle user-specific data. All of the default opcode handlers registered with this class are of the naming convention TK_XXX, where XXX is the type of HSF object. The TK_XXX opcode handlers only provide implementations of the Read and Write methods; therefore the following two methods need to be implemented:- Interpret : this method should query the graphics data (meaning, extract it from data structures); the data will then be written out to an HSF via the Write method
- Execute : this method should map the HSF data to custom data structures after it has been read in from the HSF file via the Read method
Streaming refers to a method of import where the user can incrementally supply pieces of data to the file toolkit object. This is useful in order to incrementally update the scene while data is still being read in, rather than wait until the entire file has been read before any visual result is available.
To begin the streaming process, read a buffer of HOOPS Stream File data from a local file, a remote location, or memory. This reading process could happen asynchronously on a thread that is separate from the main application thread. The toolkit class provides some wrapper functions to open/close and read/write a buffer of data to and from the HOOPS Stream File.
Inherits from:
BControlledMemoryObjectIndex
Methods
ActivateContext()AddBounds()AddExternalReference()AddExternalReference()AddIndexKeyPair()AddSegment()AddVariant()AppendLastKey()bfetch()bfixend()bfixend()bfloat()bfloat()bfloat_size()bsprintf()bsprintf()bsprintf_internal()bstrcat()bstrcat()bstrclr()bstrcpy()bstrcpy()BStreamFileToolkit()bstrlen()btrim()btrim()ClearLastKey()ClearPauses()CloseFile()CloseGeometry()CloseLogFile()CurrentBufferLength()CurrentSegment()DeactivateContext()Error()GeneratedSoFar()GeometryIsOpen()get_string_buffer()GetAsciiMode()GetBounds()GetBufferLimit()GetCurrentFile()GetCurrentFile()GetDictionaryFormat()GetDictionaryOffset()GetDictionaryOptions()GetDictionarySize()GetExternalReference()GetExternalReference()GetExternalReferenceContext()GetFileOffset()GetFileSize()GetFirstPause()GetFlags()GetJpegQuality()GetLastKey()GetLogFile()GetLogging()GetLoggingOptions()GetNumColorBits()GetNumIndexBits()GetNumNormalBits()GetNumParameterBits()GetNumVertexBits()GetOffset()GetOffset()GetOffset()GetOpcodeHandler()GetPauseCount()GetPauseTable()GetPosition()GetProgressCallback()GetProgressValue()GetQuantizationError()GetReadFlags()GetTabs()GetTargetVersion()GetVersion()GetWorldBounding()GetWriteFlags()HeaderCommentSeen()HPSCommentSeen()IndexToKey()KeyToIndex()LocateDictionary()LocateEntity()LogEntry()LogEntry()MatchPreviousExRef()NewFileContext()NextExternalReference()NextOpcodeSequence()NextTagIndex()ObjectsSoFar()OpenFile()OpenFile()OpenGeometry()OpenLogFile()ParseBuffer()ParseVersion()PeekTagIndex()PositionFile()PrepareBuffer()Read_Stream_File()ReadBuffer()RecordPause()RecordTexture()RemoveSegment()ReportQuantizationError()ReportQuantizationError()ResetQuantizationError()Restart()RevisitKey()RevisitOwner()SelectFile()SelectFile()SetAsciiMode()SetBufferLimit()SetDictionaryFormat()SetDictionaryOffset()SetDictionarySize()SetFilename()SetFilename()SetFileOffset()SetFirstPause()SetFlags()SetJpegQuality()SetLastKey()SetLogFile()SetLogging()SetLoggingOptions()SetNewFile()SetNewFile()SetNumColorBits()SetNumIndexBits()SetNumNormalBits()SetNumParameterBits()SetNumVertexBits()SetOpcodeHandler()SetOpcodeSequence()SetPostwalkHandler()SetPrewalkHandler()SetProgressCallback()SetProgressValue()SetReadFlags()SetReadVersion()SetTabs()SetTargetVersion()SetWorldBounding()SetWorldBoundingBySphere()SetWriteFlags()SupportsAsciiMode()suppress_crc_reinit()Unused()WriteBuffer()~BStreamFileToolkit()
Variables
Type Definitions
Methods
-
string_buffer &
BStreamFileToolkit::get_string_buffer(unsigned int index) protected
-
char *
BStreamFileToolkit::bsprintf_internal(unsigned int const &index, char const *format, ...) protected
-
BStreamFileToolkit::BStreamFileToolkit() Default constructor for an
BStreamFileToolkitobject
-
virtual
BStreamFileToolkit::~BStreamFileToolkit() virtual
-
TK_Status
BStreamFileToolkit::SetAsciiMode(bool whether) Ascii is a deprecated mode. DO NOT USE.
-
bool
BStreamFileToolkit::GetAsciiMode() Ascii is a deprecated mode. DO NOT USE.
-
void
BStreamFileToolkit::SetTabs(int)
-
int
BStreamFileToolkit::GetTabs()
-
virtual TK_Status
BStreamFileToolkit::ParseBuffer(char const *b, int s, TK_Status mode = TK_Normal) virtual
ParseBuffer reads the opcode at the start of the binary data buffer and continually calls the Read method of the associated opcode handler. The Read methods of the default object handlers read binary information from the buffer that was passed in and convert it into HOOPS/3dGS formatted segment, geometry and attribute information. After the opcode handler reports that reading is complete, ParseBuffer calls the Execute method of the opcode handler.
If the HOOPS/3dGS-specific opcode handlers are being used (the HoopsStream classes, of the form HTK_XXX) then the Execute methods will call the appropriate HOOPS/3dGS functions to either create segemnts, insert geometry or set attributes underneath the currently open HOOPS/3dGS segment. When using HoopsStream, a HOOPS/3dGS scene-graph segment must currently be open before calling ParseBuffer.
If the HOOPS/3dGS-independent default object handlers are used (the BaseStream classes, of the form TK_XXX), then the Execute method does nothing and the developer would need to overload it to map the HSF data to custom data structures.
If the buffer being parsed ends in the middle of an object, it will be saved along with any HOOPS database state information and the next buffer will be appended to it.
The mode parameter allows for control of how the buffer is parsed. The default of TK_Normal indicates read until the Termination code.
TK_Pause indicates read to the next Pause or Termination. If the HOOPS Stream File has been written out with default streaming properties, a pause will occur at the end of the HOOPS segment tree. This tree contains simple bounding box representations for the HOOPS geometric primitives that are used to represent facetted surfaces.
TK_Single indicates read only the first object in the buffer. If the buffer ends in the middle of an object, it will be saved and the next buffer will be appended to it. Any extra data in the buffer than is associated with more than one object is thrown away. This is referred to as ‘a la carte mode’, and is useful when the application wants specific entities to be read in from the file, typically from random locations. This is necessary for image sweetening.
Parameters
b: A pointer to a character buffer.
s: An integer denoting the length of the buffer.
mode: A flag controlling how the buffer is to be parsed.
Returns
The result of the function call.
-
TK_Status
BStreamFileToolkit::PrepareBuffer(char *b, int s) Tells the toolkit where to begin writing data.
Parameters
b: A character pointer denoting the buffer to write into.
s: Size of the buffer
-
int
BStreamFileToolkit::CurrentBufferLength() Returns how much of the internal data buffer is currently filled
-
virtual void
BStreamFileToolkit::ActivateContext(ID_Key key) virtual
While parsing a buffer it may be necessary to keep a context. This method will be called by ParseBuffer to activate a context, and should be overloaded to provide custom context-activation.
Parameters
key: A context identifier
-
virtual void
BStreamFileToolkit::DeactivateContext(ID_Key key) virtual
While parsing a buffer it may be necessary to keep a context. This method will be called by ParseBuffer to deactivate a context, and should be overloaded to provide custom context-deactivation.
Parameters
key: A context identifier
-
virtual void
BStreamFileToolkit::NewFileContext(ID_Key key) virtual
While processing External_References a previously visited context will be revisited. This method will be called by the default Read_Stream_File to indicate that context should be prepared to receive content, and should be overloaded to provide custom preparation. This might include operations such as clearing out any placeholder geometry.
Parameters
key: A context identifier
-
int
BStreamFileToolkit::GeneratedSoFar() const const
Returns the number of bytes that have been written since the beginning of the writing process. This is currently used internally during writing to build up a dictionary of file offets for each logical piece of binary data in the file, so that random lookups may be performed during file loading.
-
unsigned int
BStreamFileToolkit::ObjectsSoFar() const const
Returns the number of objects that have been written since the beginning of the writing process. This is available to applications for estimation of writing progress if there is a means of estimating the total.
-
void
BStreamFileToolkit::SetOpcodeHandler(int which, BBaseOpcodeHandler *handler) Registers an opcode handler for the specified type, allowing for variations on normal processing of HOOPS Stream Metafile objects, or handling of user-defined binary objects.
Parameters
which: The type of binary object to associated the opcode handler with.
handler: A pointer to an
BBaseOpcodeHandlerobject.
-
void
BStreamFileToolkit::SetPrewalkHandler(BBaseOpcodeHandler *handler) Registers an opcode handler which will be called by the toolkit before it processes (walks and imports/exports) the HOOPS segment tree. This allows the user to import/export user-specified data from/to the HOOPS Stream File, at a location prior to the segment tree information. objects, or handling of user-defined binary objects.
Parameters
handler: A pointer to anBBaseOpcodeHandlerobject.
-
void
BStreamFileToolkit::SetPostwalkHandler(BBaseOpcodeHandler *handler) Registers an opcode handler which will be called by the toolkit after it processes (walks and imports/exports) the HOOPS segment tree. This allows the user to import/export user-specified data from/to the HOOPS Stream File, at a location following the segment tree information. objects, or handling of user-defined binary objects.
Parameters
handler: A pointer to anBBaseOpcodeHandlerobject.
-
BBaseOpcodeHandler *
BStreamFileToolkit::GetOpcodeHandler(int which) const const
Returns
A pointer to the requested opcode handler
-
virtual void
BStreamFileToolkit::Restart() virtual
Initializes the file toolkit. This is useful if a single toolkit object is to be used for dealing with different files, rather than deleting the current toolkit object and creating a new instance. Call this function after processing of the current file is complete.
-
TK_Status
BStreamFileToolkit::IndexToKey(int index, ID_Key &key) const const
Calculates the HOOPS key associated with the specified index.
Parameters
index: An integer denoting a file index.
key: The HOOPS key associated with the specified index. Returned to user. Passed by reference.
Returns
The result of the function call.
-
TK_Status
BStreamFileToolkit::KeyToIndex(ID_Key key, int &index) const const
Calculates the index associated with the specified HOOPS key.
Parameters
key: A HOOPS key.
index: An integer denoting the file index associated with the HOOPS key. Returned to user. Passed by reference.
Returns
The result of the function call.
-
TK_Status
BStreamFileToolkit::AddIndexKeyPair(int index, ID_Key key) Associates a HOOPS key with a file index, and adds the an entry to the toolit’s index/key association table.
Parameters
index: An integer denoting a file index.
key: The HOOPS key that to associate with the specified index.
Returns
The result of the function call.
-
TK_Status
BStreamFileToolkit::AddVariant(ID_Key key, int variant, int value1, int value2 = -1) Records the file offset, and optionally the size, of a variant (LOD) associated with a previously recorded key.
Parameters
key: The HOOPS key of the object
variant: The variant (LOD number) being recorded
value1: The file offset of the start of the variant
value2: The size of the variant
Returns
The result of the function call.
-
TK_Status
BStreamFileToolkit::AddBounds(ID_Key key, float const bounds[]) Records the bounding volume associated with a previously recorded object.
Parameters
key: The HOOPS key of the object
bounds: The bounding volume as 6 floats (min & max points of a box)
Returns
The result of the function call.
-
TK_Status
BStreamFileToolkit::GetOffset(ID_Key key, int variant, int &offset) const const
Returns the file offset of a variant (LOD) associated with a previously recorded key.
Parameters
key: The HOOPS key of the object
variant: The variant (LOD number) being recorded
offset: The file offset of the start of the variant
Returns
The result of the function call.
-
TK_Status
BStreamFileToolkit::GetOffset(ID_Key key, int variant, int &offset, int &length) const const
Returns the file offset and length of a variant (LOD) associated with a previously recorded key.
Parameters
key: The HOOPS key of the object
variant: The variant (LOD number) being recorded
offset: The file offset of the start of the variant
length: The size of the variant (returned as 0 if unknown)
Returns
The result of the function call.
-
TK_Status
BStreamFileToolkit::GetOffset(ID_Key key, int variant, int &offset, int &length, __wchar_t const *&filename) const const
Returns the file offset and length of a variant (LOD) associated with a previously recorded key.
Parameters
key: The HOOPS key of the object
variant: The variant (LOD number) being recorded
offset: The file offset of the start of the variant
length: The size of the variant (returned as 0 if unknown)
filename: pointer to the stored filename associated with the key (may be null)
Returns
The result of the function call.
-
TK_Status
BStreamFileToolkit::GetBounds(ID_Key key, float bounds[]) const const
Returns the bounding volume associated with a previously recorded key.
Parameters
key: The HOOPS key of the object
bounds: The bounding volume as 6 floats (min & max points of a box)
Returns
The result of the function call.
-
int
BStreamFileToolkit::NextTagIndex() Reserves & returns the next available tag index
Returns
The tag index.
-
int
BStreamFileToolkit::PeekTagIndex() const const
Returns the next available tag index without reserving it for use
Returns
The tag index.
-
void
BStreamFileToolkit::SetFilename(char const *name) Sets the starting filename for the toolkit (normally used internally).
Parameters
name: The name of the file.
-
void
BStreamFileToolkit::SetFilename(__wchar_t const *name) Sets the starting filename for the toolkit (normally used internally).
Parameters
name: The name of the file.
-
TK_Status
BStreamFileToolkit::Read_Stream_File() Reads the file associated with the toolkit (internal utility).
Returns
The result of the function call.
-
void
BStreamFileToolkit::SetNewFile(char const *name) Associates a new filename with the toolkit.
Parameters
name: The name of the file.
-
void
BStreamFileToolkit::SetNewFile(__wchar_t const *name) Associates a new Unicode filename with the toolkit.
Parameters
name: The name of the file.
-
__wchar_t const *
BStreamFileToolkit::GetCurrentFile() const const
Returns the name of the last file, if any, that was associated with the toolkit.
Returns
The name of the file associated with the toolkit.
-
void
BStreamFileToolkit::GetCurrentFile(__wchar_t const *&filename) const const
Returns the name of the last file, if any, that was associated with the toolkit.
Parameters
The: pointer to receive the adress of then name of the file associated with the toolkit.
-
TK_Status
BStreamFileToolkit::SelectFile(char const *name) [Re]Selects a previously accessed file for further processing
Parameters
name: The name of the file.Returns
TK_Normal if the file was found and selected, TK_NotFound otherwise.
-
TK_Status
BStreamFileToolkit::SelectFile(__wchar_t const *name) [Re]Selects a previously accessed file for further processing
Parameters
name: The Unicode name of the file.Returns
TK_Normal if the file was found and selected, TK_NotFound otherwise.
-
virtual TK_Status
BStreamFileToolkit::OpenFile(char const *name, bool write = false) virtual
Opens a file. This acts as a simple wrapper for the ‘fopen’ command.
Parameters
name: The name of the file to open.
write: True if the file is open for writing, otherwise, file is open for reading.
Returns
The result of function call.
-
virtual TK_Status
BStreamFileToolkit::OpenFile(__wchar_t const *name, bool write = false) virtual
Opens a file. This acts as a simple wrapper for the ‘fopen’ command.
Parameters
name: The name of the file to open.
write: True if the file is open for writing, otherwise, file is open for reading.
Returns
The result of function call.
-
virtual TK_Status
BStreamFileToolkit::CloseFile() virtual
Closes a file. This acts as a simple wrapper for the ‘fclose’ command.
Returns
The result of function call.
-
virtual TK_Status
BStreamFileToolkit::ReadBuffer(char *buffer, int size, int &amount_read) virtual
Reads a buffer of data to the file associated with the
BStreamFileToolkitobject. This acts as a simple wrapper for the ‘fread’ command.Parameters
buffer: Character buffer used to store the data being read.
size: Integer denoting amount of data to read.
amount_read: The amount of data actually read into the buffer.
Returns
The result of function call.
-
virtual TK_Status
BStreamFileToolkit::WriteBuffer(char *buffer, int size) virtual
Writes a buffer of data to the file associated with the
BStreamFileToolkitobject. This acts as a simple wrapper for the ‘fwrite’ command.Parameters
buffer: Character buffer to be written out.
size: Integer denoting amount of data to write.
Returns
The result of function call.
-
virtual TK_Status
BStreamFileToolkit::PositionFile(int offset) virtual
Utility function which repositions the current file pointer. This acts a wrapper for fseek, and is used by LocateDictionary and LocateEntity, but might be reimplemented by classes derived from
BStreamFileToolkitto perform custom file repositioning.Parameters
offset: If positive, repositions the file pointer to offset bytes from the beginning of the file, otherwise repositions the file pointer to offset bytes from the end of the file.Returns
The result of function call.
-
virtual TK_Status
BStreamFileToolkit::GetFileSize(unsigned long &size) virtual
Utility function which returns the size of the currently open file. This acts a wrapper for fstat, and is used by the progress callback (if any), but might be reimplemented by classes derived from
BStreamFileToolkitto perform custom file repositioning.Parameters
size: reference to the variable to receive the file size.Returns
The result of function call.
-
virtual TK_Status
BStreamFileToolkit::LocateDictionary() virtual
Instructs the
BStreamFileToolkitobject to sets its internal file pointer to the location of the file dictionary. The dictionary contains entries for the file locations of various representations of entities.Objects which are derived from
BStreamFileToolkitmay reimplement to support locating a dictionary for a file that resides on a remote location such as a web server. This might involve passing a message that instructs the server process to locate the dictionary.Returns
The result of function call.
-
virtual TK_Status
BStreamFileToolkit::LocateEntity(ID_Key key, int variant) virtual
Instructs the
BStreamFileToolkitobject to sets its internal file pointer to the location of a variant of an entity, which could be the full representation or a LOD representation. This allows reading a single entity from the file, even though it resides at an offset in the file.Parameters
key: The key of a HOOPS entity.
variant: The variant of the HOOPS entity to locate. 0 represents the full representation, 1 represents LOD level 1, etc….
Returns
The result of function call.
-
int
BStreamFileToolkit::GetFlags() const const
Deprecated; Use GetWriteFlags; Returns the writing flags set on the toolkit.
-
void
BStreamFileToolkit::SetFlags(int flags) Deprecated; Use SetWriteFlags; Sets the toolkit writing flags.
-
void
BStreamFileToolkit::SetWriteFlags(int flags) Sets the toolkit writing flags. These flags control a variety of export properties, and are defined in
TK_File_Write_Options
-
int
BStreamFileToolkit::GetWriteFlags(int mask = ~0) const const
Returns the writing flags set on the toolkit. These flags control a variety of export properties, and are defined in
TK_File_Write_OptionsParameters
mask: of flags to be returned (default is all).Returns
The result of function call.
-
void
BStreamFileToolkit::SetReadFlags(int flags) Sets the toolkit reading flags. These flags control various import properties, and are defined in
TK_File_Read_Options
-
int
BStreamFileToolkit::GetReadFlags(int mask = ~0) const const
Returns the reading flags set on the toolkit. These flags control various import properties, and are defined in
TK_File_Read_OptionsParameters
mask: of flags to be returned (default is all).Returns
The result of function call.
-
int
BStreamFileToolkit::GetNumNormalBits() const const
Returns the maximum number of bits that will be used per normal
-
void
BStreamFileToolkit::SetNumNormalBits(int numbits) Sets the maximum number of bits that will be used per normal (x,y, and z combined). The default is 10 (for the entire normal). Opcode handlers may, at their option, decide to use less
-
int
BStreamFileToolkit::GetNumVertexBits() const const
Returns the maximum number of bits that will be used per vertex location (x,y,z combined).
-
void
BStreamFileToolkit::SetNumVertexBits(int numbits) Sets the maximum number of bits to use for vertex locations (x,y, and z combined). Default is 24.
-
int
BStreamFileToolkit::GetNumParameterBits() const const
Returns 3 times the number of bits that will be used per sample in vertex parameters (texture cordinate)
-
void
BStreamFileToolkit::SetNumParameterBits(int numbits) Sets the number of bits per sample for vertex parameters (texture coordinates). For backwards compatibility it is specified as 3 times the number (previous versions of the stream toolkit specified the number of bits for the entire parameter, but always assumed 3 parameters (u,v,w) per vertex). Thus, for example, if you specify ‘24’ bits, a 1d texture will have 8 bits total, a 2d texture will have 16, and a 3d texture will have 24.
-
int
BStreamFileToolkit::GetNumColorBits() const const
Returns the maximum number of bits that will be used per vertex color
-
void
BStreamFileToolkit::SetNumColorBits(int numbits) Sets the maximum number of bits to use for vertex colors
-
int
BStreamFileToolkit::GetNumIndexBits() const const
Returns the maximum number of bits that will be used per vertex color-by-index
-
void
BStreamFileToolkit::SetNumIndexBits(int numbits) Sets the maximum number of bits to use for vertex colors-by-index
-
void
BStreamFileToolkit::SetJpegQuality(int quality = 75) Sets the quality level for JPEG compression, range is 0-100, 0 disables, 75 by default
-
int
BStreamFileToolkit::GetJpegQuality() const const
Returns the current JPEG quality setting
-
int
BStreamFileToolkit::GetVersion() const const
Returns the file format version during reading
-
void
BStreamFileToolkit::SetReadVersion(int version) for reading embedded hsf data for which format version is externally available.
-
void
BStreamFileToolkit::SetTargetVersion(int version) This method sets the file format version desired for writing. The default value for the target version is the most recent version in the File Version table.
\param version The HSF file version you are writing out. For instance, to export a v15.00 HSF File, pass 1500.
-
int
BStreamFileToolkit::GetTargetVersion() const const
Returns the file format version desired for writing
-
unsigned int
BStreamFileToolkit::GetFileOffset() const 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)
-
void
BStreamFileToolkit::SetFileOffset(unsigned int offset) 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)
-
int
BStreamFileToolkit::Unused() const const
Returns
the amount of data in the user’s buffer left unused
-
virtual TK_Status
BStreamFileToolkit::Error(char const *msg = 0) const const virtual
Prints out a debug message informing the user that an error has occurred. Also provides a handy choke point for break points during debugging.
Returns
TK_Error always
-
char const *
BStreamFileToolkit::GetLogFile() const const
Returns the name of the log file
-
void
BStreamFileToolkit::SetLogFile(char const *filename = 0) Sets the name of the log file
-
bool
BStreamFileToolkit::GetLogging() const const
Returns the logging state
-
void
BStreamFileToolkit::SetLogging(bool setting) Sets the logging state. If true, the toolkit will output files called hsf_export_log.txt and hsf_import_log.txt which contain a byte representing each opcode that was exported or imported. during the write and/or read phase, respectively.
-
unsigned int
BStreamFileToolkit::GetLoggingOptions(unsigned int mask = ~0) const const
Returns the logging options
-
void
BStreamFileToolkit::SetLoggingOptions(unsigned int options = ~0) Sets the logging options. controls the types of logging information collected.
-
TK_Status
BStreamFileToolkit::OpenLogFile(char const *filename, char const *mode) Opens the log file for writing.
Parameters
filename: the name of the file to be opened as a log
mode: passed through to fopen
Returns
TK_Error on failure
-
void
BStreamFileToolkit::LogEntry(char const *string) const const
Writes a message into the log
-
void
BStreamFileToolkit::LogEntry(__wchar_t const *string) const const
Writes a message into the log with wide characters
-
void
BStreamFileToolkit::CloseLogFile() Closes the log file
-
unsigned int
BStreamFileToolkit::NextOpcodeSequence() internal use
-
void
BStreamFileToolkit::SetOpcodeSequence(unsigned int seq = 0) internal use
-
bool
BStreamFileToolkit::HeaderCommentSeen() const const
Returns true if the header comment has been processed
-
bool
BStreamFileToolkit::HPSCommentSeen() const const
Returns true if the HPS comment has been processed
-
TK_Progress_Callback
BStreamFileToolkit::GetProgressCallback() const const
Returns the progress callback
-
void
BStreamFileToolkit::SetProgressCallback(TK_Progress_Callback cb = 0) Sets the progress callback
-
void *
BStreamFileToolkit::GetProgressValue() const const
Returns the progress passthrough value
-
void
BStreamFileToolkit::SetProgressValue(void *value) Sets the progress passthrough value
-
int
BStreamFileToolkit::GetBufferLimit() const const
Returns the progress passthrough value
-
void
BStreamFileToolkit::SetBufferLimit(int limit) Sets the progress passthrough value
-
void
BStreamFileToolkit::SetLastKey(ID_Key key) Reports to the toolkit the identifier of the last object processed
-
TK_Status
BStreamFileToolkit::AppendLastKey(ID_Key key) Appends the identifier of the last object processed to the current identifier list
-
void
BStreamFileToolkit::ClearLastKey() Clears identifier of the last object processed
-
TK_Status
BStreamFileToolkit::GetLastKey(ID_Key &key) const const
Returns identifier of the last object processed
-
void
BStreamFileToolkit::SetDictionaryFormat(int format = 3, int options = TK_Dictionary_Bounding_Volumes) Sets the desired dictionary format level and options
Parameters
format: The desried dictionary format
options: Bitmask of any options that many modify a specific format
-
int
BStreamFileToolkit::GetDictionaryFormat() const const
Returns the currently requested dictionary format level
Returns
Dictionary format
-
int
BStreamFileToolkit::GetDictionaryOptions() const const
Returns the options for the dictionary format.
Returns
Dictionary options bitmask
-
void
BStreamFileToolkit::SetDictionaryOffset(int offset) Sets (records) the dictionary offset
Parameters
offset: The dictionary offset
-
int
BStreamFileToolkit::GetDictionaryOffset() const const
Returns the recorded dictionary offset
Returns
Dictionary offset
-
void
BStreamFileToolkit::SetDictionarySize(int size) Sets (records) the dictionary size
Parameters
size: The dictionary size
-
int
BStreamFileToolkit::GetDictionarySize() const const
Returns the recorded dictionary size
Returns
Dictionary size
-
void
BStreamFileToolkit::RecordPause(int offset) Record a pause at the given file offset
Parameters
offset: File offset of this pause
-
void
BStreamFileToolkit::ClearPauses() Clears the pause table
-
int
BStreamFileToolkit::GetPauseCount() const const
Returns the number of pauses recorded
Returns
The number of pauses
-
int const *
BStreamFileToolkit::GetPauseTable() const const
Returns the pause offsets
Returns
address of an array of file offsets corresponding the the pauses
-
void
BStreamFileToolkit::SetFirstPause(int offset) supported for older code
-
int
BStreamFileToolkit::GetFirstPause() const const
supported for older code
-
int
BStreamFileToolkit::GetPosition() const const
Returns the current file position
-
void
BStreamFileToolkit::SetWorldBounding(float const bbox[]) Sets the global bounding box to be used for bounding box aggegation. This is utilized when the TK_Global_Quantization bit of TK_File_Write_Options is set
Parameters
bbox: pointer to the bounding box coordinates
-
void
BStreamFileToolkit::SetWorldBoundingBySphere(float const pt[], float radius) Sets the global bounding box (by sphere) be used for bounding box aggegation. This is utilized when the TK_Global_Quantization bit of TK_File_Write_Options is set
Parameters
pt: center point of sphere
radius: radius of sphere
-
float const *
BStreamFileToolkit::GetWorldBounding() const const
Returns
the world bounding box
-
bool
BStreamFileToolkit::AddExternalReference(char const *ref, ID_Key context) Saves an external reference (string) and associated context (current open segment) to be processed.
Parameters
ref: external reference string
context: external reference context
Returns
true if the reference was added, false if the reference would form a loop
-
bool
BStreamFileToolkit::AddExternalReference(__wchar_t const *ref, ID_Key context) Saves an external reference (Unicode string) and associated context (current open segment) to be processed.
Parameters
ref: external reference Unicode string
context: external reference context
Returns
true if the reference was added, false if the reference would form a loop
-
bool
BStreamFileToolkit::NextExternalReference() Removes the current external reference and readies the next one (if any).
Returns
true if another external reference is present
-
wchar_t const *
BStreamFileToolkit::GetExternalReference() const const
Returns the string representing the external reference at the beginning of the list, null if none.
Returns
external reference string
-
void
BStreamFileToolkit::GetExternalReference(__wchar_t const *&exref) const const
Returns the string representing the external reference at the beginning of the list, null if none.
Parameters
pointer: to receive the address of the external reference string
-
ID_Key
BStreamFileToolkit::GetExternalReferenceContext() const const
Returns the context associated with the external reference at the beginning of the list, -1 if none.
Returns
external reference context
-
virtual bool
BStreamFileToolkit::MatchPreviousExRef() const const virtual
Allows derived toolkits to process an external reference directly if it matches a previous one
Returns
true if the function matched and handled the reference, false if we need to try to read the reference
-
void
BStreamFileToolkit::AddSegment(ID_Key key) Adds the specified key to the from of a list to keep track of “open” segments.
Parameters
key: of segment being openned
-
ID_Key
BStreamFileToolkit::RemoveSegment() Removes the most currently “openned” segment
Returns
the key of the segment which was removed
-
ID_Key
BStreamFileToolkit::CurrentSegment() Returns the key of the currently “open” segment
Returns
key of the current segment
-
void
BStreamFileToolkit::ResetQuantizationError() resets the quantization error back to zero
-
void
BStreamFileToolkit::ReportQuantizationError(float error) Intended primarily for use by opcode handlers, this function sets m_quantization_error to error if it is the largest error seen so far.
-
void
BStreamFileToolkit::ReportQuantizationError(int bits_per_sample, float const *bounding, int num_dimensions = 3) Intended primarily for use by opcode handlers, this function calculates the longest dimension cell size and uses that as an upper bound on quantization error for a call to ReportQuantizationError
-
float
BStreamFileToolkit::GetQuantizationError() const const
Returns
the largest quantization error reported by any of the opcodes during writing. Error reported is object space, with no attempt to account for modelling matrices.
-
virtual TK_Status
BStreamFileToolkit::OpenGeometry() virtual
Prepares the toolkit for dealing with geometry-level attributes
Returns
status of the request, error if a geometry is already open
-
virtual TK_Status
BStreamFileToolkit::CloseGeometry() virtual
Completes dealing with geometry-level attributes
Returns
status of the request, error if no geometry is open
-
bool
BStreamFileToolkit::GeometryIsOpen() const const
Queries the state of geometry-level attribute handling
Returns
whether geometry-level handling is active
-
ID_Key
BStreamFileToolkit::RevisitKey() const const
-
ID_Key
BStreamFileToolkit::RevisitOwner() const const
-
void
BStreamFileToolkit::RecordTexture(char const *name)
-
bool
BStreamFileToolkit::suppress_crc_reinit(bool state)
-
template<typename ...
Args>
char *BStreamFileToolkit::bsprintf(unsigned int index, char const *format, Args&&... args)
-
char *
BStreamFileToolkit::bstrcpy(unsigned int index, char const *input)
-
char *
BStreamFileToolkit::bstrcat(unsigned int index, char const *input)
-
char *
BStreamFileToolkit::bstrclr(unsigned int index = 0)
-
char *
BStreamFileToolkit::btrim(unsigned int index, char which)
-
char *
BStreamFileToolkit::bfixend(unsigned int index, char which, char what)
-
template<typename ...
Args>
char *BStreamFileToolkit::bsprintf(char const *format, Args&&... args)
-
char *
BStreamFileToolkit::bstrcpy(char const *input)
-
char *
BStreamFileToolkit::bstrcat(char const *input)
-
char *
BStreamFileToolkit::btrim(char which)
-
char *
BStreamFileToolkit::bfixend(char which, char what)
-
char *
BStreamFileToolkit::bfetch(unsigned int index = 0)
-
size_t
BStreamFileToolkit::bstrlen(unsigned int index = 0)
-
char *
BStreamFileToolkit::bfloat(unsigned int index, float f)
-
char *
BStreamFileToolkit::bfloat(float f)
-
size_t
BStreamFileToolkit::bfloat_size()
-
static bool
BStreamFileToolkit::SupportsAsciiMode() static
Ascii is a deprecated mode. DO NOT USE.
-
static int
BStreamFileToolkit::ParseVersion(char const *block) static
ParseVersion attempts to read a given block as a header to extract the file version
Parameters
block: A pointer to a character buffer.Returns
the version number if the block starts with “;; HSF V”, otherwise 0
Variables
-
void *
BStreamFileToolkit::m_file protected
voidPointer to the file associated with the
BStreamFileToolkitobject
-
std::vector<string_buffer>
BStreamFileToolkit::m_string_buffers protected
std::vector< string_buffer >
-
std::vector<string_buffer>
BStreamFileToolkit::m_float_buffers protected
std::vector< string_buffer >
-
constexpr int
BStreamFileToolkit::buffer_count protected static
const expr int
-
constexpr int
BStreamFileToolkit::buffer_size_default protected static
const expr int
-
constexpr int
BStreamFileToolkit::buffer_size_extra protected static
const expr int
-
constexpr int
BStreamFileToolkit::null_size protected static
const expr int
-
constexpr int
BStreamFileToolkit::float_buffer_count protected static
const expr int
-
constexpr int
BStreamFileToolkit::float_buffer_size protected static
const expr int