SASEdge.h

Go to the documentation of this file.

// -*- Mode: C++; tab-width: 2; -*-
// vi: set ts=2:
//

#ifndef BALL_STRUCTURE_SASEDGE_H
#define BALL_STRUCTURE_SASEDGE_H

#ifndef BALL_STRUCTURE_GRAPHEDGE_H
# include <BALL/STRUCTURE/graphEdge.h>
#endif

#ifndef BALL_MATHS_ANGLE_H
# include <BALL/MATHS/angle.h>
#endif

#ifndef BALL_MATHS_CIRCLE3_H
# include <BALL/MATHS/circle3.h>
#endif

namespace BALL
{

  class SolventAccessibleSurface;
  class SASFace;
  class SASVertex;
  class RSEdge;
  class TriangulatedSAS;
  class SASTriangulator;

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

    friend class SASVertex;
    friend class SASFace;
    friend class SolventAccessibleSurface;
    friend class TriangulatedSAS;
    friend class SASTriangulator;

    BALL_CREATE(SASEdge)

    

    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()
      ;



    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)
      ;



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

    TCircle3<double> getCircle() const
      ;

    void setAngle(const TAngle<double>& angle)
      ;

    TAngle<double> getAngle() const
      ;



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

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

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

    bool isFree() const
      ;

    
    protected:
    
    /*_ @name Attributes
    */

    /*_ The circle on which the SASEdge lies.
    */
    TCircle3<double> circle_;
    /*_ The angle of the SASEdge.
    */
    TAngle<double> angle_;

  };


  BALL_EXPORT std::ostream& operator << (std::ostream& s, const SASEdge& sasedge);



} // namespace BALL

#endif // BALL_STRUCTURE_SASEDGE_H