TK_Cutting_Plane

class TK_Cutting_Plane

Handles the TKE_Cutting_Plane opcode.

TK_Cutting_Plane provides support for writing/reading the TKE_Cutting_Plane opcode object to/from an HSF file.

The HOOPS/3dGS scene-graph supports ‘cutting planes’ which define a plane that will cut away part of the scene

Inherits from: BBaseOpcodeHandler

Methods

TK_Cutting_Plane::TK_Cutting_Plane()

constructor

TK_Cutting_Plane::~TK_Cutting_Plane()
TK_Status TK_Cutting_Plane::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_Cutting_Plane::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_Cutting_Plane::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_Cutting_Plane::ReadAscii(BStreamFileToolkit &tk)

Deprecated.

TK_Status TK_Cutting_Plane::WriteAscii(BStreamFileToolkit &tk)

Deprecated.

void TK_Cutting_Plane::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_Cutting_Plane::SetPlanes(int count, float const p[] = 0)

Sets the cutting planes and/or allocates space

void TK_Cutting_Plane::SetDPlanes(int count, double const p[] = 0)

Sets the cutting planes and/or allocates space

void TK_Cutting_Plane::SetPlane(float a, float b, float c, float d)

Sets the cutting plane using discrete float values

void TK_Cutting_Plane::SetDPlane(double a, double b, double c, double d)

Sets the cutting plane using discrete float values

void TK_Cutting_Plane::SetPlane(float const p[])

Sets the cutting plane using an array of four floats

void TK_Cutting_Plane::SetDPlane(double const p[])

Sets the cutting plane using an array of four floats

float const *TK_Cutting_Plane::GetPlane() const

const

Returns the cutting plane as the address of an array of four floats

double const *TK_Cutting_Plane::GetDPlane() const

const

Returns the cutting plane as the address of an array of four double

float const *TK_Cutting_Plane::GetPlanes() const

const

Returns the cutting planes as the address of an array of four floats per plane

double const *TK_Cutting_Plane::GetDPlanes() const

const

Returns the cutting planes as the address of an array of four double per plane

int TK_Cutting_Plane::GetCount() const

const

Returns the number of cutting planes

Variables

float *TK_Cutting_Plane::m_planes

protected

float

internal use

double *TK_Cutting_Plane::m_dplanes

protected

double

internal use

int TK_Cutting_Plane::m_count

protected

int

internal use