1dba81867df7b0b15d655e39e2178291c61ccd9d
[occt.git] / src / IntPatch / IntPatch_WLine.hxx
1 // Created on: 1991-05-27
2 // Created by: Isabelle GRIGNON
3 // Copyright (c) 1991-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 _IntPatch_WLine_HeaderFile
18 #define _IntPatch_WLine_HeaderFile
19
20 #include <Standard.hxx>
21 #include <Standard_Type.hxx>
22
23 #include <Standard_Boolean.hxx>
24 #include <Standard_Integer.hxx>
25 #include <IntPatch_SequenceOfPoint.hxx>
26 #include <Bnd_Box2d.hxx>
27 #include <Bnd_Box.hxx>
28 #include <Standard_Real.hxx>
29 #include <IntPatch_PointLine.hxx>
30 #include <IntSurf_TypeTrans.hxx>
31 #include <IntSurf_Situation.hxx>
32 class IntSurf_LineOn2S;
33 class Adaptor2d_HCurve2d;
34 class Standard_OutOfRange;
35 class Standard_DomainError;
36 class IntPatch_Point;
37 class IntSurf_PntOn2S;
38 class gp_Pnt2d;
39 class gp_Pnt;
40
41
42 class IntPatch_WLine;
43 DEFINE_STANDARD_HANDLE(IntPatch_WLine, IntPatch_PointLine)
44
45 //! Definition of set of points as a result of the intersection
46 //! between 2 parametrised patches.
47 class IntPatch_WLine : public IntPatch_PointLine
48 {
49
50 public:
51
52   
53   //! Creates a WLine as an intersection when the
54   //! transitions are In or Out.
55   Standard_EXPORT IntPatch_WLine(const Handle(IntSurf_LineOn2S)& Line, const Standard_Boolean Tang, const IntSurf_TypeTrans Trans1, const IntSurf_TypeTrans Trans2);
56   
57   //! Creates a WLine as an intersection when the
58   //! transitions are Touch.
59   Standard_EXPORT IntPatch_WLine(const Handle(IntSurf_LineOn2S)& Line, const Standard_Boolean Tang, const IntSurf_Situation Situ1, const IntSurf_Situation Situ2);
60   
61   //! Creates a WLine as an intersection when the
62   //! transitions are Undecided.
63   Standard_EXPORT IntPatch_WLine(const Handle(IntSurf_LineOn2S)& Line, const Standard_Boolean Tang);
64   
65   //! Adds a vertex in the list. If theIsPrepend == TRUE the new
66   //! vertex will be added before the first element of vertices sequence.
67   //! Otherwise, to the end of the sequence
68   virtual void AddVertex (const IntPatch_Point& Pnt,
69                     const Standard_Boolean theIsPrepend = Standard_False) Standard_OVERRIDE;
70   
71   //! Set the Point of index <Index> in the LineOn2S
72   Standard_EXPORT void SetPoint (const Standard_Integer Index, const IntPatch_Point& Pnt);
73   
74   //! Replaces the element of range Index in the list
75   //! of points.
76   //! The exception OutOfRange is raised when
77   //! Index <= 0 or Index > NbVertex.
78     void Replace (const Standard_Integer Index, const IntPatch_Point& Pnt);
79   
80     void SetFirstPoint (const Standard_Integer IndFirst);
81   
82     void SetLastPoint (const Standard_Integer IndLast);
83   
84   //! Returns the number of intersection points.
85   virtual Standard_Integer NbPnts() const Standard_OVERRIDE;
86   
87   //! Returns the intersection point of range Index.
88   virtual const IntSurf_PntOn2S& Point (const Standard_Integer Index) const Standard_OVERRIDE;
89   
90   //! Returns True if the line has a known First point.
91   //! This point is given by the method FirstPoint().
92     Standard_Boolean HasFirstPoint() const;
93   
94   //! Returns True if the line has a known Last point.
95   //! This point is given by the method LastPoint().
96     Standard_Boolean HasLastPoint() const;
97   
98   //! Returns the Point corresponding to the FirstPoint.
99     const IntPatch_Point& FirstPoint() const;
100   
101   //! Returns the Point corresponding to the LastPoint.
102     const IntPatch_Point& LastPoint() const;
103   
104   //! Returns the Point corresponding to the FirstPoint.
105   //! Indfirst is the index of the first in the list
106   //! of vertices.
107     const IntPatch_Point& FirstPoint (Standard_Integer& Indfirst) const;
108   
109   //! Returns the Point corresponding to the LastPoint.
110   //! Indlast is the index of the last in the list
111   //! of vertices.
112     const IntPatch_Point& LastPoint (Standard_Integer& Indlast) const;
113   
114   //! Returns number of vertices (IntPatch_Point) of the line
115   virtual Standard_Integer NbVertex() const Standard_OVERRIDE;
116   
117   //! Returns the vertex of range Index on the line.
118   virtual const IntPatch_Point& Vertex (const Standard_Integer Index) const Standard_OVERRIDE;
119
120   //! Returns the vertex of range Index on the line.
121   virtual IntPatch_Point& ChangeVertex (const Standard_Integer Index) Standard_OVERRIDE;
122   
123   //! Set the parameters of all the vertex on the line.
124   //! if a vertex is already in the line,
125   //! its parameter is modified
126   //! else a new point in the line is inserted.
127   Standard_EXPORT void ComputeVertexParameters (const Standard_Real Tol, const Standard_Boolean hasBeenAdded = Standard_False);
128   
129   //! Returns set of intersection points
130   Standard_EXPORT virtual Handle(IntSurf_LineOn2S) Curve() const Standard_OVERRIDE;
131   
132   Standard_EXPORT Standard_Boolean IsOutSurf1Box (const gp_Pnt2d& P1);
133   
134   Standard_EXPORT Standard_Boolean IsOutSurf2Box (const gp_Pnt2d& P1);
135   
136   Standard_EXPORT Standard_Boolean IsOutBox (const gp_Pnt& P);
137   
138   Standard_EXPORT void SetPeriod (const Standard_Real pu1, const Standard_Real pv1, const Standard_Real pu2, const Standard_Real pv2);
139   
140   Standard_EXPORT Standard_Real U1Period() const;
141   
142   Standard_EXPORT Standard_Real V1Period() const;
143   
144   Standard_EXPORT Standard_Real U2Period() const;
145   
146   Standard_EXPORT Standard_Real V2Period() const;
147   
148   Standard_EXPORT void SetArcOnS1 (const Handle(Adaptor2d_HCurve2d)& A);
149   
150   Standard_EXPORT Standard_Boolean HasArcOnS1() const;
151   
152   Standard_EXPORT const Handle(Adaptor2d_HCurve2d)& GetArcOnS1() const;
153   
154   Standard_EXPORT void SetArcOnS2 (const Handle(Adaptor2d_HCurve2d)& A);
155   
156   Standard_EXPORT Standard_Boolean HasArcOnS2() const;
157   
158   Standard_EXPORT const Handle(Adaptor2d_HCurve2d)& GetArcOnS2() const;
159   
160   //! Removes vertices from the line (i.e. cleans svtx member)
161   virtual void ClearVertexes() Standard_OVERRIDE;
162   
163   //! Removes single vertex from the line
164   virtual void RemoveVertex (const Standard_Integer theIndex) Standard_OVERRIDE;
165   
166   Standard_EXPORT void InsertVertexBefore (const Standard_Integer theIndex, const IntPatch_Point& thePnt);
167   
168   //! if (theMode == 0) then prints the information about WLine
169   //! if (theMode == 1) then prints the list of 3d-points
170   //! if (theMode == 2) then prints the list of 2d-points on the 1st surface
171   //! Otherwise,             prints list of 2d-points on the 2nd surface
172   Standard_EXPORT void Dump(const Standard_Integer theMode) const;
173
174   //! Allows or forbides purging of existing WLine
175   void EnablePurging(const Standard_Boolean theIsEnabled)
176   {
177     myIsPurgerAllowed = theIsEnabled;
178   }
179
180   //! Returns TRUE if purging is allowed or forbiden for existing WLine
181   Standard_Boolean IsPurgingAllowed()
182   {
183     return myIsPurgerAllowed;
184   }
185
186
187   DEFINE_STANDARD_RTTIEXT(IntPatch_WLine,IntPatch_PointLine)
188
189 protected:
190
191
192
193
194 private:
195
196
197   Handle(IntSurf_LineOn2S) curv;
198   Standard_Boolean fipt;
199   Standard_Boolean lapt;
200   Standard_Integer indf;
201   Standard_Integer indl;
202   IntPatch_SequenceOfPoint svtx;
203   Bnd_Box2d Buv1;
204   Bnd_Box2d Buv2;
205   Bnd_Box Bxyz;
206   Standard_Real u1period;
207   Standard_Real v1period;
208   Standard_Real u2period;
209   Standard_Real v2period;
210   Standard_Boolean hasArcOnS1;
211   Handle(Adaptor2d_HCurve2d) theArcOnS1;
212   Standard_Boolean hasArcOnS2;
213   Handle(Adaptor2d_HCurve2d) theArcOnS2;
214   Standard_Boolean myIsPurgerAllowed;
215
216
217 };
218
219
220 #include <IntPatch_WLine.lxx>
221
222
223
224
225
226 #endif // _IntPatch_WLine_HeaderFile