TK_Ellipse Class Reference

#include <BOpcodeHandler.h>

Inheritance diagram for TK_Ellipse:

Inheritance graph
[legend]
Collaboration diagram for TK_Ellipse:

Collaboration graph
[legend]
List of all members.

Detailed Description

Handles the TKE_Ellipse and TKE_Elliptical_Arc opcodes.

TK_Ellipse provides support for writing/reading the TKE_Ellipse and TKE_Elliptical_Arc opcode objects to/from an HSF file.

The HOOPS/3dGS scene-graph can contain 'ellipse' and 'elliptical arc' primitives which are defined by center, major and minor points, as well as two parameterization values in the case of an elliptical arc.

Definition at line 6226 of file BOpcodeHandler.h.

Public Member Functions

 TK_Ellipse (unsigned char opcode)
TK_Status Read (BStreamFileToolkit &tk) alter
TK_Status Write (BStreamFileToolkit &tk) alter
TK_Status Clone (BStreamFileToolkit &tk, BBaseOpcodeHandler **handler) const
void SetCenter (float x, float y, float z) alter
void SetCenter (float const *s) alter
float const * GetCenter (void) const
void SetMajor (float x, float y, float z) alter
void SetMajor (float const *m) alter
float const * GetMajor (void) const
void SetMinor (float x, float y, float z) alter
void SetMinor (float const *m) alter
float const * GetMinor (void) const
void SetLimits (float s, float e) alter
float const * GetLimits (void) const

Protected Attributes

float m_center [3]
float m_major [3]
float m_minor [3]
float m_limits [2]


Constructor & Destructor Documentation

TK_Ellipse::TK_Ellipse unsigned char  opcode  )  [inline]
 

constructor

Definition at line 6239 of file BOpcodeHandler.h.


Member Function Documentation

TK_Status TK_Ellipse::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_Ellipse::GetCenter void   )  const [inline]
 

Returns the center of the arc as the address of a float triplet

Definition at line 6256 of file BOpcodeHandler.h.

float const* TK_Ellipse::GetLimits void   )  const [inline]
 

Returns the parametric limits of the arc as the address of a float pair

Definition at line 6281 of file BOpcodeHandler.h.

float const* TK_Ellipse::GetMajor void   )  const [inline]
 

Returns the major axis of the arc as the address of a float triplet

Definition at line 6265 of file BOpcodeHandler.h.

float const* TK_Ellipse::GetMinor void   )  const [inline]
 

Returns the minor axis of the arc as the address of a float triplet

Definition at line 6274 of file BOpcodeHandler.h.

TK_Status TK_Ellipse::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_Ellipse::SetCenter float const *  s  )  [inline]
 

Sets the center of the arc using a float triplet

Definition at line 6254 of file BOpcodeHandler.h.

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

Sets the center of the arc using discrete float values

Definition at line 6250 of file BOpcodeHandler.h.

void TK_Ellipse::SetLimits float  s,
float  e
[inline]
 

Sets the parametric limits of the arc using discrete values

Definition at line 6277 of file BOpcodeHandler.h.

void TK_Ellipse::SetMajor float const *  m  )  [inline]
 

Sets the major axis of the arc using a float triplet

Definition at line 6263 of file BOpcodeHandler.h.

void TK_Ellipse::SetMajor float  x,
float  y,
float  z
[inline]
 

Sets the major axis of the arc using discrete float values

Definition at line 6259 of file BOpcodeHandler.h.

void TK_Ellipse::SetMinor float const *  m  )  [inline]
 

Sets the minor axis of the arc using a float triplet

Definition at line 6272 of file BOpcodeHandler.h.

void TK_Ellipse::SetMinor float  x,
float  y,
float  z
[inline]
 

Sets the minor axis of the arc using discrete float values

Definition at line 6268 of file BOpcodeHandler.h.

TK_Status TK_Ellipse::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_Ellipse::m_center[3] [protected]
 

internal use; center point

Definition at line 6232 of file BOpcodeHandler.h.

float TK_Ellipse::m_limits[2] [protected]
 

internal use; Parameterization values

Definition at line 6235 of file BOpcodeHandler.h.

float TK_Ellipse::m_major[3] [protected]
 

internal use; Major axis

Definition at line 6233 of file BOpcodeHandler.h.

float TK_Ellipse::m_minor[3] [protected]
 

internal use; Minor axis

Definition at line 6234 of file BOpcodeHandler.h.


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