be93ba765c64f64ab6cb66b4ba2e91d5766d52df
[occt.git] / 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 <MMgt_TShared.hxx>
24 #include <Standard_Boolean.hxx>
25 #include <Standard_Real.hxx>
26 #include <GeomAbs_Shape.hxx>
27 class TopoDS_Face;
28 class Geom_Surface;
29 class TopLoc_Location;
30 class TopoDS_Edge;
31 class Geom_Curve;
32 class TopoDS_Vertex;
33 class gp_Pnt;
34 class Geom2d_Curve;
35 class Poly_Triangulation;
36
37
38 class BRepTools_Modification;
39 DEFINE_STANDARD_HANDLE(BRepTools_Modification, MMgt_TShared)
40
41 //! Defines geometric modifications to a shape, i.e.
42 //! changes to faces, edges and vertices.
43 class BRepTools_Modification : public MMgt_TShared
44 {
45
46 public:
47
48   
49   //! Returns true if the face, F, has been modified.
50   //! If the face has been modified:
51   //! - S is the new geometry of the face,
52   //! - L is its new location, and
53   //! - Tol is the new tolerance.
54   //! The flag, RevWires, is set to true when the
55   //! modification reverses the normal of the surface, (i.e.
56   //! the wires have to be reversed).
57   //! The flag, RevFace, is set to true if the orientation of
58   //! the modified face changes in the shells which contain it.
59   //! If the face has not been modified this function returns
60   //! false, and the values of S, L, Tol, RevWires and
61   //! RevFace are not significant.
62   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;
63
64   //! Returns true if the face has been modified according to changed triangulation.
65   //! If the face has been modified:
66   //! - T is a new triangulation on the face
67   Standard_EXPORT virtual Standard_Boolean NewTriangulation(const TopoDS_Face& F, Handle(Poly_Triangulation)& T);
68
69   //! Returns true if the edge, E, has been modified.
70   //! If the edge has been modified:
71   //! - C is the new geometry associated with the edge,
72   //! - L is its new location, and
73   //! - Tol is the new tolerance.
74   //! If the edge has not been modified, this function
75   //! returns false, and the values of C, L and Tol are not significant.
76   Standard_EXPORT virtual Standard_Boolean NewCurve (const TopoDS_Edge& E, Handle(Geom_Curve)& C, TopLoc_Location& L, Standard_Real& Tol) = 0;
77   
78   //! Returns true if the vertex V has been modified.
79   //! If V has been modified:
80   //! - P is the new geometry of the vertex, and
81   //! - Tol is the new tolerance.
82   //! If the vertex has not been modified this function
83   //! returns false, and the values of P and Tol are not significant.
84   Standard_EXPORT virtual Standard_Boolean NewPoint (const TopoDS_Vertex& V, gp_Pnt& P, Standard_Real& Tol) = 0;
85   
86   //! Returns true if the edge, E, has a new curve on
87   //! surface on the face, F.
88   //! If a new curve exists:
89   //! - C is the new geometry of the edge,
90   //! - L is the new location, and
91   //! - Tol is the new tolerance.
92   //! NewE is the new edge created from E, and NewF is
93   //! the new face created from F.
94   //! If there is no new curve on the face, this function
95   //! returns false, and the values of C, L and Tol are not significant.
96   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;
97   
98   //! Returns true if the vertex V has a new parameter on the edge E.
99   //! If a new parameter exists:
100   //! - P is the parameter, and
101   //! - Tol is the new tolerance.
102   //! If there is no new parameter this function returns
103   //! false, and the values of P and Tol are not significant.
104   Standard_EXPORT virtual Standard_Boolean NewParameter (const TopoDS_Vertex& V, const TopoDS_Edge& E, Standard_Real& P, Standard_Real& Tol) = 0;
105   
106   //! Returns the  continuity of  <NewE> between <NewF1>
107   //! and <NewF2>.
108   //! <NewE> is the new  edge created from <E>.  <NewF1>
109   //! (resp. <NewF2>) is the new  face created from <F1>
110   //! (resp. <F2>).
111   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;
112
113
114
115
116   DEFINE_STANDARD_RTTI(BRepTools_Modification,MMgt_TShared)
117
118 protected:
119
120
121
122
123 private:
124
125
126
127
128 };
129
130
131
132
133
134
135
136 #endif // _BRepTools_Modification_HeaderFile