TK_Shape_Definition
-
class
TK_Shape_Definition Handles the TKE_Shape_Definition opcode.
TK_Shape_Definitionprovides support for writing/reading the TKE_Shape_Definition opcode object to/from an HSF file.The HOOPS/3dGS scene-graph supports ‘shape definitions’, which define how to draw text backgrounds.
Inherits from:
BBaseOpcodeHandler
Methods
-
TK_Shape_Definition::TK_Shape_Definition() constructor
-
TK_Shape_Definition::~TK_Shape_Definition()
-
TK_Status
TK_Shape_Definition::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 theBStreamFileToolkitobject.Returns
The result of the function call.
-
TK_Status
TK_Shape_Definition::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 theBStreamFileToolkitobject.Returns
The result of the function call.
-
TK_Status
TK_Shape_Definition::Clone(BStreamFileToolkit &tk, BBaseOpcodeHandler **handler) const const virtual
Copies the opcode handler
Parameters
tk: A reference to the
BStreamFileToolkitobject.handler: A pointer to the opcode handler object. Passed by reference.
Returns
The result of the function call.
-
TK_Status
TK_Shape_Definition::ReadAscii(BStreamFileToolkit &tk) Deprecated.
-
TK_Status
TK_Shape_Definition::WriteAscii(BStreamFileToolkit &tk) Deprecated.
-
void
TK_Shape_Definition::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.
-
void
TK_Shape_Definition::SetName(char const *name) Sets the shape name. Allocates the buffer and copies the name string
-
void
TK_Shape_Definition::SetName(int length) Sets the shape name buffer. Allocates a buffer large enough to hold a string of ‘length’ characters
-
char const *
TK_Shape_Definition::GetName() const const
Returns the shape name
-
char *
TK_Shape_Definition::GetName() Returns the shape name buffer, which can be modified directly
-
void
TK_Shape_Definition::SetDefinition(int size, float const *data = 0) Sets the definition. Allocates the buffer and copies the data if provided
-
int
TK_Shape_Definition::GetDefinitionSize() const const
Returns the definition size
-
float const *
TK_Shape_Definition::GetDefinition() const const
Returns the definition buffer
-
float *
TK_Shape_Definition::GetDefinition() Returns the definition buffer, which can be modified directly
Variables
-
int
TK_Shape_Definition::m_name_length protected
intinternal use; Shape name length
-
int
TK_Shape_Definition::m_size protected
intinternal use; Data length
-
char *
TK_Shape_Definition::m_name protected
charinternal use; Shape name
-
float *
TK_Shape_Definition::m_data protected
floatinternal use; Definition