0031939: Coding - correction of spelling errors in comments [part 3]
[occt.git] / src / GeomPlate / GeomPlate_BuildPlateSurface.hxx
1 // Created on: 1996-04-03
2 // Created by: Stagiaire Frederic CALOONE
3 // Copyright (c) 1996-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 _GeomPlate_BuildPlateSurface_HeaderFile
18 #define _GeomPlate_BuildPlateSurface_HeaderFile
19
20 #include <Standard.hxx>
21 #include <Standard_DefineAlloc.hxx>
22 #include <Standard_Handle.hxx>
23
24 #include <GeomPlate_HSequenceOfCurveConstraint.hxx>
25 #include <GeomPlate_HArray1OfSequenceOfReal.hxx>
26 #include <GeomPlate_HSequenceOfPointConstraint.hxx>
27 #include <Plate_Plate.hxx>
28 #include <Standard_Boolean.hxx>
29 #include <TColStd_HArray1OfInteger.hxx>
30 #include <Standard_Integer.hxx>
31 #include <Standard_Real.hxx>
32 #include <Extrema_ExtPS.hxx>
33 #include <GeomPlate_HArray1OfHCurve.hxx>
34 #include <TColgp_SequenceOfXY.hxx>
35 #include <TColgp_SequenceOfXYZ.hxx>
36 #include <TColGeom2d_HArray1OfCurve.hxx>
37 #include <TColStd_HArray1OfReal.hxx>
38 class Geom_Surface;
39 class GeomPlate_Surface;
40 class Standard_ConstructionError;
41 class Standard_RangeError;
42 class GeomPlate_CurveConstraint;
43 class GeomPlate_PointConstraint;
44 class gp_Pnt2d;
45 class gp_Pnt;
46 class Geom2d_Curve;
47
48
49 //! This class provides an algorithm for constructing such a plate surface that
50 //! it conforms to given curve and/or point constraints.
51 //! The algorithm accepts or constructs an initial surface
52 //! and looks for a deformation of it satisfying the
53 //! constraints and minimizing energy input.
54 //! A BuildPlateSurface object provides a framework for:
55 //! -   defining or setting constraints
56 //! -   implementing the construction algorithm
57 //! -   consulting the result.
58 class GeomPlate_BuildPlateSurface 
59 {
60 public:
61
62   DEFINE_STANDARD_ALLOC
63
64   
65   //! Constructor  compatible  with  the  old  version
66   //! with this constructor the constraint are given in a Array of Curve on Surface
67   //! The array NbPoints  contains the number of points for each constraint.
68   //! The Array Tang contains the order of constraint for each Constraint: The possible values for this
69   //! order has to be -1 , 0 , 1 , 2 . Order i means constraint Gi.
70   //! NbIter is the maximum number of iteration to optimise the number of points for resolution
71   //! Degree is the degree of resolution for Plate
72   //! Tol2d is the tolerance used to test if two points of different constraint are identical in the
73   //! parametric space of the initial surface
74   //! Tol3d is used to test if two identical points in the 2d space are identical in 3d space
75   //! TolAng is used to compare the angle between normal of two identical points in the 2d space
76   //! Raises  ConstructionError;
77   Standard_EXPORT GeomPlate_BuildPlateSurface(const Handle(TColStd_HArray1OfInteger)& NPoints, const Handle(GeomPlate_HArray1OfHCurve)& TabCurve, const Handle(TColStd_HArray1OfInteger)& Tang, const Standard_Integer Degree, const Standard_Integer NbIter = 3, const Standard_Real Tol2d = 0.00001, const Standard_Real Tol3d = 0.0001, const Standard_Real TolAng = 0.01, const Standard_Real TolCurv = 0.1, const Standard_Boolean Anisotropie = Standard_False);
78   
79   Standard_EXPORT GeomPlate_BuildPlateSurface(const Handle(Geom_Surface)& Surf, const Standard_Integer Degree = 3, const Standard_Integer NbPtsOnCur = 10, const Standard_Integer NbIter = 3, const Standard_Real Tol2d = 0.00001, const Standard_Real Tol3d = 0.0001, const Standard_Real TolAng = 0.01, const Standard_Real TolCurv = 0.1, const Standard_Boolean Anisotropie = Standard_False);
80   
81   //! Initializes the BuildPlateSurface framework for
82   //! deforming plate surfaces using curve and point
83   //! constraints. You use the first constructor if you have
84   //! an initial surface to work with at construction time. If
85   //! not, you use the second. You can add one later by
86   //! using the method LoadInitSurface. If no initial
87   //! surface is loaded, one will automatically be computed.
88   //! The curve and point constraints will be defined by
89   //! using the method Add.
90   //! Before the call to the algorithm, the curve constraints
91   //! will be transformed into sequences of discrete points.
92   //! Each curve defined as a constraint will be given the
93   //! value of NbPtsOnCur as the average number of points on it.
94   //! Several arguments serve to improve performance of
95   //! the algorithm. NbIter, for example, expresses the
96   //! number of iterations allowed and is used to control the
97   //! duration of computation. To optimize resolution,
98   //! Degree will have the default value of 3.
99   //! The surface generated must respect several tolerance values:
100   //! -   2d tolerance given by Tol2d, with a default value of 0.00001
101   //! -   3d tolerance expressed by Tol3d, with a default value of 0.0001
102   //! -   angular tolerance given by TolAng, with a default
103   //! value of 0.01, defining the greatest angle allowed
104   //! between the constraint and the target surface.
105   //! Exceptions
106   //! Standard_ConstructionError if NbIter is less than 1 or Degree is less than 3.
107   Standard_EXPORT GeomPlate_BuildPlateSurface(const Standard_Integer Degree = 3, const Standard_Integer NbPtsOnCur = 10, const Standard_Integer NbIter = 3, const Standard_Real Tol2d = 0.00001, const Standard_Real Tol3d = 0.0001, const Standard_Real TolAng = 0.01, const Standard_Real TolCurv = 0.1, const Standard_Boolean Anisotropie = Standard_False);
108   
109   //! Resets all constraints
110   Standard_EXPORT void Init();
111   
112   //! Loads the initial Surface
113   Standard_EXPORT void LoadInitSurface (const Handle(Geom_Surface)& Surf);
114   
115   //! Adds the linear constraint cont.
116   Standard_EXPORT void Add (const Handle(GeomPlate_CurveConstraint)& Cont);
117   
118   Standard_EXPORT void SetNbBounds (const Standard_Integer NbBounds);
119   
120   //! Adds the point constraint cont.
121   Standard_EXPORT void Add (const Handle(GeomPlate_PointConstraint)& Cont);
122   
123
124   //! Calls the algorithm and computes the plate surface using
125   //! the loaded constraints. If no initial surface is given, the
126   //! algorithm automatically computes one.
127   //! Exceptions
128   //! Standard_RangeError if the value of the constraint is
129   //! null or if plate is not done.
130   Standard_EXPORT void Perform(const Message_ProgressRange& theProgress = Message_ProgressRange());
131   
132   //! returns the CurveConstraints of order order
133   Standard_EXPORT Handle(GeomPlate_CurveConstraint) CurveConstraint (const Standard_Integer order) const;
134   
135   //! returns the PointConstraint of order order
136   Standard_EXPORT Handle(GeomPlate_PointConstraint) PointConstraint (const Standard_Integer order) const;
137   
138   Standard_EXPORT void Disc2dContour (const Standard_Integer nbp, TColgp_SequenceOfXY& Seq2d);
139   
140   Standard_EXPORT void Disc3dContour (const Standard_Integer nbp, const Standard_Integer iordre, TColgp_SequenceOfXYZ& Seq3d);
141   
142
143   //! Tests whether computation of the plate has been completed.
144   Standard_EXPORT Standard_Boolean IsDone() const;
145   
146
147   //! Returns the result of the computation. This surface can
148   //! then be used by GeomPlate_MakeApprox for
149   //! converting the resulting surface into a BSpline.
150   Standard_EXPORT Handle(GeomPlate_Surface) Surface() const;
151   
152   //! Returns the initial surface
153   Standard_EXPORT Handle(Geom_Surface) SurfInit() const;
154   
155
156   //! Allows you to ensure that the array of curves returned by
157   //! Curves2d has the correct orientation. Returns the
158   //! orientation of the curves in the the array returned by
159   //! Curves2d. Computation changes the orientation of
160   //! these curves. Consequently, this method returns the
161   //! orientation prior to computation.
162   Standard_EXPORT Handle(TColStd_HArray1OfInteger) Sense() const;
163   
164
165   //! Extracts the array of curves on the plate surface which
166   //! correspond to the curve constraints set in Add.
167   Standard_EXPORT Handle(TColGeom2d_HArray1OfCurve) Curves2d() const;
168   
169
170   //! Returns the order of the curves in the array returned by
171   //! Curves2d. Computation changes this order.
172   //! Consequently, this method returns the order of the
173   //! curves prior to computation.
174   Standard_EXPORT Handle(TColStd_HArray1OfInteger) Order() const;
175   
176   //! Returns the max distance between the result and the constraints
177   Standard_EXPORT Standard_Real G0Error() const;
178   
179   //! Returns  the max angle between the result and the constraints
180   Standard_EXPORT Standard_Real G1Error() const;
181   
182   //! Returns  the max difference of curvature between the result and the constraints
183   Standard_EXPORT Standard_Real G2Error() const;
184   
185   //! Returns   the max distance between the result and the constraint Index
186   Standard_EXPORT Standard_Real G0Error (const Standard_Integer Index);
187   
188   //! Returns the max angle between the result and the constraint Index
189   Standard_EXPORT Standard_Real G1Error (const Standard_Integer Index);
190   
191   //! Returns the max difference of curvature between the result and the constraint Index
192   Standard_EXPORT Standard_Real G2Error (const Standard_Integer Index);
193
194
195
196
197 protected:
198
199
200
201
202
203 private:
204
205   
206   //! Evaluates the distance, the angle between normals, and the "courbure"
207   //! on middle points of constraints and corresponding points on the GeomPlate_Surface
208   //! the results are given for a curve c
209   Standard_EXPORT void EcartContraintesMil (const Standard_Integer c, Handle(TColStd_HArray1OfReal)& d, Handle(TColStd_HArray1OfReal)& an, Handle(TColStd_HArray1OfReal)& courb);
210   
211   Standard_EXPORT gp_Pnt2d ProjectPoint (const gp_Pnt& P);
212   
213   Standard_EXPORT Handle(Geom2d_Curve) ProjectCurve (const Handle(Adaptor3d_Curve)& Curv);
214   
215   Standard_EXPORT Handle(Adaptor2d_Curve2d) ProjectedCurve (Handle(Adaptor3d_Curve)& Curv);
216   
217   Standard_EXPORT void ComputeSurfInit(const Message_ProgressRange& theProgress);
218   
219   Standard_EXPORT void Intersect (Handle(GeomPlate_HArray1OfSequenceOfReal)& PntInter, Handle(GeomPlate_HArray1OfSequenceOfReal)& PntG1G1);
220   
221   Standard_EXPORT void Discretise (const Handle(GeomPlate_HArray1OfSequenceOfReal)& PntInter, const Handle(GeomPlate_HArray1OfSequenceOfReal)& PntG1G1);
222   
223   Standard_EXPORT void LoadCurve (const Standard_Integer NbBoucle, const Standard_Integer OrderMax = 2);
224   
225   Standard_EXPORT void LoadPoint (const Standard_Integer NbBoucle, const Standard_Integer OrderMax = 2);
226   
227   Standard_EXPORT void CalculNbPtsInit();
228   
229   Standard_EXPORT Standard_Boolean VerifSurface (const Standard_Integer NbLoop);
230   
231   Standard_EXPORT void VerifPoints (Standard_Real& dist, Standard_Real& ang, Standard_Real& curv) const;
232   
233   Standard_EXPORT Standard_Boolean CourbeJointive (const Standard_Real tolerance);
234   
235   Standard_EXPORT Standard_Real ComputeAnisotropie() const;
236   
237   Standard_EXPORT Standard_Boolean IsOrderG1() const;
238
239
240   Handle(GeomPlate_HSequenceOfCurveConstraint) myLinCont;
241   Handle(GeomPlate_HArray1OfSequenceOfReal) myParCont;
242   Handle(GeomPlate_HArray1OfSequenceOfReal) myPlateCont;
243   Handle(GeomPlate_HSequenceOfPointConstraint) myPntCont;
244   Handle(Geom_Surface) mySurfInit;
245   Handle(Geom_Surface) myPlanarSurfInit;
246   Handle(GeomPlate_Surface) myGeomPlateSurface;
247   Plate_Plate myPlate;
248   Plate_Plate myPrevPlate;
249   Standard_Boolean myAnisotropie;
250   Handle(TColStd_HArray1OfInteger) mySense;
251   Standard_Integer myDegree;
252   Handle(TColStd_HArray1OfInteger) myInitOrder;
253   Standard_Real myG0Error;
254   Standard_Real myG1Error;
255   Standard_Real myG2Error;
256   Standard_Integer myNbPtsOnCur;
257   Standard_Boolean mySurfInitIsGive;
258   Standard_Integer myNbIter;
259   Extrema_ExtPS myProj;
260   Standard_Real myTol2d;
261   Standard_Real myTol3d;
262   Standard_Real myTolAng;
263   Standard_Real myTolU;
264   Standard_Real myTolV;
265   Standard_Integer myNbBounds;
266   Standard_Boolean myIsLinear;
267   Standard_Boolean myFree;
268
269
270 };
271
272
273
274
275
276
277
278 #endif // _GeomPlate_BuildPlateSurface_HeaderFile