The HStreamFileToolkit class provides support for exporting/importing HOOPS Stream File information from/to a HOOPS/3dGS scene-graph. More...
#include <HStreamFileToolkit.h>
Public Member Functions | |
void | ActivateContext (ID_Key key) |
void | AddExcludedSegment (HC_KEY key) |
void | AddExcludedSegments (int count, HC_KEY const keys[]) |
void | ClearExcludedSegments () |
unsigned POINTER_SIZED_INT | CountObjects (char const *start_segment=0) |
void | DeactivateContext (ID_Key key) |
TK_Status | GenerateBuffer (char *b, int s, int &f, char const *start_segment=0) |
TK_Status | GenerateOneItemBuffer (char *b, int s, int &f, HC_KEY item) |
int | GetExcludedSegmentCount () const |
HC_KEY const * | GetExcludedSegments () const |
int | GetHoopsVersion () |
const char * | GetPrependRootSegment () |
HStreamFileToolkit () | |
bool | MatchPreviousExRef () const |
void | NewFileContext (ID_Key key) |
void | Restart () |
bool | SegmentIsExcluded (HC_KEY key) const |
void | SetPrependRootSegment (const char *segment) |
void | SetThumbnail (BBaseOpcodeHandler *handler) |
void | SetThumbnail (int format, int width, int height, unsigned char const *data) |
TK_Status | StringToHandler (char const *type, BBaseOpcodeHandler **handler) |
TK_Status | StringToOpcode (char const *type, unsigned char *opcode_out) |
TK_Status | Write_Stream_File () |
Public Attributes | |
char const ** | m_search_strings |
Protected Member Functions | |
void | add_unnamed_segment (HC_KEY key) |
internal use | |
unsigned HLONG | count_segment_objects (HC_KEY key, char const *start_segment=0) |
internal use | |
void | empty_lists () |
internal use | |
virtual void | FileDone () |
void | read_completed () |
internal use | |
TK_Status | tag (int variant) |
internal use | |
void | validate_hoops_version () |
internal use | |
Friends | |
class | HTK_Delete_Object |
class | HTK_Image |
class | HTK_Named_Style_Def |
class | HTK_Open_Segment |
class | HTK_Reference |
class | HTK_Referenced_Segment |
class | HTK_Texture |
class | Internal_Segment_Processor |
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:
HStreamFileToolkit::HStreamFileToolkit | ( | ) |
Default constructor for an HStreamFileToolkit object
void HStreamFileToolkit::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.
key | A context identifier |
Reimplemented from BStreamFileToolkit.
void HStreamFileToolkit::AddExcludedSegment | ( | HC_KEY | key | ) | [inline] |
Adds one key to the list of segments to skip during write
key | the key of one segment |
void HStreamFileToolkit::AddExcludedSegments | ( | int | count, |
HC_KEY const | keys[] | ||
) |
Adds to the list of keys indicating segments to skip during write
count | the number of keys in the array |
keys | the array of keys of segments |
void HStreamFileToolkit::ClearExcludedSegments | ( | ) |
Clears the list of excluded segments;
unsigned POINTER_SIZED_INT HStreamFileToolkit::CountObjects | ( | char const * | start_segment = 0 | ) |
Traverses the HOOPS database beginning at the currently open segment and estimates the number of objects that will be written by a matching call (or series of calls) to GenerateBuffer()
A HOOPS/3dGS segment must currently be open before calling CountObjects, or a segment must be specified.
start_segment | Explicit name of a Hoops segment to process (current segment if null). |
void HStreamFileToolkit::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.
key | A context identifier |
Reimplemented from BStreamFileToolkit.
TK_Status HStreamFileToolkit::GenerateBuffer | ( | char * | b, |
int | s, | ||
int & | f, | ||
char const * | start_segment = 0 |
||
) |
Traverses the HOOPS database beginning at the currently open segment and calls the Interpret method of the opcode handler associated with each object encountered. The Interpret methods of the default object handlers query the HOOPS database to obtain segment, geometry and attribute information. After interpretation is complete, GenerateBuffer continually calls the Write method of the opcode handler until writing is complete. The Write methods of the default handlers convert the HOOPS database information into a specific binary format.
A HOOPS segment must currently be open before calling GenerateBuffer, or a segment name must be given.
If the buffer being generated 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.
b | A character pointer. Returned to user. |
s | An integer denoting the length of the buffer in bytes. |
f | An integer denoting the length of the buffer that was written back, in bytes. |
start_segment | Explicit name of a hoops segment to process (currently open segment if null) |
This method is similar to GenerateBuffer. However, instead of traversing the HOOPS database beginning at the currently open segment, only the item specified will be processed.
If the buffer being generated 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.
b | A character pointer. Returned to user. |
s | An integer denoting the length of the buffer in bytes. |
f | An integer denoting the length of the buffer that was written back, in bytes. |
item | Key of the single segment or piece of geometry to process. |
int HStreamFileToolkit::GetExcludedSegmentCount | ( | ) | const [inline] |
Gets the current number of keys of excluded segments
HC_KEY const* HStreamFileToolkit::GetExcludedSegments | ( | ) | const [inline] |
Gets the array of keys of excluded segments
References HC_KEY.
int HStreamFileToolkit::GetHoopsVersion | ( | ) | [inline] |
Determines the version of HOOPS/3dGS the toolkit is using. Some features may not be present on older versions or may be handled differently or can be emulated; querying the version allows opcode handlers to adjust their behaviour accordingly.
const char* HStreamFileToolkit::GetPrependRootSegment | ( | ) | [inline] |
Gets the segment to prepend to rooted segments well reading
segment | name of segment |
bool HStreamFileToolkit::MatchPreviousExRef | ( | ) | const [virtual] |
See if we can match a previous ExRef and just include the segment it generated
Reimplemented from BStreamFileToolkit.
void HStreamFileToolkit::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.
key | A context identifier |
Reimplemented from BStreamFileToolkit.
void HStreamFileToolkit::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.
Reimplemented from BStreamFileToolkit.
bool HStreamFileToolkit::SegmentIsExcluded | ( | HC_KEY | key | ) | const |
Determines if a particular segment key is on the exclusion list
key | key of the segment to be checked |
void HStreamFileToolkit::SetPrependRootSegment | ( | const char * | segment | ) |
Sets a segment to prepend to rooted segments well reading
segment | name of segment |
void HStreamFileToolkit::SetThumbnail | ( | BBaseOpcodeHandler * | handler | ) |
Registers an opcode handler which will be called by the toolkit after the header and before it gets into other processing (and possibly compressing data). This allows the user to include a simple thumbnail image which an application might load as a preview for things like file selection.
handler | A pointer to an BBaseOpcodeHandler object. |
void HStreamFileToolkit::SetThumbnail | ( | int | format, |
int | width, | ||
int | height, | ||
unsigned char const * | data | ||
) |
Generates an opcode handler preset with the provided image data which will be called by the toolkit after the header and before it gets into other processing (and possibly compressing data). This allows the user to include a simple thumbnail image which an application might load as a preview for things like file selection.
format | format of the thumbnail. Formats are specified in TKO_Thumbnail_Formats |
width | width of the thumbnail image |
height | height of the thumbnail image |
data | array of thumbnail image data |
TK_Status HStreamFileToolkit::StringToHandler | ( | char const * | type, |
BBaseOpcodeHandler ** | handler | ||
) |
Generates clones of OpcodeHandlers to interpret geometry lists, such as those found in LODs intended primarily (but not exclusively) for internal use.
type | the string returned from HOOPS' Find_Contents. |
handler | the opcode handler (returned to user) |
TK_Status HStreamFileToolkit::StringToOpcode | ( | char const * | type, |
unsigned char * | opcode_out | ||
) |
maps HOOPS strings to the opcodes that handle them. intended primarily (but not exclusively) for internal use.
type | the string returned from HOOPS' Find_Contents. |
opcode_out | the opcode (returned to user), assigned to one of the TKE_Object_Types as defined in BOpcodeHandler.h |
TK_Status HStreamFileToolkit::Write_Stream_File | ( | ) |
Writes the file associated with the toolkit (internal utility).