// Copyright (C) 2007-2012  CEA/DEN, EDF R&D, OPEN CASCADE
//
// Copyright (C) 2003-2007  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
// CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2.1 of the License.
//
// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
//
// See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
//
//  File    : GEOMAlgo_AlgoTools.hxx
//  Created :
//  Author  : Peter KURNEV

#ifndef _GEOMAlgo_AlgoTools_HeaderFile
#define _GEOMAlgo_AlgoTools_HeaderFile

#include <Standard.hxx>
#include <Standard_Macro.hxx>
#include <Standard_Boolean.hxx>
#include <Handle_BOPInt_Context.hxx>
#include <Standard_Integer.hxx>

#include <gp_Pnt.hxx>
#include <gp_Pnt2d.hxx>

#include <Geom_Surface.hxx>

#include <TopAbs_ShapeEnum.hxx>

#include <TopoDS_Face.hxx>
#include <TopoDS_Shape.hxx>
#include <TopoDS_Edge.hxx>

#include <BOPInt_Context.hxx>

#include <TopTools_ListOfShape.hxx>
#include <TopTools_IndexedDataMapOfShapeListOfShape.hxx>
#include <TopTools_ListOfShape.hxx>
#include <TopTools_IndexedDataMapOfShapeShape.hxx>

#include <GEOMAlgo_IndexedDataMapOfPassKeyShapeListOfShape.hxx>
#include <GEOMAlgo_ListOfCoupleOfShapes.hxx>
#include <GEOMAlgo_IndexedDataMapOfShapeIndexedMapOfShape.hxx>

//!  Auxiliary tools for Algorithms <br>
//=======================================================================
//class    : GEOMAlgo_AlgoTools
//purpose  :
//=======================================================================
class GEOMAlgo_AlgoTools  {
 public:

  Standard_EXPORT
    static void FaceNormal (const TopoDS_Face& aF,
			    const Standard_Real U,
			    const Standard_Real V,
			    gp_Vec& aN);

  //! Computes a point <theP> inside the face <theF>. <br>
  //!          <theP2D> -  2D  representation of <theP> <br>
  //!          on the surface of <theF> <br>
  //!          Returns 0 in case of success. <br>
  Standard_EXPORT
    static  Standard_Integer PntInFace(const TopoDS_Face& theF,
				       gp_Pnt& theP,
				       gp_Pnt2d& theP2D) ;

  Standard_EXPORT
    static  Standard_Boolean IsCompositeShape(const TopoDS_Shape& aS) ;


  Standard_EXPORT
    static  Standard_Boolean BuildTriangulation(const TopoDS_Shape& aS) ;

  Standard_EXPORT
    static  Standard_Integer RefineSDShapes
      (GEOMAlgo_IndexedDataMapOfPassKeyShapeListOfShape& aMSD,
       const Standard_Real aTol,
       const Handle(BOPInt_Context)& aCtx) ;

  Standard_EXPORT
    static  Standard_Integer FindSDShapes(const TopTools_ListOfShape& aLE,
					  const Standard_Real aTol,
					  TopTools_IndexedDataMapOfShapeListOfShape& aMEE,
					  const Handle(BOPInt_Context)& aCtx) ;

  Standard_EXPORT
    static  Standard_Integer FindSDShapes(const TopoDS_Shape& aE1,
					  const TopTools_ListOfShape& aLE,
					  const Standard_Real aTol,
					  TopTools_ListOfShape& aLESD,
					  const Handle(BOPInt_Context)& aCtx) ;

  Standard_EXPORT
    static  void PointOnShape(const TopoDS_Shape& aS,
			      gp_Pnt& aP3D) ;

  Standard_EXPORT
    static  void PointOnEdge(const TopoDS_Edge& aE,
			     gp_Pnt& aP3D) ;

  Standard_EXPORT
    static  void PointOnEdge(const TopoDS_Edge& aE,
			     const Standard_Real aT,gp_Pnt& aP3D) ;

  Standard_EXPORT
    static  void PointOnFace(const TopoDS_Face& aF,
			     gp_Pnt& aP3D) ;

  Standard_EXPORT
    static  void PointOnFace(const TopoDS_Face& aF,
			     const Standard_Real aU,
			     const Standard_Real aV,
			     gp_Pnt& aP3D) ;
  Standard_EXPORT
    static  Standard_Boolean ProjectPointOnShape(const gp_Pnt& aP1,
						 const TopoDS_Shape& aS,
						 gp_Pnt& aP2,
						 const Handle(BOPInt_Context)& aCtx) ;

  Standard_EXPORT
    static void CorrectTolerances(const TopoDS_Shape& aShape,
				  const Standard_Real aMaxTol=0.0001);

  Standard_EXPORT
    static void CorrectPointOnCurve(const TopoDS_Shape& S,
				    const Standard_Real aMaxTol=0.0001);

  Standard_EXPORT
    static void CorrectCurveOnSurface(const TopoDS_Shape& S,
				      const Standard_Real aMaxTol=0.0001);


  Standard_EXPORT
    static Standard_Boolean IsSplitToReverse1 (const TopoDS_Edge& aEF1,
					       const TopoDS_Edge& aEF2,
					       const Handle(BOPInt_Context)& aContext);
  Standard_EXPORT
    static void RefinePCurveForEdgeOnFace(const TopoDS_Edge& aE,
					  const TopoDS_Face& aF,
					  const Standard_Real aUMin,
					  const Standard_Real aUMax);

  Standard_EXPORT
    static Standard_Boolean IsUPeriodic(const Handle(Geom_Surface) &aS);
  
  Standard_EXPORT
    static void MakeContainer(const TopAbs_ShapeEnum theType,
			      TopoDS_Shape& theC);

  Standard_EXPORT
    static Standard_Boolean IsSplitToReverse(const TopoDS_Edge& theSplit,
					     const TopoDS_Edge& theEdge,
					     const Handle(BOPInt_Context)& theContext);
  
  Standard_EXPORT
    static Standard_Boolean IsSplitToReverse  (const TopoDS_Face& theFSp,
					       const TopoDS_Face& theFSr,
					       const Handle(BOPInt_Context)& theContext);
  
  Standard_EXPORT
    static Standard_Boolean IsSplitToReverse  (const TopoDS_Shape& theSp,
					       const TopoDS_Shape& theSr,
					       const Handle(BOPInt_Context)& theCtx);
  Standard_EXPORT
    static Standard_Integer BuildPCurveForEdgeOnFace  (const TopoDS_Edge& aEold,
						       const TopoDS_Edge& aEnew,
						       const TopoDS_Face& aF,
						       const Handle(BOPInt_Context)& aCtx);

//
  Standard_EXPORT
    static void FindChains(const GEOMAlgo_ListOfCoupleOfShapes& aLCS,
			   GEOMAlgo_IndexedDataMapOfShapeIndexedMapOfShape& aMapChains);

  Standard_EXPORT
    static void FindChains(const GEOMAlgo_IndexedDataMapOfShapeIndexedMapOfShape& aMCV,
			   GEOMAlgo_IndexedDataMapOfShapeIndexedMapOfShape& aMapChains);

  Standard_EXPORT
    static  void CopyShape(const TopoDS_Shape& aS,
			   TopoDS_Shape& aSC) ;
  
  Standard_EXPORT
    static  void CopyShape(const TopoDS_Shape& aS,
			   TopoDS_Shape& aSC,
			   TopTools_IndexedDataMapOfShapeShape& aMSS) ;
};
#endif