OCCT

// Created on: 1991-07-01
// Created by: Remi LEQUETTE
// Copyright (c) 1991-1999 Matra Datavision
// Copyright (c) 1999-2014 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 _BRep_Builder_HeaderFile
#define _BRep_Builder_HeaderFile

#include <GeomAbs_Shape.hxx>
#include <Poly_Triangulation.hxx>
#include <Standard.hxx>
#include <Standard_DefineAlloc.hxx>
#include <Standard_Handle.hxx>
#include <TopoDS_Builder.hxx>

class TopoDS_Face;
class Geom_Surface;
class TopLoc_Location;
class Poly_Triangulation;
class TopoDS_Edge;
class Geom_Curve;
class Poly_Polygon3D;
class Poly_PolygonOnTriangulation;
class Geom2d_Curve;
class gp_Pnt2d;
class Poly_Polygon2D;
class TopoDS_Vertex;
class gp_Pnt;

//! A framework providing advanced tolerance control.
//! It is used to build Shapes.
//! If tolerance control is required, you are advised to:
//! 1. build a default precision for topology, using the
//! classes provided in the BRepAPI package
//! 2. update the tolerance of the resulting shape.
//! Note that only vertices, edges and faces have
//! meaningful tolerance control. The tolerance value
//! must always comply with the condition that face
//! tolerances are more restrictive than edge tolerances
//! which are more restrictive than vertex tolerances. In
//! other words: Tol(Vertex) >= Tol(Edge) >= Tol(Face).
//! Other rules in setting tolerance include:
//! - you can open up tolerance but should never restrict it
//! - an edge cannot be included within the fusion of the
//! tolerance spheres of two vertices
class BRep_Builder : public TopoDS_Builder
{
public:
  DEFINE_STANDARD_ALLOC

  //! Makes an undefined Face.
  void MakeFace(TopoDS_Face& F) const;

  //! Makes a Face with a surface.
  Standard_EXPORT void MakeFace(TopoDS_Face&                     F,
                                const occ::handle<Geom_Surface>& S,
                                const double                     Tol) const;

  //! Makes a Face with a surface and a location.
  Standard_EXPORT void MakeFace(TopoDS_Face&                     F,
                                const occ::handle<Geom_Surface>& S,
                                const TopLoc_Location&           L,
                                const double                     Tol) const;

  //! Makes a theFace with a single triangulation. The triangulation
  //! is in the same reference system than the TFace.
  Standard_EXPORT void MakeFace(TopoDS_Face&                           theFace,
                                const occ::handle<Poly_Triangulation>& theTriangulation) const;

  //! Makes a Face with a list of triangulations and active one.
  //! Use NULL active triangulation to set the first triangulation in list as active.
  //! The triangulations is in the same reference system than the TFace.
  Standard_EXPORT void MakeFace(
    TopoDS_Face&                                             theFace,
    const NCollection_List<occ::handle<Poly_Triangulation>>& theTriangulations,
    const occ::handle<Poly_Triangulation>&                   theActiveTriangulation =
      occ::handle<Poly_Triangulation>()) const;

  //! Updates the face F using the tolerance value Tol,
  //! surface S and location Location.
  Standard_EXPORT void UpdateFace(const TopoDS_Face&               F,
                                  const occ::handle<Geom_Surface>& S,
                                  const TopLoc_Location&           L,
                                  const double                     Tol) const;

  //! Changes a face triangulation.
  //! A NULL theTriangulation removes face triangulations.
  //! If theToReset is TRUE face triangulations will be reset to new list with only one input
  //! triangulation that will be active. Else if theTriangulation is contained in internal
  //! triangulations list it will be made active,
  //!      else the active triangulation will be replaced to theTriangulation one.
  Standard_EXPORT void UpdateFace(const TopoDS_Face&                     theFace,
                                  const occ::handle<Poly_Triangulation>& theTriangulation,
                                  const bool                             theToReset = true) const;

  //! Updates the face Tolerance.
  Standard_EXPORT void UpdateFace(const TopoDS_Face& F, const double Tol) const;

  //! Sets the NaturalRestriction flag of the face.
  Standard_EXPORT void NaturalRestriction(const TopoDS_Face& F, const bool N) const;

  //! Makes an undefined Edge (no geometry).
  Standard_EXPORT void MakeEdge(TopoDS_Edge& E) const;

  //! Makes an Edge with a curve.
  void MakeEdge(TopoDS_Edge& E, const occ::handle<Geom_Curve>& C, const double Tol) const;

  //! Makes an Edge with a curve and a location.
  void MakeEdge(TopoDS_Edge&                   E,
                const occ::handle<Geom_Curve>& C,
                const TopLoc_Location&         L,
                const double                   Tol) const;

  //! Makes an Edge with a polygon 3d.
  void MakeEdge(TopoDS_Edge& E, const occ::handle<Poly_Polygon3D>& P) const;

  //! makes an Edge polygon on Triangulation.
  void MakeEdge(TopoDS_Edge&                                    E,
                const occ::handle<Poly_PolygonOnTriangulation>& N,
                const occ::handle<Poly_Triangulation>&          T) const;

  //! makes an Edge polygon on Triangulation.
  void MakeEdge(TopoDS_Edge&                                    E,
                const occ::handle<Poly_PolygonOnTriangulation>& N,
                const occ::handle<Poly_Triangulation>&          T,
                const TopLoc_Location&                          L) const;

  //! Sets a 3D curve for the edge.
  //! If <C> is a null handle, remove any existing 3d curve.
  void UpdateEdge(const TopoDS_Edge& E, const occ::handle<Geom_Curve>& C, const double Tol) const;

  //! Sets a 3D curve for the edge.
  //! If <C> is a null handle, remove any existing 3d curve.
  Standard_EXPORT void UpdateEdge(const TopoDS_Edge&             E,
                                  const occ::handle<Geom_Curve>& C,
                                  const TopLoc_Location&         L,
                                  const double                   Tol) const;

  //! Sets a pcurve for the edge on the face.
  //! If <C> is a null handle, remove any existing pcurve.
  void UpdateEdge(const TopoDS_Edge&               E,
                  const occ::handle<Geom2d_Curve>& C,
                  const TopoDS_Face&               F,
                  const double                     Tol) const;

  //! Sets pcurves for the edge on the closed face. If
  //! <C1> or <C2> is a null handle, remove any existing
  //! pcurve.
  void UpdateEdge(const TopoDS_Edge&               E,
                  const occ::handle<Geom2d_Curve>& C1,
                  const occ::handle<Geom2d_Curve>& C2,
                  const TopoDS_Face&               F,
                  const double                     Tol) const;

  //! Sets a pcurve for the edge on the face.
  //! If <C> is a null handle, remove any existing pcurve.
  Standard_EXPORT void UpdateEdge(const TopoDS_Edge&               E,
                                  const occ::handle<Geom2d_Curve>& C,
                                  const occ::handle<Geom_Surface>& S,
                                  const TopLoc_Location&           L,
                                  const double                     Tol) const;

  //! Sets a pcurve for the edge on the face.
  //! If <C> is a null handle, remove any existing pcurve.
  //! Sets UV bounds for curve repsentation
  Standard_EXPORT void UpdateEdge(const TopoDS_Edge&               E,
                                  const occ::handle<Geom2d_Curve>& C,
                                  const occ::handle<Geom_Surface>& S,
                                  const TopLoc_Location&           L,
                                  const double                     Tol,
                                  const gp_Pnt2d&                  Pf,
                                  const gp_Pnt2d&                  Pl) const;

  //! Sets pcurves for the edge on the closed surface.
  //! <C1> or <C2> is a null handle, remove any existing
  //! pcurve.
  Standard_EXPORT void UpdateEdge(const TopoDS_Edge&               E,
                                  const occ::handle<Geom2d_Curve>& C1,
                                  const occ::handle<Geom2d_Curve>& C2,
                                  const occ::handle<Geom_Surface>& S,
                                  const TopLoc_Location&           L,
                                  const double                     Tol) const;

  //! Sets pcurves for the edge on the closed surface.
  //! <C1> or <C2> is a null handle, remove any existing
  //! pcurve.
  //! Sets UV bounds for curve repsentation
  Standard_EXPORT void UpdateEdge(const TopoDS_Edge&               E,
                                  const occ::handle<Geom2d_Curve>& C1,
                                  const occ::handle<Geom2d_Curve>& C2,
                                  const occ::handle<Geom_Surface>& S,
                                  const TopLoc_Location&           L,
                                  const double                     Tol,
                                  const gp_Pnt2d&                  Pf,
                                  const gp_Pnt2d&                  Pl) const;

  //! Changes an Edge 3D polygon.
  //! A null Polygon removes the 3d Polygon.
  void UpdateEdge(const TopoDS_Edge& E, const occ::handle<Poly_Polygon3D>& P) const;

  //! Changes an Edge 3D polygon.
  //! A null Polygon removes the 3d Polygon.
  Standard_EXPORT void UpdateEdge(const TopoDS_Edge&                 E,
                                  const occ::handle<Poly_Polygon3D>& P,
                                  const TopLoc_Location&             L) const;

  //! Changes an Edge polygon on Triangulation.
  void UpdateEdge(const TopoDS_Edge&                              E,
                  const occ::handle<Poly_PolygonOnTriangulation>& N,
                  const occ::handle<Poly_Triangulation>&          T) const;

  //! Changes an Edge polygon on Triangulation.
  Standard_EXPORT void UpdateEdge(const TopoDS_Edge&                              E,
                                  const occ::handle<Poly_PolygonOnTriangulation>& N,
                                  const occ::handle<Poly_Triangulation>&          T,
                                  const TopLoc_Location&                          L) const;

  //! Changes an Edge polygon on Triangulation.
  void UpdateEdge(const TopoDS_Edge&                              E,
                  const occ::handle<Poly_PolygonOnTriangulation>& N1,
                  const occ::handle<Poly_PolygonOnTriangulation>& N2,
                  const occ::handle<Poly_Triangulation>&          T) const;

  //! Changes an Edge polygon on Triangulation.
  Standard_EXPORT void UpdateEdge(const TopoDS_Edge&                              E,
                                  const occ::handle<Poly_PolygonOnTriangulation>& N1,
                                  const occ::handle<Poly_PolygonOnTriangulation>& N2,
                                  const occ::handle<Poly_Triangulation>&          T,
                                  const TopLoc_Location&                          L) const;

  //! Changes Edge polygon on a face.
  Standard_EXPORT void UpdateEdge(const TopoDS_Edge&                 E,
                                  const occ::handle<Poly_Polygon2D>& P,
                                  const TopoDS_Face&                 S) const;

  //! Changes Edge polygon on a face.
  Standard_EXPORT void UpdateEdge(const TopoDS_Edge&                 E,
                                  const occ::handle<Poly_Polygon2D>& P,
                                  const occ::handle<Geom_Surface>&   S,
                                  const TopLoc_Location&             T) const;

  //! Changes Edge polygons on a face.
  //!
  //! A null Polygon removes the 2d Polygon.
  Standard_EXPORT void UpdateEdge(const TopoDS_Edge&                 E,
                                  const occ::handle<Poly_Polygon2D>& P1,
                                  const occ::handle<Poly_Polygon2D>& P2,
                                  const TopoDS_Face&                 S) const;

  //! Changes Edge polygons on a face.
  //!
  //! A null Polygon removes the 2d Polygon.
  Standard_EXPORT void UpdateEdge(const TopoDS_Edge&                 E,
                                  const occ::handle<Poly_Polygon2D>& P1,
                                  const occ::handle<Poly_Polygon2D>& P2,
                                  const occ::handle<Geom_Surface>&   S,
                                  const TopLoc_Location&             L) const;

  //! Updates the edge tolerance.
  Standard_EXPORT void UpdateEdge(const TopoDS_Edge& E, const double Tol) const;

  //! Sets the geometric continuity on the edge.
  Standard_EXPORT void Continuity(const TopoDS_Edge&  E,
                                  const TopoDS_Face&  F1,
                                  const TopoDS_Face&  F2,
                                  const GeomAbs_Shape C) const;

  //! Sets the geometric continuity on the edge.
  Standard_EXPORT void Continuity(const TopoDS_Edge&               E,
                                  const occ::handle<Geom_Surface>& S1,
                                  const occ::handle<Geom_Surface>& S2,
                                  const TopLoc_Location&           L1,
                                  const TopLoc_Location&           L2,
                                  const GeomAbs_Shape              C) const;

  //! Sets the same parameter flag for the edge <E>.
  Standard_EXPORT void SameParameter(const TopoDS_Edge& E, const bool S) const;

  //! Sets the same range flag for the edge <E>.
  Standard_EXPORT void SameRange(const TopoDS_Edge& E, const bool S) const;

  //! Sets the degenerated flag for the edge <E>.
  Standard_EXPORT void Degenerated(const TopoDS_Edge& E, const bool D) const;

  //! Sets the range of the 3d curve if Only3d=TRUE,
  //! otherwise sets the range to all the representations
  Standard_EXPORT void Range(const TopoDS_Edge& E,
                             const double       First,
                             const double       Last,
                             const bool         Only3d = false) const;

  //! Sets the range of the edge on the pcurve on the
  //! surface.
  Standard_EXPORT void Range(const TopoDS_Edge&               E,
                             const occ::handle<Geom_Surface>& S,
                             const TopLoc_Location&           L,
                             const double                     First,
                             const double                     Last) const;

  //! Sets the range of the edge on the pcurve on the face.
  void Range(const TopoDS_Edge& E,
             const TopoDS_Face& F,
             const double       First,
             const double       Last) const;

  //! Add to <Eout> the geometric representations of <Ein>.
  Standard_EXPORT void Transfert(const TopoDS_Edge& Ein, const TopoDS_Edge& Eout) const;

  //! Makes an udefined vertex without geometry.
  void MakeVertex(TopoDS_Vertex& V) const;

  //! Makes a vertex from a 3D point.
  void MakeVertex(TopoDS_Vertex& V, const gp_Pnt& P, const double Tol) const;

  //! Sets a 3D point on the vertex.
  Standard_EXPORT void UpdateVertex(const TopoDS_Vertex& V,
                                    const gp_Pnt&        P,
                                    const double         Tol) const;

  //! Sets the parameter for the vertex on the edge curves.
  Standard_EXPORT void UpdateVertex(const TopoDS_Vertex& V,
                                    const double         P,
                                    const TopoDS_Edge&   E,
                                    const double         Tol) const;

  //! Sets the parameter for the vertex on the edge
  //! pcurve on the face.
  void UpdateVertex(const TopoDS_Vertex& V,
                    const double         P,
                    const TopoDS_Edge&   E,
                    const TopoDS_Face&   F,
                    const double         Tol) const;

  //! Sets the parameter for the vertex on the edge
  //! pcurve on the surface.
  Standard_EXPORT void UpdateVertex(const TopoDS_Vertex&             V,
                                    const double                     P,
                                    const TopoDS_Edge&               E,
                                    const occ::handle<Geom_Surface>& S,
                                    const TopLoc_Location&           L,
                                    const double                     Tol) const;

  //! Sets the parameters for the vertex on the face.
  Standard_EXPORT void UpdateVertex(const TopoDS_Vertex& Ve,
                                    const double         U,
                                    const double         V,
                                    const TopoDS_Face&   F,
                                    const double         Tol) const;

  //! Updates the vertex tolerance.
  Standard_EXPORT void UpdateVertex(const TopoDS_Vertex& V, const double Tol) const;

  //! Transfert the parameters of Vin on Ein as the
  //! parameter of Vout on Eout.
  Standard_EXPORT void Transfert(const TopoDS_Edge&   Ein,
                                 const TopoDS_Edge&   Eout,
                                 const TopoDS_Vertex& Vin,
                                 const TopoDS_Vertex& Vout) const;
};

#include <BRep_Builder.lxx>

#endif // _BRep_Builder_HeaderFile