0030940: BRepFilletAPI_MakeFillet algorithm fails on closed shell
[occt.git] / src / ChFiDS / ChFiDS_Spine.hxx
1 // Created on: 1993-11-09
2 // Created by: Laurent BOURESCHE
3 // Copyright (c) 1993-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 _ChFiDS_Spine_HeaderFile
18 #define _ChFiDS_Spine_HeaderFile
19
20 #include <Standard.hxx>
21 #include <Standard_Type.hxx>
22
23 #include <BRepAdaptor_Curve.hxx>
24 #include <Standard_Integer.hxx>
25 #include <ChFiDS_State.hxx>
26 #include <TopTools_SequenceOfShape.hxx>
27 #include <TColStd_HArray1OfReal.hxx>
28 #include <Standard_Boolean.hxx>
29 #include <ChFiDS_ListOfHElSpine.hxx>
30 #include <Standard_Real.hxx>
31 #include <gp_Pnt.hxx>
32 #include <gp_Vec.hxx>
33 #include <ChFiDS_ErrorStatus.hxx>
34 #include <Standard_Transient.hxx>
35 #include <GeomAbs_CurveType.hxx>
36 #include <ChFiDS_ChamfMode.hxx>
37 #include <ChFiDS_TypeOfConcavity.hxx>
38 class TopoDS_Edge;
39 class ChFiDS_HElSpine;
40 class gp_Lin;
41 class gp_Circ;
42 class TopoDS_Vertex;
43
44 // resolve name collisions with X11 headers
45 #ifdef Status
46   #undef Status
47 #endif
48
49 class ChFiDS_Spine;
50 DEFINE_STANDARD_HANDLE(ChFiDS_Spine, Standard_Transient)
51
52 //! Contains information necessary for construction of
53 //! a 3D fillet or chamfer:
54 //!
55 //! - guideline composed of edges of the solid, tangents
56 //! between them, and borders by faces tangents
57 //! between them.
58 //!
59 //! Tools for construction of the Sp
60 //! by propagation from an edge of solid
61 //! are provided in the Builder of Fil3d.
62 //!
63 //! The Spine contains among others the
64 //! information about the nature of extremities
65 //! of the fillet ( on free border , on section or closed ).
66 //!
67 //! IMPORTANT NOTE  :    the guideline
68 //! represented in this way is not C2, although the path
69 //! claims it. Several palliative workarounds
70 //! (see the methods at the end) are planned,
71 //! but they are not enough. It is necessary to change
72 //! the approach and double the Spine of line C2 with
73 //! the known consequences for management of
74 //! interactions between KPart Blend in Fil3d.
75 class ChFiDS_Spine : public Standard_Transient
76 {
77
78 public:
79
80   
81   Standard_EXPORT ChFiDS_Spine();
82   
83   Standard_EXPORT ChFiDS_Spine(const Standard_Real Tol);
84   
85   //! store edges composing the guideline
86     void SetEdges (const TopoDS_Edge& E);
87   
88   //! store offset edges composing the offset guideline
89     void SetOffsetEdges (const TopoDS_Edge& E);
90   
91   //! store the edge at the first position before all others
92     void PutInFirst (const TopoDS_Edge& E);
93   
94   //! store the offset edge at the first position before all others
95     void PutInFirstOffset (const TopoDS_Edge& E);
96   
97     Standard_Integer NbEdges() const;
98   
99     const TopoDS_Edge& Edges (const Standard_Integer I) const;
100   
101     const TopoDS_Edge& OffsetEdges (const Standard_Integer I) const;
102   
103   //! stores if the start of a set of edges starts on a
104   //! section of free border or forms  a closed contour
105     void SetFirstStatus (const ChFiDS_State S);
106   
107   //! stores if the end of a set of edges starts on a
108   //! section of free border or forms  a closed contour
109     void SetLastStatus (const ChFiDS_State S);
110   
111   Standard_EXPORT virtual void AppendElSpine (const Handle(ChFiDS_HElSpine)& Els);
112   
113   Standard_EXPORT virtual void AppendOffsetElSpine (const Handle(ChFiDS_HElSpine)& Els);
114   
115   Standard_EXPORT Handle(ChFiDS_HElSpine) ElSpine (const Standard_Integer IE) const;
116   
117   Standard_EXPORT Handle(ChFiDS_HElSpine) ElSpine (const TopoDS_Edge& E) const;
118   
119   Standard_EXPORT Handle(ChFiDS_HElSpine) ElSpine (const Standard_Real W) const;
120   
121   Standard_EXPORT ChFiDS_ListOfHElSpine& ChangeElSpines();
122   
123   Standard_EXPORT ChFiDS_ListOfHElSpine& ChangeOffsetElSpines();
124   
125   Standard_EXPORT virtual void Reset (const Standard_Boolean AllData = Standard_False);
126   
127   Standard_EXPORT Standard_Boolean SplitDone() const;
128   
129   Standard_EXPORT void SplitDone (const Standard_Boolean B);
130   
131   //! prepare the guideline depending on the edges that
132   //! are elementary arks (take parameters from
133   //! a single curvilinear abscissa); to be able to call
134   //! methods on the geometry (first,last,value,d1,d2)
135   //! it is necessary to start with preparation otherwise an
136   //! exception will be raised
137   Standard_EXPORT void Load();
138   
139   Standard_EXPORT Standard_Real Resolution (const Standard_Real R3d) const;
140   
141   Standard_EXPORT Standard_Boolean IsClosed() const;
142   
143   Standard_EXPORT Standard_Real FirstParameter() const;
144   
145   Standard_EXPORT Standard_Real LastParameter() const;
146   
147   Standard_EXPORT void SetFirstParameter (const Standard_Real Par);
148   
149   Standard_EXPORT void SetLastParameter (const Standard_Real Par);
150   
151   //! gives the total length of all arcs before the
152   //! number IndexSp
153   Standard_EXPORT Standard_Real FirstParameter (const Standard_Integer IndexSpine) const;
154   
155   //! gives the total length till the ark with number
156   //! IndexSpine (inclus)
157   Standard_EXPORT Standard_Real LastParameter (const Standard_Integer IndexSpine) const;
158   
159   //! gives the length of ark with number IndexSp
160   Standard_EXPORT Standard_Real Length (const Standard_Integer IndexSpine) const;
161   
162   Standard_EXPORT Standard_Boolean IsPeriodic() const;
163   
164   Standard_EXPORT Standard_Real Period() const;
165   
166   Standard_EXPORT Standard_Real Absc (const Standard_Real U);
167   
168   Standard_EXPORT Standard_Real Absc (const Standard_Real U, const Standard_Integer I);
169   
170   Standard_EXPORT void Parameter (const Standard_Real AbsC, Standard_Real& U, const Standard_Boolean Oriented = Standard_True);
171   
172   Standard_EXPORT void Parameter (const Standard_Integer Index, const Standard_Real AbsC, Standard_Real& U, const Standard_Boolean Oriented = Standard_True);
173   
174   Standard_EXPORT gp_Pnt Value (const Standard_Real AbsC);
175   
176   Standard_EXPORT void D0 (const Standard_Real AbsC, gp_Pnt& P);
177   
178   Standard_EXPORT void D1 (const Standard_Real AbsC, gp_Pnt& P, gp_Vec& V1);
179   
180   Standard_EXPORT void D2 (const Standard_Real AbsC, gp_Pnt& P, gp_Vec& V1, gp_Vec& V2);
181   
182   Standard_EXPORT void SetCurrent (const Standard_Integer Index);
183   
184   //! sets the current curve and returns it
185   Standard_EXPORT const BRepAdaptor_Curve& CurrentElementarySpine (const Standard_Integer Index);
186   
187     Standard_Integer CurrentIndexOfElementarySpine() const;
188   
189   Standard_EXPORT GeomAbs_CurveType GetType() const;
190   
191   Standard_EXPORT gp_Lin Line() const;
192   
193   Standard_EXPORT gp_Circ Circle() const;
194   
195   //! returns if the set of edges starts on a free boundary
196   //! or if the first vertex is a breakpoint or if the set is
197   //! closed
198     ChFiDS_State FirstStatus() const;
199   
200   //! returns the state at the end of the set
201     ChFiDS_State LastStatus() const;
202   
203     ChFiDS_State Status (const Standard_Boolean IsFirst) const;
204   
205   //! returns the type of concavity in the connection
206     ChFiDS_TypeOfConcavity GetTypeOfConcavity() const;
207   
208     void SetStatus (const ChFiDS_State S, const Standard_Boolean IsFirst);
209   
210   //! sets the type of concavity in the connection
211     void SetTypeOfConcavity (const ChFiDS_TypeOfConcavity theType);
212   
213   //! returns   if the  set  of  edges starts (or   end) on
214   //! Tangency point.
215     Standard_Boolean IsTangencyExtremity (const Standard_Boolean IsFirst) const;
216   
217     void SetTangencyExtremity (const Standard_Boolean IsTangency, const Standard_Boolean IsFirst);
218   
219   Standard_EXPORT Standard_Real Absc (const TopoDS_Vertex& V) const;
220   
221   Standard_EXPORT TopoDS_Vertex FirstVertex() const;
222   
223   Standard_EXPORT TopoDS_Vertex LastVertex() const;
224   
225   Standard_EXPORT void SetFirstTgt (const Standard_Real W);
226   
227   Standard_EXPORT void SetLastTgt (const Standard_Real W);
228   
229   Standard_EXPORT Standard_Boolean HasFirstTgt() const;
230   
231   Standard_EXPORT Standard_Boolean HasLastTgt() const;
232   
233   //! set a parameter reference for the approx.
234   Standard_EXPORT void SetReference (const Standard_Real W);
235   
236   //! set  a  parameter  reference  for  the approx,  at the
237   //! middle  of edge I.
238   Standard_EXPORT void SetReference (const Standard_Integer I);
239   
240   Standard_EXPORT Standard_Integer Index (const Standard_Real W, const Standard_Boolean Forward = Standard_True) const;
241   
242   Standard_EXPORT Standard_Integer Index (const TopoDS_Edge& E) const;
243   
244   Standard_EXPORT void UnsetReference();
245   
246   Standard_EXPORT void SetErrorStatus (const ChFiDS_ErrorStatus state);
247   
248   Standard_EXPORT ChFiDS_ErrorStatus ErrorStatus() const;
249
250   //! Return the mode of chamfers used
251   Standard_EXPORT ChFiDS_ChamfMode Mode() const;
252
253
254
255   DEFINE_STANDARD_RTTIEXT(ChFiDS_Spine,Standard_Transient)
256
257 protected:
258
259
260   Standard_Boolean splitdone;
261   ChFiDS_ListOfHElSpine elspines;
262   ChFiDS_ListOfHElSpine offset_elspines;
263   ChFiDS_ChamfMode   myMode;
264
265
266 private:
267
268   
269   Standard_EXPORT void Prepare (Standard_Real& L, Standard_Integer& Index) const;
270
271   BRepAdaptor_Curve myCurve;
272   BRepAdaptor_Curve myOffsetCurve;
273   Standard_Integer indexofcurve;
274   ChFiDS_TypeOfConcavity myTypeOfConcavity;
275   ChFiDS_State firstState;
276   ChFiDS_State lastState;
277   TopTools_SequenceOfShape spine;
278   TopTools_SequenceOfShape offsetspine;
279   Handle(TColStd_HArray1OfReal) abscissa;
280   Handle(TColStd_HArray1OfReal) offset_abscissa;
281   Standard_Real tolesp;
282   Standard_Real firstparam;
283   Standard_Real lastparam;
284   Standard_Boolean firstprolon;
285   Standard_Boolean lastprolon;
286   Standard_Boolean firstistgt;
287   Standard_Boolean lastistgt;
288   Standard_Real firsttgtpar;
289   Standard_Real lasttgtpar;
290   Standard_Boolean hasfirsttgt;
291   Standard_Boolean haslasttgt;
292   gp_Pnt firstori;
293   gp_Pnt lastori;
294   gp_Vec firsttgt;
295   gp_Vec lasttgt;
296   Standard_Real valref;
297   Standard_Boolean hasref;
298   ChFiDS_ErrorStatus errorstate;
299
300
301 };
302
303
304 #include <ChFiDS_Spine.lxx>
305
306
307
308
309
310 #endif // _ChFiDS_Spine_HeaderFile