57a14e6f93cffcbcdc87d7f71c10ec14f8f5853f
[occt.git] / src / IntPoly / IntPoly_ShapeSection.cdl
1 -- Created on: 1995-08-01
2 -- Created by: Stagiaire Alain JOURDAIN
3 -- Copyright (c) 1995-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
9 -- under the terms of the GNU Lesser General Public 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 class ShapeSection from IntPoly
18
19   ---Purpose: determines the section between 2 triangulated shapes.
20   --          The section is a set of edges.
21
22 uses  Real                    from Standard,
23       Integer                 from Standard,
24       Boolean                 from Standard,
25       Shape                   from TopoDS,
26       Edge                    from TopoDS,
27       Vec                     from gp,
28       Pnt                     from gp,
29       SequenceOfPnt           from TColgp,
30       SequenceOfSequenceOfPnt from IntPoly,
31       IndexedMapOfPnt         from IntPoly,
32       PntHasher               from IntPoly
33
34 is    Create
35       returns ShapeSection from IntPoly;
36       
37       Create (S1 : Shape from TopoDS;
38               S2 : Shape from TopoDS)
39       returns ShapeSection from IntPoly;
40       
41       Section (me : in out)
42       is static;
43       
44       Explore (me : in out)
45       is static;
46       
47       Intersect (me : in out; S1,S2,S3      :        Pnt  from gp;
48                               OS1,VS0,V1,V2 :        Vec  from gp;
49                               h1,h2,ah1,ah2 : in out Real from Standard)
50       ---Purpose: determines if it exists, the intersection point between 
51       --          the (S1,S2,S3) triangle and the edge pointed by V1 and V2.
52       --          Returns True if the triangle-triangle section is found.
53       returns Boolean from Standard;
54       
55       IsEqual (me : in out; Pt1,Pt2 : Pnt from gp)
56       returns Boolean from Standard;                        
57
58        IsInside (me : in out; P,P1,P2,P3 : Pnt from gp;
59                               N0         : Vec from gp)
60       ---Purpose: returns True if P is inside the (P1,P2,P3) triangle
61       --          N0 = P1P2 ^ P1P3
62       returns Boolean from Standard;                        
63
64       InsertInMap (me : in out)
65       ---Purpose: adds if necessary, myBegPoint in myMapBegPoint 
66       --          and myEndPoint in  myMapEndPoint. 
67       is static;
68
69       Insert (me : in out; OldPnt : Pnt from gp;
70                            ComPnt : Pnt from gp;
71                            NewPnt : Pnt from gp)
72       ---Purpose: sees whether OldPnt and NewPnt begins or ends a section
73       --          created before and adds the 2 others points.
74       --          If not, creates a section
75       is static;
76       
77       Concat (me : in out; BegPnt :     Pnt from gp;
78                            EndPnt :     Pnt from gp;
79                            OutPnt : out Pnt from gp)
80       ---Purpose: sees whether BegPnt or EndPnt begins or ends a section
81       --          created before, and returns the other point to continue 
82       --          the construction
83       --          Returns 2 if the construction is 'Forward'
84       --          Returns 1 if the construction is 'Previous'
85       --          Returns 0 if not and creates a section
86       returns Integer from Standard;
87       
88       ConcatSection (me : in out; Section   : in out SequenceOfPnt from TColgp; 
89                                   NbSection :        Integer       from Standard;
90                                   Index     :        Integer       from Standard)
91       ---Purpose: sees whether Section begins or ends another one in  mySection,
92       --          from the rank 'Index' to the last one 'NbSection'
93       is static;
94       
95       ForwConstruction (me : in out; Point : Pnt from gp)
96       ---Purpose: builds a section from Point in this way  
97       --                       ___   ___   ___   ___
98       --               Point--/__/--/__/--/__/--/__/--->
99       is static;
100
101       PrevConstruction (me : in out; Point : Pnt from gp)
102       ---Purpose: builds a section from Point in this way  
103       --                    ___   ___   ___   ___
104       --               <---/__/--/__/--/__/--/__/--Point
105        is static;
106
107       NbEdges (me : in out)
108       returns Integer from Standard;
109       
110       Edge (me : in out; Index : Integer from Standard)
111       ---Purpose: builds an edge from a sequence of Pnt
112       --          this is a part of the whole section
113       returns Edge from TopoDS;
114
115
116 fields
117       myShape1       : Shape                   from TopoDS;
118       myShape2       : Shape                   from TopoDS;
119       mySection      : SequenceOfSequenceOfPnt from IntPoly;
120       myMapBegPoints : IndexedMapOfPnt         from IntPoly;
121       myMapEndPoints : IndexedMapOfPnt         from IntPoly;
122       myBegPoint     : Pnt                     from gp;
123       myEndPoint     : Pnt                     from gp;
124       myFirstTime    : Boolean                 from Standard;
125       myCpt          : Integer                 from Standard;
126       myIndex        : Integer                 from Standard;
127       myNbEdges      : Integer                 from Standard;
128
129 end ShapeSection;
130