TK_Circle

class TK_Circle

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.

Inherits from: BBaseOpcodeHandler

Methods

TK_Circle::TK_Circle(unsigned char opcode)

constructor

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.
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.
TK_Status TK_Circle::Clone(BStreamFileToolkit &tk, BBaseOpcodeHandler **handler) const

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.
TK_Status TK_Circle::ReadAscii(BStreamFileToolkit &tk)

Deprecated.

TK_Status TK_Circle::WriteAscii(BStreamFileToolkit &tk)

Deprecated.

void TK_Circle::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_Circle::SetStart(float x, float y, float z)

Sets the start point of the arc using discrete float values

void TK_Circle::SetStart(float const s[])

Sets the start point of the arc using a float triplet

void TK_Circle::SetMiddle(float x, float y, float z)

Sets the intermediate point of the arc using discrete float values

void TK_Circle::SetMiddle(float const m[])

Sets the intermediate point of the arc using a float triplet

void TK_Circle::SetEnd(float x, float y, float z)

Sets the end point of the arc using discrete float values

void TK_Circle::SetEnd(float const e[])

Sets the end point of the arc using a float triplet

void TK_Circle::SetCenter(float x, float y, float z)

Sets the end point of the arc using discrete float values

void TK_Circle::SetCenter(float const c[])

Sets the end point of the arc using a float triplet

void TK_Circle::SetPoints(float const s[], float const m[], float const e[], float const c[] = 0)

Sets the three points describing the arc using discrete point triplets

float const *TK_Circle::GetStart() const

const

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

float const *TK_Circle::GetMiddle() const

const

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

float const *TK_Circle::GetEnd() const

const

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

float const *TK_Circle::GetCenter() const

const

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

void TK_Circle::SetDStart(double x, double y, double z)

Sets the start point of the arc using discrete double values

void TK_Circle::SetDStart(double const s[])

Sets the start point of the arc using a double triplet

void TK_Circle::SetDMiddle(double x, double y, double z)

Sets the intermediate point of the arc using discrete double values

void TK_Circle::SetDMiddle(double const m[])

Sets the intermediate point of the arc using a double triplet

void TK_Circle::SetDEnd(double x, double y, double z)

Sets the end point of the arc using discrete double values

void TK_Circle::SetDEnd(double const e[])

Sets the end point of the arc using a double triplet

void TK_Circle::SetDCenter(double x, double y, double z)

Sets the end point of the arc using discrete double values

void TK_Circle::SetDCenter(double const c[])

Sets the end point of the arc using a double triplet

void TK_Circle::SetDPoints(double const s[], double const m[], double const e[], double const c[] = 0)

Sets the three points describing the arc using discrete double point triplets

double const *TK_Circle::GetDStart() const

const

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

double const *TK_Circle::GetDMiddle() const

const

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

double const *TK_Circle::GetDEnd() const

const

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

double const *TK_Circle::GetDCenter() const

const

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

Variables

float TK_Circle::m_points[9]

protected

float

internal use; Starting point

float TK_Circle::m_center[3]

protected

float

internal use; explicit Center point

double TK_Circle::m_dpoints[9]

protected

double

internal use; Starting point

double TK_Circle::m_dcenter[3]

protected

double

internal use; explicit Center point

unsigned char TK_Circle::m_flags

protected

unsigned char

internal use; flag if Center point is specified