SESVertex.h

Go to the documentation of this file.

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

#ifndef BALL_STRUCTURE_SESVERTEX_H
#define BALL_STRUCTURE_SESVERTEX_H

#ifndef BALL_STRUCTURE_GRAPHVERTEX_H
# include <BALL/STRUCTURE/graphVertex.h>
#endif

#ifndef BALL_MATHS_VECTOR3_H
# include <BALL/MATHS/vector3.h>
#endif

namespace BALL
{
  class SESEdge;
  class SESFace;
  class SolventExcludedSurface;
  class SESComputer;
  class SESSingularityCleaner;
  class TriangulatedSES;
  class SESTriangulator;

  class BALL_EXPORT SESVertex : public GraphVertex< SESVertex,SESEdge,SESFace >
  {
    public:

    friend class SESEdge;
    friend class SESFace;
    friend class SolventExcludedSurface;
    friend class SESComputer;
    friend class SESSingularityCleaner;
    friend class TriangulatedSES;
    friend class SESTriangulator;

    BALL_CREATE(SESVertex)

    

    SESVertex()
      ;

    SESVertex(const SESVertex& sesvertex, bool deep = false)
      ;

    SESVertex
        (const TVector3<double>&  point,
         const TVector3<double>&  normal,
         Index          atom,
         Index          index)
      ;

    virtual ~SESVertex()
      ;



    void set(const SESVertex& sesvertex, bool deep = false)
      ;

    SESVertex& operator = (const SESVertex& sesvertex)
      ;

    void set(const TVector3<double> point,
        const TVector3<double>& normal,
        Index atom,
        Index index)
      ;

    void setPoint(const TVector3<double>& point)
      ;

    TVector3<double> getPoint() const
      ;

    void setNormal(const TVector3<double>& normal)
      throw(Exception::DivisionByZero);

    TVector3<double> getNormal() const
      ;

    void setAtom(Index atom)
      ;

    Index getAtom() const
      ;



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

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

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


    protected:


    /*_ The coordinates of the vertex.
    */
    TVector3<double> point_;
    /*_ The normal vector of the vertex.
    */
    TVector3<double> normal_;
    /*_ The index of the closest atom.
    */
    Index atom_;

  };


  BALL_EXPORT std::ostream& operator << (std::ostream& s, const SESVertex& sesvertex);


   
} // namespace BALL

#endif // BALL_SES_SESVERTEX_H