TK_Circle

Functions

	`TK_Circle`
`TK_Status`	`Read`
`TK_Status`	`Write`
`TK_Status`	`Clone`
`TK_Status`	`ReadAscii`
`TK_Status`	`WriteAscii`
void	`Reset`
void	`SetStart`
void	`SetStart`
void	`SetMiddle`
void	`SetMiddle`
void	`SetEnd`
void	`SetEnd`
void	`SetCenter`
void	`SetCenter`
void	`SetPoints`
float const *	`GetStart`
float const *	`GetMiddle`
float const *	`GetEnd`
float const *	`GetCenter`
void	`SetDStart`
void	`SetDStart`
void	`SetDMiddle`
void	`SetDMiddle`
void	`SetDEnd`
void	`SetDEnd`
void	`SetDCenter`
void	`SetDCenter`
void	`SetDPoints`
double const *	`GetDStart`
double const *	`GetDMiddle`
double const *	`GetDEnd`
double const *	`GetDCenter`

Detailed Description

class TK_Circle : public BBaseOpcodeHandler 

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.

Subclassed by HTK_Circle

Public Functions

inline TK_Circle(unsigned char opcode): constructor

virtual TK_Status Read(BStreamFileToolkit &tk)

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.

virtual TK_Status Write(BStreamFileToolkit &tk)

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.

virtual TK_Status Clone(BStreamFileToolkit &tk, BBaseOpcodeHandler **handler) const

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

TK_Status WriteAscii(BStreamFileToolkit &tk): Deprecated.

virtual void Reset(): 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.

inline void SetStart(float x, float y, float z): Sets the start point of the arc using discrete float values

inline void SetStart(float const s[]): Sets the start point of the arc using a float triplet

inline void SetMiddle(float x, float y, float z): Sets the intermediate point of the arc using discrete float values

inline void SetMiddle(float const m[]): Sets the intermediate point of the arc using a float triplet

inline void SetEnd(float x, float y, float z): Sets the end point of the arc using discrete float values

inline void SetEnd(float const e[]): Sets the end point of the arc using a float triplet

inline void SetCenter(float x, float y, float z): Sets the end point of the arc using discrete float values

inline void SetCenter(float const c[]): Sets the end point of the arc using a float triplet

inline void 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

inline float const *GetStart() const: Returns the start point of the arc as the address of a float triplet

inline float const *GetMiddle() const: Returns the intermediate point of the arc as the address of a float triplet

inline float const *GetEnd() const: Returns the end point of the arc as the address of a float triplet

inline float const *GetCenter() const: Returns the center point of the arc as the address of a float triplet, null if not present

inline void SetDStart(double x, double y, double z): Sets the start point of the arc using discrete double values

inline void SetDStart(double const s[]): Sets the start point of the arc using a double triplet

inline void SetDMiddle(double x, double y, double z): Sets the intermediate point of the arc using discrete double values

inline void SetDMiddle(double const m[]): Sets the intermediate point of the arc using a double triplet

inline void SetDEnd(double x, double y, double z): Sets the end point of the arc using discrete double values

inline void SetDEnd(double const e[]): Sets the end point of the arc using a double triplet

inline void SetDCenter(double x, double y, double z): Sets the end point of the arc using discrete double values

inline void SetDCenter(double const c[]): Sets the end point of the arc using a double triplet

inline void 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

inline double const *GetDStart() const: Returns the start point of the arc as the address of a double triplet

inline double const *GetDMiddle() const: Returns the intermediate point of the arc as the address of a double triplet

inline double const *GetDEnd() const: Returns the end point of the arc as the address of a double triplet

inline double const *GetDCenter() const: Returns the center point of the arc as the address of a double triplet, null if not present