Handles the TKE_Comment opcode. More...
#include <BOpcodeHandler.h>
Public Member Functions | |
TK_Status | Execute (BStreamFileToolkit &tk) |
TK_Status | ExecuteAscii (BStreamFileToolkit &tk) |
char const * | GetComment () const |
char * | GetComment () |
TK_Status | Interpret (BStreamFileToolkit &tk, ID_Key key, int variant) |
TK_Status | Interpret (BStreamFileToolkit &tk, ID_Key key, char const *special) |
TK_Status | Read (BStreamFileToolkit &tk) |
TK_Status | ReadAscii (BStreamFileToolkit &tk) |
Deprecated. | |
void | Reset () |
void | SetComment (char const *comment) |
void | SetComment (int length) |
TK_Comment (char const *comment=0) | |
TK_Status | Write (BStreamFileToolkit &tk) |
TK_Status | WriteAscii (BStreamFileToolkit &tk) |
Deprecated. | |
![]() | |
BBaseOpcodeHandler (int op) | |
virtual TK_Status | Clone (BStreamFileToolkit &tk, BBaseOpcodeHandler **handler) const |
unsigned char | General_Flags () const |
char const * | GetLoggingString () const |
char * | GetLoggingString () |
bool | IsCollectionPart () const |
void | LogDebug (BStreamFileToolkit &tk, char const *string=0) |
virtual bool | Match_Instance (BStreamFileToolkit const &tk, Recorded_Instance *instance) |
virtual bool | NeedsContext (BStreamFileToolkit &tk) const |
bool | NeedsTag () const |
unsigned char | Opcode () const |
int | Pass (BStreamFileToolkit &tk) const |
void | Set_General_Flags (int f) |
void | SetCollectionPart (bool n) |
void | SetLoggingString (char const *segment) |
void | SetLoggingString (int length) |
void | SetNeedsTag (bool n) |
TK_Status | Tag (BStreamFileToolkit &tk, int variant=-1) const |
bool | Tagging (BStreamFileToolkit &tk) const |
![]() | |
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 | |
Protected Member Functions | |
void | set_comment (char const *comment) |
internal use | |
void | set_comment (int length) |
internal use | |
![]() | |
void | add_segment (BStreamFileToolkit &tk, ID_Key key) |
for internal use only | |
void | adjust_written (BStreamFileToolkit &tk, int count) |
for internal use only | |
void | bytes_to_floats (unsigned char const *in, float *out, int count) const |
for internal use only | |
void | decrease_nesting (BStreamFileToolkit &tk, int amount=1) |
for internal use only | |
bool | Find_Instance (BStreamFileToolkit &tk, int val1, int val2, int val3) |
bool | Find_Item (BStreamFileToolkit &tk, ID_Key key) const |
void | floats_to_bytes (float const *in, unsigned char *out, int count) const |
for internal use only | |
TK_Status | GetAsciiData (BStreamFileToolkit &tk, int *rInts, unsigned int n) |
TK_Status | GetAsciiData (BStreamFileToolkit &tk, const char *tag, unsigned char &value) |
TK_Status | GetAsciiData (BStreamFileToolkit &tk, const char *tag, char &value) |
TK_Status | GetAsciiData (BStreamFileToolkit &tk, const char *tag, unsigned short &value) |
TK_Status | GetAsciiData (BStreamFileToolkit &tk, const char *tag, short &value) |
TK_Status | GetAsciiData (BStreamFileToolkit &tk, const char *tag, int &value) |
TK_Status | GetAsciiData (BStreamFileToolkit &tk, const char *tag, float &value) |
TK_Status | GetAsciiData (BStreamFileToolkit &tk, const char *tag, float *rFloats, unsigned int n) |
TK_Status | GetAsciiData (BStreamFileToolkit &tk, const char *tag, char *m_string, unsigned int n) |
TK_Status | GetAsciiData (BStreamFileToolkit &tk, const char *tag, unsigned char *m_string, unsigned int n) |
TK_Status | GetAsciiData (BStreamFileToolkit &tk, const char *tag, int *rInts, unsigned int n) |
TK_Status | GetAsciiData (BStreamFileToolkit &tk, const char *tag, short *rShorts, unsigned int n) |
TK_Status | GetAsciiData (BStreamFileToolkit &tk, const char *tag, unsigned short *rShorts, unsigned int n) |
TK_Status | GetAsciiHex (BStreamFileToolkit &tk, const char *tag, unsigned char &value) |
TK_Status | GetAsciiHex (BStreamFileToolkit &tk, const char *tag, int &value) |
TK_Status | GetAsciiHex (BStreamFileToolkit &tk, const char *tag, char &value) |
TK_Status | GetAsciiHex (BStreamFileToolkit &tk, const char *tag, unsigned short &value) |
TK_Status | GetAsciiImageData (BStreamFileToolkit &tk, const char *tag, unsigned char *rValues, unsigned int n) |
TK_Status | GetGeneral (BStreamFileToolkit &tk) |
void | increase_nesting (BStreamFileToolkit &tk, int amount=1) |
for internal use only | |
ID_Key | last_key (BStreamFileToolkit &tk) const |
obsolete | |
void | log_opcode (BStreamFileToolkit &tk, unsigned int sequence, unsigned char opcode) |
for internal use only | |
BBaseOpcodeHandler * | Opcode_Handler (BStreamFileToolkit &tk, unsigned char op) const |
TK_Status | PutAsciiData (BStreamFileToolkit &tk, char const *tag, char const *b, int n) |
TK_Status | PutAsciiData (BStreamFileToolkit &tk, char const *tag, short const *s, int n) |
TK_Status | PutAsciiData (BStreamFileToolkit &tk, char const *tag, int const *i, int n) |
TK_Status | PutAsciiData (BStreamFileToolkit &tk, char const *tag, float const *f, int n) |
TK_Status | PutAsciiData (BStreamFileToolkit &tk, char const *tag, unsigned char const *b, int n) |
TK_Status | PutAsciiData (BStreamFileToolkit &tk, char const *tag, unsigned short const *s, int n) |
TK_Status | PutAsciiData (BStreamFileToolkit &tk, char const *tag, unsigned int const *i, int n) |
TK_Status | PutAsciiData (BStreamFileToolkit &tk, char const *tag, char const &c) |
TK_Status | PutAsciiData (BStreamFileToolkit &tk, char const *tag, short const &s) |
TK_Status | PutAsciiData (BStreamFileToolkit &tk, char const *tag, int const &i) |
TK_Status | PutAsciiData (BStreamFileToolkit &tk, char const *tag, unsigned char const &b) |
TK_Status | PutAsciiData (BStreamFileToolkit &tk, char const *tag, unsigned short const &s) |
TK_Status | PutAsciiData (BStreamFileToolkit &tk, char const *tag, unsigned int const &i) |
TK_Status | PutAsciiData (BStreamFileToolkit &tk, char const *tag, float const &f) |
TK_Status | PutAsciiFlag (BStreamFileToolkit &tk, char const *tag, int const &i) |
TK_Status | PutAsciiHex (BStreamFileToolkit &tk, char const *tag, int const &i) |
TK_Status | PutAsciiMask (BStreamFileToolkit &tk, char const *tag, int const &i) |
TK_Status | PutAsciiOpcode (BStreamFileToolkit &tk, int adjust=1, bool is_end=false, bool want_newline=true) |
TK_Status | PutEndXMLTag (BStreamFileToolkit &tk, char const *tag) |
TK_Status | PutGeneral (BStreamFileToolkit &tk) |
TK_Status | PutOpcode (BStreamFileToolkit &tk, int adjust=1) |
TK_Status | PutStartXMLTag (BStreamFileToolkit &tk, char const *tag) |
TK_Status | Read_Referenced_Segment (BStreamFileToolkit &tk, int &i_progress) |
TK_Status | ReadAsciiLine (BStreamFileToolkit &tk, unsigned int *readSize=0) |
TK_Status | ReadAsciiWord (BStreamFileToolkit &tk, unsigned int *readSize=0) |
TK_Status | ReadEndOpcode (BStreamFileToolkit &tk) |
void | Record_Instance (BStreamFileToolkit &tk, ID_Key key, int variant, int val1, int val2, int val3) const |
void | Remember_Item (BStreamFileToolkit &tk, ID_Key key) const |
ID_Key | remove_segment (BStreamFileToolkit &tk) |
for internal use only | |
bool | RemoveAngularBrackets (char *string) |
bool | RemoveQuotes (char *string) |
void | Revisit (BStreamFileToolkit &tk, float priority=0.0f, int variant=0) const |
void | set_last_key (BStreamFileToolkit &tk, ID_Key key) |
sets the given key as "most recent" on the toolkit for the purposes of associating keys with indices | |
TK_Status | SkipNewlineAndTabs (BStreamFileToolkit &tk, unsigned int *readSize=0) |
bool | validate_count (int count, int limit=1<< 24) const |
Protected Attributes | |
int | m_allocated |
internal use | |
char * | m_comment |
internal use | |
int | m_length |
internal use | |
![]() | |
char * | m_ascii_buffer |
int | m_ascii_length |
int | m_ascii_progress |
Tracks the amount of data that has been read/written so far by GetAscii functions. | |
int | m_ascii_size |
int | m_ascii_stage |
unsigned char | m_byte |
temporary | |
char | m_char |
temporary | |
bool | m_collection_part |
Indicates if this object is part of a LOD collection. | |
int | m_debug_allocated |
char * | m_debug_string |
unsigned char | m_general_flags |
Basic flags common to many handlers. | |
int | m_int |
temporary | |
bool | m_needs_tag |
Indicate if this object explicitly needs tagging. | |
unsigned char | m_opcode |
The opcode being handled by this particular object. | |
int | m_progress |
Tracks the amount of data that has been read/written so far. | |
int | m_stage |
The writing stage. | |
unsigned short | m_unsigned_short |
temporary | |
Additional Inherited Members | |
![]() | |
static void | fix (int *i, int n) |
for internal use only | |
static void | fix (short *s, int n) |
for internal use only | |
static void | fix_in (float *f, int n) |
for internal use only | |
static void | fix_in (double *d, int n) |
for internal use only | |
static void | fix_out (float *f, int n) |
for internal use only | |
static void | fix_out (double *d, int n) |
for internal use only | |
static short | flip (short s) |
for internal use only | |
static int | flip (int i) |
for internal use only | |
static TK_Status | GetData (BStreamFileToolkit &tk, char *b, int n) |
static TK_Status | GetData (BStreamFileToolkit &tk, short *s, int n) |
static TK_Status | GetData (BStreamFileToolkit &tk, int *i, int n) |
static TK_Status | GetData (BStreamFileToolkit &tk, float *f, int n) |
static TK_Status | GetData (BStreamFileToolkit &tk, double *d, int n) |
static TK_Status | GetData (BStreamFileToolkit &tk, unsigned char *b, int n) |
static TK_Status | GetData (BStreamFileToolkit &tk, unsigned short *s, int n) |
static TK_Status | GetData (BStreamFileToolkit &tk, unsigned int *i, int n) |
static TK_Status | GetData (BStreamFileToolkit &tk, char &c) |
static TK_Status | GetData (BStreamFileToolkit &tk, short &s) |
static TK_Status | GetData (BStreamFileToolkit &tk, int &i) |
static TK_Status | GetData (BStreamFileToolkit &tk, unsigned char &b) |
static TK_Status | GetData (BStreamFileToolkit &tk, unsigned short &s) |
static TK_Status | GetData (BStreamFileToolkit &tk, unsigned int &i) |
static TK_Status | GetData (BStreamFileToolkit &tk, float &f) |
static TK_Status | GetData (BStreamFileToolkit &tk, double &d) |
static TK_Status | LookatData (BStreamFileToolkit &tk, unsigned char &b) |
static TK_Status | PutData (BStreamFileToolkit &tk, char const *b, int n) |
static TK_Status | PutData (BStreamFileToolkit &tk, short const *s, int n) |
static TK_Status | PutData (BStreamFileToolkit &tk, int const *i, int n) |
static TK_Status | PutData (BStreamFileToolkit &tk, float const *f, int n) |
static TK_Status | PutData (BStreamFileToolkit &tk, double const *d, int n) |
static TK_Status | PutData (BStreamFileToolkit &tk, unsigned char const *b, int n) |
static TK_Status | PutData (BStreamFileToolkit &tk, unsigned short const *s, int n) |
static TK_Status | PutData (BStreamFileToolkit &tk, unsigned int const *i, int n) |
static TK_Status | PutData (BStreamFileToolkit &tk, char const &c) |
static TK_Status | PutData (BStreamFileToolkit &tk, short const &s) |
static TK_Status | PutData (BStreamFileToolkit &tk, int const &i) |
static TK_Status | PutData (BStreamFileToolkit &tk, unsigned char const &b) |
static TK_Status | PutData (BStreamFileToolkit &tk, unsigned short const &s) |
static TK_Status | PutData (BStreamFileToolkit &tk, unsigned int const &i) |
static TK_Status | PutData (BStreamFileToolkit &tk, float const &f) |
static TK_Status | PutData (BStreamFileToolkit &tk, double const &d) |
static float | read_float (char const *cp, char const **newcpp=0) |
static float | read_float (char const *cp, char **newcpp) |
for internal use only | |
static char * | write_float (char *buffer, double f) |
for internal use only | |
Detailed Description
Handles the TKE_Comment opcode.
TK_Comment provides support for writing/reading the TK_Comment opcode object to/from an HSF file. Take care when overloading this one, since the first comment in the file contains important information about the file (such file version and the flags that were used at the time of file write).
The TKE_Comment opcode object contains a comment for the file.
Constructor & Destructor Documentation
◆ TK_Comment()
TK_Comment::TK_Comment | ( | char const * | comment = 0 | ) |
constructor
Member Function Documentation
◆ Execute()
|
virtual |
Processes the binary data that has been read for the current object, which involves passing the data to application-specific data structures.
- Parameters
-
tk A reference to the BStreamFileToolkit object.
- Returns
- The result of the function call.
Reimplemented from BBaseOpcodeHandler.
◆ GetComment() [1/2]
|
inline |
Get the comment string. Returns a pointer to the current comment
◆ GetComment() [2/2]
|
inline |
Get the comment string buffer. Returns a pointer to the current comment buffer, which may then be modified directly
◆ Interpret() [1/2]
|
inlinevirtual |
The only real reason we need an Interpret function here is so that we can register this class as a PreWalk or PostWalk handler
Reimplemented from BBaseOpcodeHandler.
References TK_Normal.
◆ Interpret() [2/2]
|
inlinevirtual |
Extracts graphics data (typically from the application's scene-graph) and maps it to the opcode handler's data members in preparation for writing out an object to the file.
- Parameters
-
tk A reference to the BStreamFileToolkit object. key An identifier to the object (for example, the HOOPS key of a geometry item) special A string value of particular data
- Returns
- The result of the function call.
Reimplemented from BBaseOpcodeHandler.
References BBaseOpcodeHandler::Interpret().
◆ Read()
|
virtual |
Reads data from the toolkit buffer, decodes/decompresses it, and maps it to the opcode handlers data members. User-defined classes which need to write out custom data should utilize one of the available GetData() methods.
- Parameters
-
tk A reference to the BStreamFileToolkit object.
- Returns
- The result of the function call.
Implements BBaseOpcodeHandler.
◆ Reset()
|
virtual |
Resets the current opcode handler. This is called by the toolkit when it is done processing an opcode. This method reinitializes any opcode handler variables and frees up temporary data.
Reimplemented from BBaseOpcodeHandler.
◆ SetComment() [1/2]
|
inline |
Set the comment string. Makes sure the buffer is big enough to hold the string, and copies it in
◆ SetComment() [2/2]
|
inline |
Set the comment. Makes sure the buffer is big enough to hold a string of 'length' characters
◆ Write()
|
virtual |
Encodes/compresses data and writes data to the toolkit buffer. User-defined classes which need to write out custom data should utilize one of the available PutData() methods, and first write out the opcode associated with the group of binary data followed by the data itself.
- Parameters
-
tk A reference to the BStreamFileToolkit object.
- Returns
- The result of the function call.
Implements BBaseOpcodeHandler.
The documentation for this class was generated from the following file: