BALL::SASEdge Class Reference
[Molecular Surface Computation]

Generic SASEdge Class. More...

#include <SASEdge.h>

Inheritance diagram for BALL::SASEdge:

[legend]

List of all members.

Public Member Functions
Constructors and Destructors
	SASEdge ()
	Default constructor.
	SASEdge (const SASEdge &sasedge, bool deep=false)
	Copy constructor.
	SASEdge (SASVertex *vertex0, SASVertex *vertex1, SASFace *face0, SASFace *face1, const TCircle3< double > &circle, const TAngle< double > &angle, Index index)
	Detailled constructor.
virtual	~SASEdge ()
	Destructor.
Assignment
void	set (const SASEdge &sasedge, bool deep=false)
	Assign from another SASEdge object.
SASEdge &	operator= (const SASEdge &sasedge)
	Assign from another SASEdge object.
void	set (SASVertex *vertex0, SASVertex *vertex1, SASFace *face0, SASFace *face1, const TCircle3< double > &circle, const TAngle< double > &angle, Index index)
	Assign from some nice objects.
Accessors
void	setCircle (const TCircle3< double > &center)
	Set the circle on which the SASEdge lies.
TCircle3< double >	getCircle () const
	Return the circle on which the SASEdge lies.
void	setAngle (const TAngle< double > &angle)
	Set the angle of the SASEdge.
TAngle< double >	getAngle () const
	Return the angle of the SASEdge.
Predicates
virtual bool	operator== (const SASEdge &) const
	Equality operator.
virtual bool	operator!= (const SASEdge &) const
	Inequality operator.
virtual bool	operator*= (const SASEdge &) const
	Similarity operator.
bool	isFree () const
	isFree.
Protected Attributes
TCircle3< double >	circle_
TAngle< double >	angle_
Friends
Class friends
class SASFace class SASVertex class SolventAccessibleSurface class TriangulatedSAS class SASTriangulator
class	SASVertex
class	SASFace
class	SolventAccessibleSurface
class	TriangulatedSAS
class	SASTriangulator

---

Detailed Description

Generic SASEdge Class.

---

Constructor & Destructor Documentation

BALL::SASEdge::SASEdge

(

)

Default constructor.

This method creates a new SASEdge object.

BALL::SASEdge::SASEdge	(	const SASEdge &	sasedge,
		bool	deep = false
	)

Copy constructor.

Create a new SASEdge object from another.

Parameters:

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

BALL::SASEdge::SASEdge	(	SASVertex *	vertex0,
		SASVertex *	vertex1,
		SASFace *	face0,
		SASFace *	face1,
		const TCircle3< double > &	circle,
		const TAngle< double > &	angle,
		Index	index
	)

Detailled constructor.

Create a new SASEdge object from some nice objects.

Parameters:

	vertex0	assigned to the first vertex
	vertex1	assigned to the second vertex
	face0	assigned to the first face
	face1	assigned to the second face
	circle	assigned to the circle
	angle	assigned to the angle
	index	assigned to the index

virtual BALL::SASEdge::~SASEdge

(

)

[virtual]

Destructor.

Destructs the SASEdge object.

---

Member Function Documentation

TAngle<double> BALL::SASEdge::getAngle

(

)

const

Return the angle of the SASEdge.

Returns:

TAngle<double> the angle of the SASEdge

TCircle3<double> BALL::SASEdge::getCircle

(

)

const

Return the circle on which the SASEdge lies.

Returns:

TCircle3<double> the circle of the SASEdge

bool BALL::SASEdge::isFree

(

)

const

isFree.

Returns:

bool true if the RSEdge of the SASEdge is free, false otherwise

virtual bool BALL::SASEdge::operator!=

(

const SASEdge &

)

const [virtual]

Inequality operator.

Returns:

bool false

Reimplemented from BALL::GraphEdge< SASVertex, SASEdge, SASFace >.

virtual bool BALL::SASEdge::operator*=

(

const SASEdge &

)

const [virtual]

Similarity operator.

Returns:

bool true

Reimplemented from BALL::GraphEdge< SASVertex, SASEdge, SASFace >.

SASEdge& BALL::SASEdge::operator=

(

const SASEdge &

sasedge

)

Assign from another SASEdge object.

The SASEdge object is linked to the neighbours of the SASEdge object to assign from.

Parameters:

sasedge

the SASEdge object to assign from

virtual bool BALL::SASEdge::operator==

(

const SASEdge &

)

const [virtual]

Equality operator.

Returns:

bool true

Reimplemented from BALL::GraphEdge< SASVertex, SASEdge, SASFace >.

void BALL::SASEdge::set	(	SASVertex *	vertex0,
		SASVertex *	vertex1,
		SASFace *	face0,
		SASFace *	face1,
		const TCircle3< double > &	circle,
		const TAngle< double > &	angle,
		Index	index
	)

Assign from some nice objects.

Parameters:

	vertex0	assigned to the first vertex
	vertex1	assigned to the second vertex
	face0	assigned to the first face
	face1	assigned to the second face
	circle	assigned to the circle
	angle	assigned to the angle
	index	assigned to the index

void BALL::SASEdge::set	(	const SASEdge &	sasedge,
		bool	deep = false
	)

Assign from another SASEdge object.

Parameters:

	sasedge	the SASEdge object to assign from
	deep	if deep = false, all pointers are set to NULL (default). Otherwise the SASEdge object is linked to the neighbours of the SASEdge object to assign from.

void BALL::SASEdge::setAngle

(

const TAngle< double > &

angle

)

Set the angle of the SASEdge.

Parameters:

angle

the new angle

void BALL::SASEdge::setCircle

(

const TCircle3< double > &

center

)

Set the circle on which the SASEdge lies.

Parameters:

center

the new circle