src/BRepTools/BRepTools_Modification.hxx

   1 // Created on: 1994-08-25
   2 // Created by: Jacques GOUSSARD
   3 // Copyright (c) 1994-1999 Matra Datavision
   4 // Copyright (c) 1999-2014 OPEN CASCADE SAS
   5 //
   6 // This file is part of Open CASCADE Technology software library.
   7 //
   8 // This library is free software; you can redistribute it and/or modify it under
   9 // the terms of the GNU Lesser General Public License version 2.1 as published
  10 // by the Free Software Foundation, with special exception defined in the file
  11 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
  12 // distribution for complete text of the license and disclaimer of any warranty.
  13 //
  14 // Alternatively, this file may be used under the terms of Open CASCADE
  15 // commercial license or contractual agreement.
  16
  17 #ifndef _BRepTools_Modification_HeaderFile
  18 #define _BRepTools_Modification_HeaderFile
  19
  20 #include <Standard.hxx>
  21 #include <Standard_Type.hxx>
  22
  23 #include <Standard_Transient.hxx>
  24 #include <Standard_Real.hxx>
  25 #include <GeomAbs_Shape.hxx>
  26 class TopoDS_Face;
  27 class Geom_Surface;
  28 class TopLoc_Location;
  29 class TopoDS_Edge;
  30 class Geom_Curve;
  31 class TopoDS_Vertex;
  32 class gp_Pnt;
  33 class Geom2d_Curve;
  34 class Poly_Triangulation;
  35
  36 class Poly_Polygon3D;
  37 class Poly_PolygonOnTriangulation;
  38
  39
  40 class BRepTools_Modification;
  41 DEFINE_STANDARD_HANDLE(BRepTools_Modification, Standard_Transient)
  42
  43 //! Defines geometric modifications to a shape, i.e.
  44 //! changes to faces, edges and vertices.
  45 class BRepTools_Modification : public Standard_Transient
  46 {
  47
  48 public:
  49
  50
  51   //! Returns true if the face, F, has been modified.
  52   //! If the face has been modified:
  53   //! - S is the new geometry of the face,
  54   //! - L is its new location, and
  55   //! - Tol is the new tolerance.
  56   //! The flag, RevWires, is set to true when the
  57   //! modification reverses the normal of the surface, (i.e.
  58   //! the wires have to be reversed).
  59   //! The flag, RevFace, is set to true if the orientation of
  60   //! the modified face changes in the shells which contain it.
  61   //! If the face has not been modified this function returns
  62   //! false, and the values of S, L, Tol, RevWires and
  63   //! RevFace are not significant.
  64   Standard_EXPORT virtual Standard_Boolean NewSurface (const TopoDS_Face& F, Handle(Geom_Surface)& S, TopLoc_Location& L, Standard_Real& Tol, Standard_Boolean& RevWires, Standard_Boolean& RevFace) = 0;
  65
  66   //! Returns true if the face has been modified according to changed triangulation.
  67   //! If the face has been modified:
  68   //! - T is a new triangulation on the face
  69   Standard_EXPORT virtual Standard_Boolean NewTriangulation(const TopoDS_Face& F, Handle(Poly_Triangulation)& T);
  70
  71   //! Returns true if the edge, E, has been modified.
  72   //! If the edge has been modified:
  73   //! - C is the new geometry associated with the edge,
  74   //! - L is its new location, and
  75   //! - Tol is the new tolerance.
  76   //! If the edge has not been modified, this function
  77   //! returns false, and the values of C, L and Tol are not significant.
  78   Standard_EXPORT virtual Standard_Boolean NewCurve (const TopoDS_Edge& E, Handle(Geom_Curve)& C, TopLoc_Location& L, Standard_Real& Tol) = 0;
  79
  80   //! Returns true if the edge has been modified according to changed polygon.
  81   //! If the edge has been modified:
  82   //! - P is a new polygon
  83   Standard_EXPORT virtual Standard_Boolean NewPolygon(const TopoDS_Edge& E, Handle(Poly_Polygon3D)& P);
  84
  85   //! Returns true if the edge has been modified according to changed polygon on triangulation.
  86   //! If the edge has been modified:
  87   //! - P is a new polygon on triangulation
  88   Standard_EXPORT virtual Standard_Boolean NewPolygonOnTriangulation(const TopoDS_Edge& E, const TopoDS_Face& F, Handle(Poly_PolygonOnTriangulation)& P);
  89
  90   //! Returns true if the vertex V has been modified.
  91   //! If V has been modified:
  92   //! - P is the new geometry of the vertex, and
  93   //! - Tol is the new tolerance.
  94   //! If the vertex has not been modified this function
  95   //! returns false, and the values of P and Tol are not significant.
  96   Standard_EXPORT virtual Standard_Boolean NewPoint (const TopoDS_Vertex& V, gp_Pnt& P, Standard_Real& Tol) = 0;
  97
  98   //! Returns true if the edge, E, has a new curve on
  99   //! surface on the face, F.
 100   //! If a new curve exists:
 101   //! - C is the new geometry of the edge,
 102   //! - L is the new location, and
 103   //! - Tol is the new tolerance.
 104   //! NewE is the new edge created from E, and NewF is
 105   //! the new face created from F.
 106   //! If there is no new curve on the face, this function
 107   //! returns false, and the values of C, L and Tol are not significant.
 108   Standard_EXPORT virtual Standard_Boolean NewCurve2d (const TopoDS_Edge& E, const TopoDS_Face& F, const TopoDS_Edge& NewE, const TopoDS_Face& NewF, Handle(Geom2d_Curve)& C, Standard_Real& Tol) = 0;
 109
 110   //! Returns true if the vertex V has a new parameter on the edge E.
 111   //! If a new parameter exists:
 112   //! - P is the parameter, and
 113   //! - Tol is the new tolerance.
 114   //! If there is no new parameter this function returns
 115   //! false, and the values of P and Tol are not significant.
 116   Standard_EXPORT virtual Standard_Boolean NewParameter (const TopoDS_Vertex& V, const TopoDS_Edge& E, Standard_Real& P, Standard_Real& Tol) = 0;
 117
 118   //! Returns the  continuity of  <NewE> between <NewF1>
 119   //! and <NewF2>.
 120   //! <NewE> is the new  edge created from <E>.  <NewF1>
 121   //! (resp. <NewF2>) is the new  face created from <F1>
 122   //! (resp. <F2>).
 123   Standard_EXPORT virtual GeomAbs_Shape Continuity (const TopoDS_Edge& E, const TopoDS_Face& F1, const TopoDS_Face& F2, const TopoDS_Edge& NewE, const TopoDS_Face& NewF1, const TopoDS_Face& NewF2) = 0;
 124
 125
 126
 127
 128   DEFINE_STANDARD_RTTIEXT(BRepTools_Modification,Standard_Transient)
 129
 130 protected:
 131
 132
 133
 134
 135 private:
 136
 137
 138
 139
 140 };
 141
 142
 143
 144
 145
 146
 147
 148 #endif // _BRepTools_Modification_HeaderFile