#include <BALL/STRUCTURE/SASEdge.h>

Inheritance diagram for BALL::SASEdge:

Public Member Functions
Constructors and Destructors
	SASEdge ()

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

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

virtual	~SASEdge ()

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

SASEdge &	operator= (const SASEdge &sasedge)

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

Accessors
void	setCircle (const TCircle3< double > &center)

TCircle3< double >	getCircle () const

void	setAngle (const TAngle< double > &angle)

TAngle< double >	getAngle () const

Predicates
virtual bool	operator== (const SASEdge &) const

virtual bool	operator!= (const SASEdge &) const

virtual bool	operator*= (const SASEdge &) const

bool	isFree () const

Public Member Functions inherited from BALL::GraphEdge< SASVertex, SASEdge, SASFace >
	GraphEdge ()

	GraphEdge (const GraphEdge< SASVertex, SASEdge, SASFace > &edge, bool deep=false)

	GraphEdge (SASVertex vertex1, SASVertex vertex2, SASFace face1, SASFace face2, Index index)

virtual	~GraphEdge ()

void	set (const GraphEdge< SASVertex, SASEdge, SASFace > &edge, bool deep=false)

void	set (SASVertex vertex0, SASVertex vertex1, SASFace face0, SASFace face1, Index index)

GraphEdge< SASVertex, SASEdge, SASFace > &	operator= (const GraphEdge< SASVertex, SASEdge, SASFace > &edge)

void	setVertex (Position i, SASVertex *vertex)

SASVertex *	getVertex (Position i) const

void	setFace (Position i, SASFace *face)

SASFace *	getFace (Position i) const

void	setIndex (Index index)

Index	getIndex () const

SASVertex *	other (const SASVertex *vertex) const throw (Exception::GeneralException)

SASFace *	other (const SASFace *face) const throw (Exception::GeneralException)

bool	substitute (const SASVertex old_vertex, SASVertex new_vertex)

bool	substitute (const SASFace old_vertex, SASFace new_vertex)

SASFace *	remove (const SASFace *face)

void	revert ()

Protected Attributes

TCircle3< double >	circle_

TAngle< double >	angle_

Protected Attributes inherited from BALL::GraphEdge< SASVertex, SASEdge, SASFace >
SASVertex *	vertex_ [2]

SASFace *	face_ [2]

Index	index_

Friends
Class friends
class SASFace class SASVertex class SolventAccessibleSurface class TriangulatedSAS class SASTriangulator
class	SASVertex

class	SASFace

class	SolventAccessibleSurface

class	TriangulatedSAS

class	SASTriangulator

Class friends
class GraphVertex<Vertex,Edge,Face>; class GraphFace<Vertex,Edge,Face>; class GraphTriangle<Vertex,Edge,Face>;

Detailed Description

Generic SASEdge Class.

Definition at line 33 of file SASEdge.h.

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	(	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::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::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

Friends And Related Function Documentation

friend class SASFace

friend

Definition at line 47 of file SASEdge.h.

friend class SASTriangulator

friend

Definition at line 50 of file SASEdge.h.

friend class SASVertex

friend

Definition at line 46 of file SASEdge.h.

friend class SolventAccessibleSurface

friend

Definition at line 48 of file SASEdge.h.

friend class TriangulatedSAS

friend

Definition at line 49 of file SASEdge.h.

Member Data Documentation

TAngle<double> BALL::SASEdge::angle_

protected

Definition at line 211 of file SASEdge.h.

TCircle3<double> BALL::SASEdge::circle_

protected

Definition at line 208 of file SASEdge.h.

Public Member Functions

Protected Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation