|
void | set_data (int size, unsigned char const *bytes=0) |
| internal use More...
|
|
Protected Member Functions inherited from BBaseOpcodeHandler |
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 |
|
|
Static Protected Member Functions inherited from BBaseOpcodeHandler |
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
|
|
Handles the TKE_Start_User_Data opcode.
The HOOPS Stream File can contain user-data, which is denoted by TKE_Start_User_Data. TK_User_Data will handle the TKE_Start_User_Data opcode by simply reading the data, and not doing anything with it. Therefore, this class must be overloaded in order to both import (and handle), as well as export user-data.
To ensure that user data will be gracefully handled (skipped-over) by non-custom handlers (meaning, an application that is using the default toolkit and doesn't understand the custom user data), custom user data must be written out by exporting the following elements in order:
1. the TKE_Start_User_Data opcode
2. the number of bytes of user data that will follow
3. the user data itself
4. the TKE_Stop_User_Data_Opcode
See the HOOPS/Stream Programming Guide for more detailed information about how to handle user data and create custom files.