TK_Clip_Region
-
class
TK_Clip_Region Handles the TKE_Clip_Region opcodes.
TK_Clip_Regionprovides support for writing/reading the TKE_Clip_Region opcode to/from an HSF file. A clip region defines a clip region which should be applied to the contents of the current segment and all subsegments (just like any HOOPS/3dGS attribute)Inherits from:
BBaseOpcodeHandler
Methods
-
TK_Clip_Region::TK_Clip_Region() constructor
-
TK_Clip_Region::~TK_Clip_Region()
-
TK_Status
TK_Clip_Region::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_Clip_Region::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_Clip_Region::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_Clip_Region::ReadAscii(BStreamFileToolkit &tk) Deprecated.
-
TK_Status
TK_Clip_Region::WriteAscii(BStreamFileToolkit &tk) Deprecated.
-
void
TK_Clip_Region::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_Clip_Region::SetPoints(int count, float const points[] = 0) Sets the point array. Allocates a buffer which will hold ‘count’ float triplets, and if specified, copies the ‘points’ into the buffer
-
float const *
TK_Clip_Region::GetPoints() const const
Returns the address of the point buffer
-
float *
TK_Clip_Region::GetPoints() Returns the address of the point buffer, which may be modified directly
-
void
TK_Clip_Region::SetDPoints(int count, double const points[] = 0) Sets the point array. Allocates a buffer which will hold ‘count’ double triplets, and if specified, copies the ‘points’ into the buffer
-
double const *
TK_Clip_Region::GetDPoints() const const
Returns the address of the point buffer
-
double *
TK_Clip_Region::GetDPoints() Returns the address of the point buffer, which may be modified directly
-
int
TK_Clip_Region::GetCount() const const
Returns the number of points in the buffer
-
void
TK_Clip_Region::SetOptions(int o) Sets the option flags
-
int
TK_Clip_Region::GetOptions() const const
Returns the option flags
Variables
-
char
TK_Clip_Region::m_options protected
charinternal use; type of region and optional settings
-
int
TK_Clip_Region::m_count protected
intinternal use; Number of 3D points that define this clip region object
-
float *
TK_Clip_Region::m_points protected
floatinternal use; Array of floats which denote the point coordinates.
-
double *
TK_Clip_Region::m_dpoints protected
doubleinternal use; Array of floats which denote the point coordinates.
-
BBaseOpcodeHandler *
TK_Clip_Region::m_complex protected
internal use; handler for non-polygonal cases.