0028838: Configuration - undefine macros coming from X11 headers in place of collision
[occt.git] / src / ShapeConstruct / ShapeConstruct_ProjectCurveOnSurface.hxx
1 // Created on: 1998-07-14
2 // Created by: data exchange team
3 // Copyright (c) 1998-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 _ShapeConstruct_ProjectCurveOnSurface_HeaderFile
18 #define _ShapeConstruct_ProjectCurveOnSurface_HeaderFile
19
20 #include <Standard.hxx>
21 #include <Standard_Type.hxx>
22
23 #include <Standard_Real.hxx>
24 #include <Standard_Boolean.hxx>
25 #include <Standard_Integer.hxx>
26 #include <gp_Pnt.hxx>
27 #include <gp_Pnt2d.hxx>
28 #include <MMgt_TShared.hxx>
29 #include <ShapeExtend_Status.hxx>
30 #include <GeomAbs_Shape.hxx>
31 #include <TColgp_Array1OfPnt.hxx>
32 #include <TColStd_Array1OfReal.hxx>
33 #include <TColgp_Array1OfPnt2d.hxx>
34 #include <TColgp_HArray1OfPnt2d.hxx>
35 #include <TColStd_HArray1OfReal.hxx>
36 #include <TColgp_HArray1OfPnt.hxx>
37 class ShapeAnalysis_Surface;
38 class Geom_Surface;
39 class Geom_Curve;
40 class Geom2d_Curve;
41
42 // resolve name collisions with X11 headers
43 #ifdef Status
44   #undef Status
45 #endif
46
47 class ShapeConstruct_ProjectCurveOnSurface;
48 DEFINE_STANDARD_HANDLE(ShapeConstruct_ProjectCurveOnSurface, MMgt_TShared)
49
50 //! This tool provides a method for computing pcurve by projecting
51 //! 3d curve onto a surface.
52 //! Projection is done by 23 or more points (this number is changed
53 //! for B-Splines according to the following rule:
54 //! the total number of the points is not less than number of spans *
55 //! (degree + 1);
56 //! it is increased recursively starting with 23 and is added with 22
57 //! until the condition is fulfilled).
58 //! Isoparametric cases (if curve corresponds to U=const or V=const on
59 //! the surface) are recognized with the given precision.
60 class ShapeConstruct_ProjectCurveOnSurface : public MMgt_TShared
61 {
62
63 public:
64
65   
66   //! Empty constructor.
67   Standard_EXPORT ShapeConstruct_ProjectCurveOnSurface();
68   
69   //! Initializes the object with all necessary parameters,
70   //! i.e. surface and precision
71   Standard_EXPORT virtual void Init (const Handle(Geom_Surface)& surf, const Standard_Real preci);
72   
73   //! Initializes the object with all necessary parameters,
74   //! i.e. surface and precision
75   Standard_EXPORT virtual void Init (const Handle(ShapeAnalysis_Surface)& surf, const Standard_Real preci);
76   
77   //! Loads a surface (in the form of Geom_Surface) to project on
78   Standard_EXPORT void SetSurface (const Handle(Geom_Surface)& surf);
79   
80   //! Loads a surface (in the form of ShapeAnalysis_Surface) to project on
81   Standard_EXPORT void SetSurface (const Handle(ShapeAnalysis_Surface)& surf);
82   
83   //! Sets value for current precision
84   Standard_EXPORT void SetPrecision (const Standard_Real preci);
85   
86   //! Returns (modifiable) the build-curve-3d mode, by default False
87   //! If True, if the projected curve has been recomputed by
88   //! interpolation, the 3d curve is also rebuild by interpolation
89   Standard_EXPORT Standard_Boolean& BuildCurveMode();
90   
91   //! Returns (modifiable) the flag specifying to which side of
92   //! parametrical space adjust part of pcurve which lies on seam.
93   //! This is required in very rare case when 3d curve which is
94   //! to be projected goes partly along the seam on the closed
95   //! surface with singularity (e.g. sphere), goes through the
96   //! degenerated point and paerly lies on internal area of surface.
97   //!
98   //! If this flag is True, the seam part of such curve will be
99   //! adjusted to the left side of parametric space (on sphere U=0),
100   //! else to the right side (on sphere U=2*PI)
101   //! Default value is True
102   Standard_EXPORT Standard_Integer& AdjustOverDegenMode();
103   
104   //! Returns the status of last Peform
105   Standard_EXPORT Standard_Boolean Status (const ShapeExtend_Status theStatus) const;
106   
107   //! Computes the projection of 3d curve onto a surface using the
108   //! specialized algorithm. Returns False if projector fails,
109   //! otherwise, if pcurve computed successfully, returns True.
110   //! The continuity, maxdeg and nbinterval are parameters of call
111   //! to Approx_CurveOnSurface. If nbinterval is equal to -1
112   //! (default), this value is computed depending on source 3d curve
113   //! and surface. The output curve 2D is guaranteed to be same-parameter
114   //! with input curve 3D on the interval [First, Last]. If the output curve
115   //! lies on a direct line the infinite line is returned, in the case
116   //! same-parameter condition is satisfied.
117   Standard_EXPORT virtual Standard_Boolean Perform (Handle(Geom_Curve)& c3d, const Standard_Real First, const Standard_Real Last, Handle(Geom2d_Curve)& c2d, const GeomAbs_Shape continuity = GeomAbs_C1, const Standard_Integer maxdeg = 12, const Standard_Integer nbinterval = -1);
118   
119   //! Computes the projection of 3d curve onto a surface using the
120   //! standard algorithm from ProjLib. Returns False if standard
121   //! projector fails or raises an exception or cuts the curve by
122   //! parametrical bounds of the surface. Else, if pcurve computed
123   //! successfully, returns True.
124   //! The continuity, maxdeg and nbinterval are parameters of call
125   //! to Approx_CurveOnSurface. If nbinterval is equal to -1
126   //! (default), this value is computed depending on source 3d curve
127   //! and surface.
128   Standard_EXPORT Standard_Boolean PerformByProjLib (Handle(Geom_Curve)& c3d, const Standard_Real First, const Standard_Real Last, Handle(Geom2d_Curve)& c2d, const GeomAbs_Shape continuity = GeomAbs_C1, const Standard_Integer maxdeg = 12, const Standard_Integer nbinterval = -1);
129   
130   //! Computes the projection of 3d curve onto a surface using
131   //! either standard projector (method PerformByProjLib()) or
132   //! internal one (method Perform()). The selection is done by
133   //! analyzing the surface and 3d curve and is aimed to filter
134   //! the cases potentially dangerous for the standard projector.
135   //! If the standard projector fails, internal one is used.
136   Standard_EXPORT Standard_Boolean PerformAdvanced (Handle(Geom_Curve)& c3d, const Standard_Real First, const Standard_Real Last, Handle(Geom2d_Curve)& c2d);
137
138
139
140
141   DEFINE_STANDARD_RTTIEXT(ShapeConstruct_ProjectCurveOnSurface,MMgt_TShared)
142
143 protected:
144
145   
146   //! Try to approximate 3D curve by Geom2d_Line
147   //! or Geom2d_BsplineCurve with degree 1 with specified tolerance.
148   //! points - points obtained from 3d curve.
149   //! params - parameters corresponding points on 3d curves
150   //! points2d - 2d points lies on line in parametric space
151   //! theTol - tolerance used for compare initial points 3d and
152   //! 3d points obtained from line lying in parameric space of surface
153   Standard_EXPORT Handle(Geom2d_Curve) getLine (const TColgp_Array1OfPnt& points, const TColStd_Array1OfReal& params, TColgp_Array1OfPnt2d& points2d, const Standard_Real theTol, Standard_Boolean& IsRecompute, Standard_Boolean &isFromCashe) const;
154
155   Handle(ShapeAnalysis_Surface) mySurf;
156   Standard_Real myPreci;
157   Standard_Boolean myBuild;
158   Standard_Integer myStatus;
159   Standard_Integer myAdjustOverDegen;
160   Standard_Integer myNbCashe;
161   gp_Pnt myCashe3d[2];
162   gp_Pnt2d myCashe2d[2];
163
164
165 private:
166
167   
168   Standard_EXPORT Handle(Geom2d_Curve) ProjectAnalytic (const Handle(Geom_Curve)& c3d) const;
169   
170   Standard_EXPORT Standard_Boolean ApproxPCurve (const Standard_Integer nbrPnt, const TColgp_Array1OfPnt& points, const TColStd_Array1OfReal& params, TColgp_Array1OfPnt2d& points2d, Handle(Geom2d_Curve)& c2d);
171   
172   Standard_EXPORT Handle(Geom2d_Curve) InterpolatePCurve (const Standard_Integer nbrPnt, Handle(TColgp_HArray1OfPnt2d)& points2d, Handle(TColStd_HArray1OfReal)& params, const Handle(Geom_Curve)& orig) const;
173   
174   Standard_EXPORT Handle(Geom2d_Curve) ApproximatePCurve (const Standard_Integer nbrPnt, Handle(TColgp_HArray1OfPnt2d)& points2d, Handle(TColStd_HArray1OfReal)& params, const Handle(Geom_Curve)& orig) const;
175   
176   Standard_EXPORT Handle(Geom_Curve) InterpolateCurve3d (const Standard_Integer nbrPnt, Handle(TColgp_HArray1OfPnt)& points, Handle(TColStd_HArray1OfReal)& params, const Handle(Geom_Curve)& orig) const;
177   
178   Standard_EXPORT void CheckPoints (Handle(TColgp_HArray1OfPnt)& points, Handle(TColStd_HArray1OfReal)& params, Standard_Real& preci) const;
179   
180   Standard_EXPORT void CheckPoints2d (Handle(TColgp_HArray1OfPnt2d)& points, Handle(TColStd_HArray1OfReal)& params, Standard_Real& preci) const;
181   
182   Standard_EXPORT Standard_Boolean IsAnIsoparametric (const Standard_Integer nbrPnt, const TColgp_Array1OfPnt& points, const TColStd_Array1OfReal& params, Standard_Boolean& isoTypeU, Standard_Boolean& p1OnIso, gp_Pnt2d& valueP1, Standard_Boolean& p2OnIso, gp_Pnt2d& valueP2, Standard_Boolean& isoPar2d3d, Handle(Geom_Curve)& cIso, Standard_Real& t1, Standard_Real& t2, TColStd_Array1OfReal& pout) const;
183
184
185
186 };
187
188
189
190
191
192
193
194 #endif // _ShapeConstruct_ProjectCurveOnSurface_HeaderFile