BALL::TriangleEdge Class Reference
[Molecular Surface Computation]

Generic TriangleEdge Class. More...

#include <triangleEdge.h>

Inheritance diagram for BALL::TriangleEdge:

[legend]

List of all members.

Public Member Functions
Constructors and Destructors
	TriangleEdge ()
	Default constructor.
	TriangleEdge (TrianglePoint *v1, TrianglePoint *v2)
	Detailed constructor.
	TriangleEdge (const TriangleEdge &edge, bool deep=false)
	Copy constructor.
virtual	~TriangleEdge ()
	Destructor.
Accessors
void	setPoint (Position i, TrianglePoint *point)
	Set one of the two points of the TriangleEdge.
TrianglePoint *	getPoint (Position i) const
	Return one of the two points of the TriangleEdge.
void	setTriangle (Position i, Triangle *triangle)
	Set one of the two triangles of the TriangleEdge.
Triangle *	getTriangle (Position i) const
	Return one of the two triangles of the TriangleEdge.
Predicates
virtual bool	operator== (const TriangleEdge &) const
	Equality operator.
virtual bool	operator!= (const TriangleEdge &) const
	Inequality operator.
virtual bool	operator*= (const TriangleEdge &) const
	Similarity operator.
Friends
Class friends
class Triangle class TriangleEdge class TriangulatedSurface class TriangulatedSphere class TriangulatedSES class TriangulatedSAS class SESTriangulator class SASTriangulator
class	Triangle
class	TrianglePoint
class	TriangulatedSurface
class	TriangulatedSphere
class	TriangulatedSES
class	TriangulatedSAS
class	SESTriangulator
class	SASTriangulator

---

Detailed Description

Generic TriangleEdge Class.

---

Constructor & Destructor Documentation

BALL::TriangleEdge::TriangleEdge

(

)

Default constructor.

This method creates a new TriangleEdge object.

BALL::TriangleEdge::TriangleEdge	(	TrianglePoint *	v1,
		TrianglePoint *	v2
	)

Detailed constructor.

Creates a new TriangleEdge object connecting the passed TrianglePoint instances.

BALL::TriangleEdge::TriangleEdge	(	const TriangleEdge &	edge,
		bool	deep = false
	)

Copy constructor.

Create a new TriangleEdge object from another.

Parameters:

	edge	the TriangleEdge object to be copied
	deep	if deep = false, all pointers are set to NULL (default). Otherwise the new TriangleEdge object is linked to the neighbours of the old TriangleEdge object.

virtual BALL::TriangleEdge::~TriangleEdge

(

)

[virtual]

Destructor.

Destructs the TriangleEdge object.

---

Member Function Documentation

TrianglePoint* BALL::TriangleEdge::getPoint

(

Position

i

)

const

Return one of the two points of the TriangleEdge.

Parameters:

i

Returns:

TrianglePoint* a pointer to the first point if i = 0, a pointer to the second point otherwise

Triangle* BALL::TriangleEdge::getTriangle

(

Position

i

)

const

Return one of the two triangles of the TriangleEdge.

Parameters:

i

Returns:

Triangle* a pointer to the first triangle if i = 0, a pointer to the second triangle otherwise

virtual bool BALL::TriangleEdge::operator!=

(

const TriangleEdge &

)

const [virtual]

Inequality operator.

Returns:

bool false if the vertices are similar, true otherwise.

Reimplemented from BALL::GraphEdge< TrianglePoint, TriangleEdge, Triangle >.

virtual bool BALL::TriangleEdge::operator*=

(

const TriangleEdge &

)

const [virtual]

Similarity operator.

Returns:

bool true

Reimplemented from BALL::GraphEdge< TrianglePoint, TriangleEdge, Triangle >.

virtual bool BALL::TriangleEdge::operator==

(

const TriangleEdge &

)

const [virtual]

Equality operator.

Returns:

bool true if the vertices are similar, false otherwise.

Reimplemented from BALL::GraphEdge< TrianglePoint, TriangleEdge, Triangle >.

void BALL::TriangleEdge::setPoint	(	Position	i,
		TrianglePoint *	point
	)

Set one of the two points of the TriangleEdge.

Parameters:

	i	the first point is changed if i = 0, the second otherwise
	point	a pointer to the new point

void BALL::TriangleEdge::setTriangle	(	Position	i,
		Triangle *	triangle
	)

Set one of the two triangles of the TriangleEdge.

Parameters:

	i	change the first triangle, if i = 0, the second otherwise
	triangle	a pointer to the new triangle