SASFace.h

Go to the documentation of this file.

// -*- Mode: C++; tab-width: 2; -*-
// vi: set ts=2:
//
 
#ifndef BALL_STRUCTURE_SASFACE_H
#define BALL_STRUCTURE_SASFACE_H
 
#ifndef BALL_STRUCTURE_GRAPHFACE_H
# include <BALL/STRUCTURE/graphFace.h>
#endif
 
#ifndef BALL_STRUCTURE_SPHERE3_H
# include <BALL/MATHS/sphere3.h>
#endif
 
#include <list>
 
namespace BALL
{
 
  class SolventAccessibleSurface;
  class SASEdge;
  class SASVertex;
  class TriangulatedSAS;
  class SASTriangulator;

  class BALL_EXPORT SASFace : public GraphFace< SASVertex,SASEdge,SASFace >
  {
    public:

    friend class SASEdge;
    friend class SASVertex;
    friend class SolventAccessibleSurface;
    friend class TriangulatedSAS;
    friend class SASTriangulator;
 
    BALL_CREATE(SASFace)
 
    
 
    typedef std::list<bool>::iterator OrientationIterator;
    typedef std::list<bool>::const_iterator ConstOrientationIterator;



    SASFace()
      ;

    SASFace(const SASFace& sasface, bool deep = false)
      ;

    virtual ~SASFace()
      ;



    void set(const SASFace& sasface, bool deep = false)
      ;

    SASFace& operator = (const SASFace& sasface)
      ;



    void setSphere(const TSphere3<double>& sphere)
      ;

    TSphere3<double> getSphere() const
      ;



    virtual bool operator == (const SASFace&) const
      ;

    virtual bool operator != (const SASFace&) const
      ;

    virtual bool operator *= (const SASFace&) const
      ;


 
    OrientationIterator beginOrientation()
      ;
    ConstOrientationIterator beginOrientation() const
      ;
    OrientationIterator endOrientation()
      ;
    ConstOrientationIterator endOrientation() const
      ;

 
    protected:

 
    /*_ A list of booleans to indicate the orientation of each sasedge.
    */
    std::list<bool> orientation_;
    /*_ The sphere on which the face lies.
    */
    TSphere3<double> sphere_;

  };


  BALL_EXPORT std::ostream& operator << (std::ostream& s, const SASFace& sasface);

 
} // namespace BALL
 
#endif // BALL_STRUCTURE_SASFACE_H