Main Page | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Class Members | File Members

TK_Referenced_Segment Class Reference

#include <BOpcodeHandler.h>

Inheritance diagram for TK_Referenced_Segment:

Inheritance graph
[legend]
Collaboration diagram for TK_Referenced_Segment:

Collaboration graph
[legend]
List of all members.

Detailed Description

Handles the TKE_Inlude_Segment and TKE_Style_Segment opcodes.

TK_Referenced_Segment provides support for writing/reading the TKE_Inlude_Segment and TKE_Style_Segment opcode objects to/from an HSF file.

The HOOPS/3dGS scene-graph nodes are called 'segments' which store, geometry, attributes, and subsegments. The scene-graph provides support for referencing segments where they can either be 'included' as virtual subsegments, or they can be 'styled' so that only the attributes are referenced.

Definition at line 1031 of file BOpcodeHandler.h.

Public Member Functions

 TK_Referenced_Segment (unsigned char opcode)
TK_Status Read (BStreamFileToolkit &tk) alter
TK_Status Write (BStreamFileToolkit &tk) alter
void Reset (void) alter
void SetSegment (char const *segment) alter
void SetSegment (int length) alter
char const * GetSegment (void) const
char alter * GetSegment (void) alter
void SetFollow (bool f) alter
bool GetFollow (void) alter

Protected Member Functions

void set_segment (char const *segment) alter
 for internal use only
void set_segment (int length) alter
 for internal use only

Protected Attributes

int m_length
int m_allocated
char * m_string
ID_Key m_key
 for internal use only
BBaseOpcodeHandlerm_referee
 for internal use only
bool m_follow
 for internal use only


Constructor & Destructor Documentation

TK_Referenced_Segment::TK_Referenced_Segment unsigned char  opcode  ) 
 

constructor


Member Function Documentation

bool TK_Referenced_Segment::GetFollow void   )  [inline]
 

Returns the flag indicating whether the reference segment should be processed itself

Definition at line 1080 of file BOpcodeHandler.h.

char alter* TK_Referenced_Segment::GetSegment void   )  [inline]
 

Get the segment name buffer. Returns a pointer to the current segment name buffer which may then be modified directly

Definition at line 1075 of file BOpcodeHandler.h.

char const* TK_Referenced_Segment::GetSegment void   )  const [inline]
 

Get the segment name. Returns a pointer to the current segment name

Definition at line 1070 of file BOpcodeHandler.h.

TK_Status TK_Referenced_Segment::Read BStreamFileToolkit tk  )  [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.

void TK_Referenced_Segment::Reset void   )  [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.

void TK_Referenced_Segment::SetFollow bool  f  )  [inline]
 

Sets the flag indicating whether the reference segment should be processed itself

Definition at line 1078 of file BOpcodeHandler.h.

void TK_Referenced_Segment::SetSegment int  length  )  [inline]
 

Set the segment name. Makes sure the buffer is big enough to hold a string of 'length' characters

Definition at line 1066 of file BOpcodeHandler.h.

void TK_Referenced_Segment::SetSegment char const *  segment  )  [inline]
 

Set the segment name. Makes sure the buffer is big enough to hold the segment name, and copies it in

Definition at line 1061 of file BOpcodeHandler.h.

TK_Status TK_Referenced_Segment::Write BStreamFileToolkit tk  )  [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.


Member Data Documentation

int TK_Referenced_Segment::m_allocated [protected]
 

Size of currently available string buffer. for internal use only

Definition at line 1038 of file BOpcodeHandler.h.

int TK_Referenced_Segment::m_length [protected]
 

Length of segment string name. for internal use only

Definition at line 1037 of file BOpcodeHandler.h.

char* TK_Referenced_Segment::m_string [protected]
 

Segment name. for internal use only

Definition at line 1039 of file BOpcodeHandler.h.


The documentation for this class was generated from the following file:
Generated on Tue May 17 12:06:13 2005 for Autodesk DWF 3D Toolkit by  doxygen 1.4.1