TK_Circle Class Reference

#include <BOpcodeHandler.h>

Inheritance diagram for TK_Circle:

Inheritance graph
[legend]
Collaboration diagram for TK_Circle:

Collaboration graph
[legend]
List of all members.

Detailed Description

Handles the TKE_Circle, TKE_Circular_Arc, TKE_Circular_Chord and TKE_Circular_Wedge opcodes.

TK_Circle provides support for writing/reading the TKE_Circle, TKE_Circular_Arc, TKE_Circular_Chord and TKE_Circular_Wedge opcode objects to/from an HSF file.

The HOOPS/3dGS scene-graph can contain various forms of a 'circle' primitive, defined by three non-colinear points.

Definition at line 6142 of file BOpcodeHandler.h.

Public Member Functions

 TK_Circle (unsigned char opcode)
TK_Status Read (BStreamFileToolkit &tk) alter
TK_Status Write (BStreamFileToolkit &tk) alter
TK_Status Clone (BStreamFileToolkit &tk, BBaseOpcodeHandler **handler) const
void Reset (void) alter
void SetStart (float x, float y, float z) alter
void SetStart (float const *s) alter
void SetMiddle (float x, float y, float z) alter
void SetMiddle (float const *m) alter
void SetEnd (float x, float y, float z) alter
void SetEnd (float const *e) alter
void SetCenter (float x, float y, float z) alter
void SetCenter (float const *c) alter
void SetPoints (float const *s, float const *m, float const *e, float const *c=0) alter
float const * GetStart (void) const
float const * GetMiddle (void) const
float const * GetEnd (void) const
float const * GetCenter (void) const

Protected Attributes

float m_start [3]
float m_middle [3]
float m_end [3]
float m_center [3]
unsigned char m_flags


Constructor & Destructor Documentation

TK_Circle::TK_Circle unsigned char  opcode  )  [inline]
 

constructor

Definition at line 6156 of file BOpcodeHandler.h.


Member Function Documentation

TK_Status TK_Circle::Clone BStreamFileToolkit tk,
BBaseOpcodeHandler **  handler
const [virtual]
 

Copies the opcode handler

Parameters:
tk A reference to the BStreamFileToolkit object.
handler A pointer to the opcode handler object. Passed by reference.
Returns:
The result of the function call.

Reimplemented from BBaseOpcodeHandler.

float const* TK_Circle::GetCenter void   )  const [inline]
 

Returns the center point of the arc as the address of a float triplet, null if not present

Definition at line 6214 of file BOpcodeHandler.h.

float const* TK_Circle::GetEnd void   )  const [inline]
 

Returns the end point of the arc as the address of a float triplet

Definition at line 6212 of file BOpcodeHandler.h.

float const* TK_Circle::GetMiddle void   )  const [inline]
 

Returns the intermediate point of the arc as the address of a float triplet

Definition at line 6210 of file BOpcodeHandler.h.

float const* TK_Circle::GetStart void   )  const [inline]
 

Returns the start point of the arc as the address of a float triplet

Definition at line 6208 of file BOpcodeHandler.h.

TK_Status TK_Circle::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_Circle::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_Circle::SetCenter float const *  c  )  [inline]
 

Sets the end point of the arc using a float triplet

Definition at line 6198 of file BOpcodeHandler.h.

void TK_Circle::SetCenter float  x,
float  y,
float  z
[inline]
 

Sets the end point of the arc using discrete float values

Definition at line 6193 of file BOpcodeHandler.h.

void TK_Circle::SetEnd float const *  e  )  [inline]
 

Sets the end point of the arc using a float triplet

Definition at line 6189 of file BOpcodeHandler.h.

void TK_Circle::SetEnd float  x,
float  y,
float  z
[inline]
 

Sets the end point of the arc using discrete float values

Definition at line 6185 of file BOpcodeHandler.h.

void TK_Circle::SetMiddle float const *  m  )  [inline]
 

Sets the intermediate point of the arc using a float triplet

Definition at line 6181 of file BOpcodeHandler.h.

void TK_Circle::SetMiddle float  x,
float  y,
float  z
[inline]
 

Sets the intermediate point of the arc using discrete float values

Definition at line 6177 of file BOpcodeHandler.h.

void TK_Circle::SetPoints float const *  s,
float const *  m,
float const *  e,
float const *  c = 0
[inline]
 

Sets the three points describing the arc using discrete point triplets

Definition at line 6203 of file BOpcodeHandler.h.

void TK_Circle::SetStart float const *  s  )  [inline]
 

Sets the start point of the arc using a float triplet

Definition at line 6173 of file BOpcodeHandler.h.

void TK_Circle::SetStart float  x,
float  y,
float  z
[inline]
 

Sets the start point of the arc using discrete float values

Definition at line 6169 of file BOpcodeHandler.h.

TK_Status TK_Circle::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

float TK_Circle::m_center[3] [protected]
 

internal use; explicit Center point

Definition at line 6151 of file BOpcodeHandler.h.

float TK_Circle::m_end[3] [protected]
 

internal use; End point

Definition at line 6150 of file BOpcodeHandler.h.

unsigned char TK_Circle::m_flags [protected]
 

internal use; flag if Center point is specified

Definition at line 6152 of file BOpcodeHandler.h.

float TK_Circle::m_middle[3] [protected]
 

internal use; Middle point

Definition at line 6149 of file BOpcodeHandler.h.

float TK_Circle::m_start[3] [protected]
 

internal use; Starting point

Definition at line 6148 of file BOpcodeHandler.h.


The documentation for this class was generated from the following file:
Generated on Tue Jan 6 22:41:41 2009 for Autodesk DWF 3D Toolkit by  doxygen 1.4.5