0024961: MeshVS: revision of DRAW commands

[occt.git] / src / BRepMesh / BRepMesh_Edge.hxx

// Copyright (c) 2013 OPEN CASCADE SAS
//
// This file is part of Open CASCADE Technology software library.
//
// This library is free software; you can redistribute it and/or modify it under
// the terms of the GNU Lesser General Public License version 2.1 as published
// by the Free Software Foundation, with special exception defined in the file
// OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
// distribution for complete text of the license and disclaimer of any warranty.
//
// Alternatively, this file may be used under the terms of Open CASCADE
// commercial license or contractual agreement.

#ifndef _BRepMesh_Edge_HeaderFile
#define _BRepMesh_Edge_HeaderFile

#include <Standard.hxx>
#include <Standard_DefineAlloc.hxx>
#include <Standard_Macro.hxx>
#include <BRepMesh_DegreeOfFreedom.hxx>

//! Light weighted structure representing link of the mesh.
class BRepMesh_Edge
{
public:

  DEFINE_STANDARD_ALLOC
  
  //! Default constructor.
  Standard_EXPORT BRepMesh_Edge()
    : myFirstNode (-1),
      myLastNode  (-1),
      myMovability(BRepMesh_Deleted)
  {
  }

  //! Contructs a link beetween two vertices.
  Standard_EXPORT BRepMesh_Edge(const Standard_Integer         theFirstNode,
                                const Standard_Integer         theLastNode,
                                const BRepMesh_DegreeOfFreedom theMovability)
    : myFirstNode (theFirstNode),
      myLastNode  (theLastNode),
      myMovability(theMovability)
  {
  }

  //! Returns index of first node of the Link.
  inline Standard_Integer FirstNode() const
  {
    return myFirstNode;
  }

  //! Returns index of last node of the Link.
  inline Standard_Integer LastNode() const
  {
    return myLastNode;
  }
  
  //! Returns movability flag of the Link.
  inline BRepMesh_DegreeOfFreedom Movability() const
  {
    return myMovability;
  }
  
  //! Sets movability flag of the Link.
  //! \param theMovability flag to be set.
  inline void SetMovability(const BRepMesh_DegreeOfFreedom theMovability)
  {
    myMovability = theMovability;
  }
  
  //! Returns hash code for this edge.
  //! \param theUpper upper index in the container.
  //! \return hash code.
  Standard_EXPORT Standard_Integer HashCode(const Standard_Integer theUpper) const
  {
    return ::HashCode(myFirstNode + myLastNode, theUpper);
  }
  
  //! Checks if the given edge and this one have the same orientation.
  //! \param theOther edge to be checked against this one.
  //! \retrun TRUE if edges have the same orientation, FALSE if not.
  inline Standard_Boolean IsSameOrientation(const BRepMesh_Edge& theOther) const
  {
    return (myFirstNode == theOther.myFirstNode && myLastNode == theOther.myLastNode);
  }
  
  //! Checks for equality with another edge.
  //! \param theOther edge to be checked against this one.
  //! \return TRUE if equal, FALSE if not.
  inline Standard_Boolean IsEqual(const BRepMesh_Edge& theOther) const
  {
    if (myMovability          == BRepMesh_Deleted || 
        theOther.myMovability == BRepMesh_Deleted)
    {
      return Standard_False;
    }

    return IsSameOrientation(theOther) || 
      (myFirstNode == theOther.myLastNode && myLastNode == theOther.myFirstNode);
  }

  //! Alias for IsEqual.
  Standard_Boolean operator ==(const BRepMesh_Edge& Other) const
  {
    return IsEqual(Other);
  }

private:

  Standard_Integer          myFirstNode;
  Standard_Integer          myLastNode;
  BRepMesh_DegreeOfFreedom  myMovability;
};

inline Standard_Integer HashCode(const BRepMesh_Edge&   theEdge,
                                 const Standard_Integer theUpper)
{
  return theEdge.HashCode(theUpper);
}

#endif