BALL 1.5.0
List of all members
BALL::TriangulatedSAS Class Reference

#include <BALL/STRUCTURE/triangulatedSAS.h>

Inheritance diagram for BALL::TriangulatedSAS:
BALL::TriangulatedSurface

Public Member Functions

Constructors and Destructors
 TriangulatedSAS ()
 
 TriangulatedSAS (const TriangulatedSAS &surface, bool=true)
 
 TriangulatedSAS (SolventAccessibleSurface *sas, const double &density)
 
virtual ~TriangulatedSAS ()
 
Assignment
void set (const TriangulatedSAS &surface, bool=true)
 
TriangulatedSASoperator= (const TriangulatedSAS &surface)
 
- Public Member Functions inherited from BALL::TriangulatedSurface
 TriangulatedSurface ()
 
 TriangulatedSurface (const TriangulatedSurface &surface, bool=true)
 
virtual ~TriangulatedSurface ()
 
void clear ()
 
void set (const TriangulatedSurface &surface, bool=true)
 
TriangulatedSurfaceoperator= (const TriangulatedSurface &surface)
 
void insert (TrianglePoint *point)
 
void insert (TriangleEdge *edge)
 
void insert (Triangle *triangle)
 
Size getNumberOfPoints () const
 
Size getNumberOfEdges () const
 
Size getNumberOfTriangles () const
 
void remove (TrianglePoint *point, bool deep=true)
 
void remove (PointIterator p, bool deep=true)
 
void remove (TriangleEdge *edge, bool deep=true)
 
void remove (EdgeIterator e, bool deep=true)
 
void remove (Triangle *triangle, bool deep=true)
 
void remove (TriangleIterator t, bool deep=true)
 
void exportSurface (Surface &surface)
 
TriangulatedSurfaceoperator+= (const TriangulatedSurface &surface)
 
void join (TriangulatedSurface &source)
 
void shift (const TVector3< double > &c)
 
void blowUp (const double &r)
 
void setIndices ()
 
void setDensity (const double &density)
 
double getDensity () const
 
void cut (const TPlane3< double > &plane, const double &fuzzy=0)
 
void shrink ()
 
void deleteIsolatedEdges ()
 
void deleteIsolatedPoints ()
 
void getBorder (std::list< TriangleEdge * > &border)
 
PointIterator beginPoint ()
 
ConstPointIterator beginPoint () const
 
PointIterator endPoint ()
 
ConstPointIterator endPoint () const
 
EdgeIterator beginEdge ()
 
ConstEdgeIterator beginEdge () const
 
EdgeIterator endEdge ()
 
ConstEdgeIterator endEdge () const
 
TriangleIterator beginTriangle ()
 
ConstTriangleIterator beginTriangle () const
 
TriangleIterator endTriangle ()
 
ConstTriangleIterator endTriangle () const
 

Friends

Class friends
class SASTriangulator
 

Accessors

SolventAccessibleSurfacesas_
 
double density_
 
void setDensity (const double &density)
 
double getDensity () const
 
void compute ()
 

Additional Inherited Members

- Public Types inherited from BALL::TriangulatedSurface
typedef std::list< TrianglePoint * >::iterator PointIterator
 
typedef std::list< TrianglePoint * >::const_iterator ConstPointIterator
 
typedef std::list< TriangleEdge * >::iterator EdgeIterator
 
typedef std::list< TriangleEdge * >::const_iterator ConstEdgeIterator
 
typedef std::list< Triangle * >::iterator TriangleIterator
 
typedef std::list< Triangle * >::const_iterator ConstTriangleIterator
 
- Static Public Member Functions inherited from BALL::TriangulatedSurface
static TriangulatedSurfacecreateTube (unsigned int num_vertices, unsigned int subdiv=0, bool closed=false, bool out=true)
 
static TriangulatedSurfacecreateDisk (unsigned int num_vertices, bool out=true)
 
- Protected Member Functions inherited from BALL::TriangulatedSurface
bool canBeCopied () const
 
void copy (const TriangulatedSurface &surface)
 
- Protected Attributes inherited from BALL::TriangulatedSurface
Size number_of_points_
 
std::list< TrianglePoint * > points_
 
Size number_of_edges_
 
std::list< TriangleEdge * > edges_
 
Size number_of_triangles_
 
std::list< Triangle * > triangles_
 
double density_
 

Detailed Description

Generic TriangulatedSAS Class. <>

Definition at line 62 of file triangulatedSAS.h.

Constructor & Destructor Documentation

◆ TriangulatedSAS() [1/3]

BALL::TriangulatedSAS::TriangulatedSAS ( )

Default constructor. This method creates a new TriangulatedSAS object.

◆ TriangulatedSAS() [2/3]

BALL::TriangulatedSAS::TriangulatedSAS ( const TriangulatedSAS surface,
bool  = true 
)

Copy constructor. Create a new TriangulatedSAS object from another.

Parameters
surfacethe TriangulatedSAS object to be copied
boolignored - just for interface consistency

◆ TriangulatedSAS() [3/3]

BALL::TriangulatedSAS::TriangulatedSAS ( SolventAccessibleSurface sas,
const double density 
)

Detailed constructor. Create a new empty TriangulatedSAS object and set its SAS.

Parameters
sasa pointer to the corresponding SAS
densitythe density to use by triangulation

◆ ~TriangulatedSAS()

virtual BALL::TriangulatedSAS::~TriangulatedSAS ( )
virtual

Destructor. Destructs the TriangulatedSAS object.

Member Function Documentation

◆ compute()

void BALL::TriangulatedSAS::compute ( )

Compute the solvent-accessible surface

◆ getDensity()

double BALL::TriangulatedSAS::getDensity ( ) const

Get the density used by triangulation.

◆ operator=()

TriangulatedSAS & BALL::TriangulatedSAS::operator= ( const TriangulatedSAS surface)

Assign from another TriangulatedSAS.

Parameters
surfacethe TriangulatedSAS object to assign from

◆ set()

void BALL::TriangulatedSAS::set ( const TriangulatedSAS surface,
bool  = true 
)

Assign from another TriangulatedSAS.

Parameters
surfacethe TriangulatedSAS object to assign from
boolignored - just for interface consistency

◆ setDensity()

void BALL::TriangulatedSAS::setDensity ( const double density)

Set the density used by triangulation.

Friends And Related Function Documentation

◆ SASTriangulator

friend class SASTriangulator
friend

Definition at line 72 of file triangulatedSAS.h.

Member Data Documentation

◆ density_

double BALL::TriangulatedSAS::density_
protected

Definition at line 148 of file triangulatedSAS.h.

◆ sas_

SolventAccessibleSurface* BALL::TriangulatedSAS::sas_
protected

Definition at line 146 of file triangulatedSAS.h.