BALL  1.5.0
List of all members

#include <BALL/STRUCTURE/SASEdge.h>

Inheritance diagram for BALL::SASEdge:
BALL::GraphEdge< SASVertex, SASEdge, SASFace >

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)
 
SASEdgeoperator= (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< doublegetCircle () const
 
void setAngle (const TAngle< double > &angle)
 
TAngle< doublegetAngle () 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)
 
SASVertexgetVertex (Position i) const
 
void setFace (Position i, SASFace *face)
 
SASFacegetFace (Position i) const
 
void setIndex (Index index)
 
Index getIndex () const
 
SASVertexother (const SASVertex *vertex) const
 
SASFaceother (const SASFace *face) const
 
bool substitute (const SASVertex *old_vertex, SASVertex *new_vertex)
 
bool substitute (const SASFace *old_vertex, SASFace *new_vertex)
 
SASFaceremove (const SASFace *face)
 
void revert ()
 
virtual bool operator== (const SASEdge &) const
 
virtual bool operator!= (const SASEdge &) const
 
virtual bool operator*= (const SASEdge &) const
 

Friends

Class friends
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>;

Predicates

TCircle3< doublecircle_
 
TAngle< doubleangle_
 
virtual bool operator== (const SASEdge &) const
 
virtual bool operator!= (const SASEdge &) const
 
virtual bool operator*= (const SASEdge &) const
 
bool isFree () const
 

Additional Inherited Members

- Protected Attributes inherited from BALL::GraphEdge< SASVertex, SASEdge, SASFace >
SASVertexvertex_ [2]
 
SASFaceface_ [2]
 
Index index_
 

Detailed Description

Generic SASEdge Class.


Definition at line 33 of file SASEdge.h.

Constructor & Destructor Documentation

◆ SASEdge() [1/3]

BALL::SASEdge::SASEdge ( )

Default constructor. This method creates a new SASEdge object.

◆ SASEdge() [2/3]

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

Copy constructor. Create a new SASEdge object from another.

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

◆ SASEdge() [3/3]

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
vertex0assigned to the first vertex
vertex1assigned to the second vertex
face0assigned to the first face
face1assigned to the second face
circleassigned to the circle
angleassigned to the angle
indexassigned to the index

◆ ~SASEdge()

virtual BALL::SASEdge::~SASEdge ( )
virtual

Destructor. Destructs the SASEdge object.

Member Function Documentation

◆ getAngle()

TAngle<double> BALL::SASEdge::getAngle ( ) const

Return the angle of the SASEdge.

Returns
TAngle<double> the angle of the SASEdge

◆ getCircle()

TCircle3<double> BALL::SASEdge::getCircle ( ) const

Return the circle on which the SASEdge lies.

Returns
TCircle3<double> the circle of the SASEdge

◆ isFree()

bool BALL::SASEdge::isFree ( ) const

isFree.

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

◆ operator!=()

virtual bool BALL::SASEdge::operator!= ( const SASEdge ) const
virtual

Inequality operator.

Returns
bool false

◆ operator*=()

virtual bool BALL::SASEdge::operator*= ( const SASEdge ) const
virtual

Similarity operator.

Returns
bool true

◆ operator=()

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
sasedgethe SASEdge object to assign from

◆ operator==()

virtual bool BALL::SASEdge::operator== ( const SASEdge ) const
virtual

Equality operator.

Returns
bool true

◆ set() [1/2]

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

Assign from another SASEdge object.

Parameters
sasedgethe SASEdge object to assign from
deepif 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.

◆ set() [2/2]

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
vertex0assigned to the first vertex
vertex1assigned to the second vertex
face0assigned to the first face
face1assigned to the second face
circleassigned to the circle
angleassigned to the angle
indexassigned to the index

◆ setAngle()

void BALL::SASEdge::setAngle ( const TAngle< double > &  angle)

Set the angle of the SASEdge.

Parameters
anglethe new angle

◆ setCircle()

void BALL::SASEdge::setCircle ( const TCircle3< double > &  center)

Set the circle on which the SASEdge lies.

Parameters
centerthe new circle

Friends And Related Function Documentation

◆ SASFace

friend class SASFace
friend

Definition at line 47 of file SASEdge.h.

◆ SASTriangulator

friend class SASTriangulator
friend

Definition at line 50 of file SASEdge.h.

◆ SASVertex

friend class SASVertex
friend

Definition at line 46 of file SASEdge.h.

◆ SolventAccessibleSurface

friend class SolventAccessibleSurface
friend

Definition at line 48 of file SASEdge.h.

◆ TriangulatedSAS

friend class TriangulatedSAS
friend

Definition at line 49 of file SASEdge.h.

Member Data Documentation

◆ angle_

TAngle<double> BALL::SASEdge::angle_
protected

Definition at line 211 of file SASEdge.h.

◆ circle_

TCircle3<double> BALL::SASEdge::circle_
protected

Definition at line 208 of file SASEdge.h.