BALL::SASVertex Class Reference
[Molecular Surface Computation]

#include <BALL/STRUCTURE/SASVertex.h>

Inheritance diagram for BALL::SASVertex:

[legend]

List of all members.

Public Member Functions
Constructors and Destructors
	SASVertex ()
	SASVertex (const SASVertex &sasvertex, bool deep=false)
	SASVertex (const TVector3< double > &point, Index index)
virtual	~SASVertex ()
Assignment
void	set (const SASVertex &sasvertex, bool deep=false)
SASVertex &	operator= (const SASVertex &sasvertex)
void	set (const TVector3< double > point, Index index)
void	setPoint (const TVector3< double > &point)
TVector3< double >	getPoint () const
Predicates
virtual bool	operator== (const SASVertex &) const
virtual bool	operator!= (const SASVertex &) const
virtual bool	operator*= (const SASVertex &) const
Protected Attributes
TVector3< double >	point_
Friends
Class friends
- class SASEdge class SASFace class SolventAccessibleSurface class TriangulatedSAS class SASTriangulator
class	SASEdge
class	SASFace
class	SolventAccessibleSurface
class	TriangulatedSAS
class	SASTriangulator

---

Detailed Description

Generic SASVertex Class.

Definition at line 28 of file SASVertex.h.

---

Constructor & Destructor Documentation

BALL::SASVertex::SASVertex

(

)

Default constructor. This method creates a new SASVertex object.

BALL::SASVertex::SASVertex	(	const SASVertex &	sasvertex,
		bool	deep = false
	)

Copy constructor. Create a new SASVertex object from another.

Parameters:

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

BALL::SASVertex::SASVertex	(	const TVector3< double > &	point,
		Index	index
	)

Detailled constructor. Create a new SASVertex object from some nice objects.

Parameters:

	point	assigned to the point representet by the vertex
	index	assigned to the index of the vertex

virtual BALL::SASVertex::~SASVertex

(

)

[virtual]

Destructor. Destructs the RSVertex object.

---

Member Function Documentation

TVector3<double> BALL::SASVertex::getPoint

(

)

const

Return the point represented by the SASVertex.

Returns:

TVector3<double> the point represented by the vertex

virtual bool BALL::SASVertex::operator!=

(

const SASVertex &

)

const [virtual]

Inequality operator.

Returns:

bool false

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

virtual bool BALL::SASVertex::operator*=

(

const SASVertex &

)

const [virtual]

Similarity operator.

Returns:

bool true if the points the SASVertices lie on are equal, false otherwise

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

SASVertex& BALL::SASVertex::operator=

(

const SASVertex &

sasvertex

)

Assign from another SASVertex. The new SASVertex object is linked to the neighbours of the SASVertex object to assign from.

Parameters:

sasvertex

the SASVertex object to assign from

virtual bool BALL::SASVertex::operator==

(

const SASVertex &

)

const [virtual]

Equality operator.

Returns:

bool true

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

void BALL::SASVertex::set	(	const TVector3< double >	point,
		Index	index
	)

Assign to a TVector3<double> and an Index.

Parameters:

	point	assigned to the point represented by the vertex
	index	assigned to the index of the vertex

void BALL::SASVertex::set	(	const SASVertex &	sasvertex,
		bool	deep = false
	)

Assign from another SASVertex.

Parameters:

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

void BALL::SASVertex::setPoint

(

const TVector3< double > &

point

)

Set the point represented by the SASVertex.

Parameters:

point

the new point

---

Friends And Related Function Documentation

friend class SASEdge [friend]

Definition at line 41 of file SASVertex.h.

friend class SASFace [friend]

Definition at line 42 of file SASVertex.h.

friend class SASTriangulator [friend]

Definition at line 45 of file SASVertex.h.

friend class SolventAccessibleSurface [friend]

Definition at line 43 of file SASVertex.h.

friend class TriangulatedSAS [friend]

Definition at line 44 of file SASVertex.h.

---

Member Data Documentation

TVector3<double> BALL::SASVertex::point_ [protected]

Definition at line 161 of file SASVertex.h.