Salome HOME
33e90df74b14693c24fc98c668eb32d1487f218c
[modules/geom.git] / src / PARTITION / Partition_Loop3d.cdl
1 --  Copyright (C) 2007-2008  CEA/DEN, EDF R&D, OPEN CASCADE
2 --
3 --  Copyright (C) 2003-2007  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
4 --  CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
5 --
6 --  This library is free software; you can redistribute it and/or
7 --  modify it under the terms of the GNU Lesser General Public
8 --  License as published by the Free Software Foundation; either
9 --  version 2.1 of the License.
10 --
11 --  This library is distributed in the hope that it will be useful,
12 --  but WITHOUT ANY WARRANTY; without even the implied warranty of
13 --  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14 --  Lesser General Public License for more details.
15 --
16 --  You should have received a copy of the GNU Lesser General Public
17 --  License along with this library; if not, write to the Free Software
18 --  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
19 --
20 --  See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
21 --
22 --  File   : Partition_Loop3d.cdl
23 --  Module : GEOM
24
25 class Loop3d from Partition
26
27         ---Purpose: Builds the shells from a set of faces.
28         --          Provides  methods   for   comparing  faces  mutual
29         --          location.
30         
31 uses
32     Vec                              from gp,
33     MapOfOrientedShape               from TopTools,
34     IndexedDataMapOfShapeListOfShape from TopTools,
35     Face                             from TopoDS,
36     Edge                             from TopoDS,
37     ListOfShape                      from TopTools,
38     Shape                            from TopoDS
39     
40 is
41
42     Create;
43     
44     AddConstFaces  (me : in out; S : Shape from TopoDS)
45         ---Purpose: Add faces of <S> as unique faces in the result.
46     is static;
47
48     AddSectionFaces  (me : in out; S : Shape from TopoDS)
49         ---Purpose: Add faces of <S> as double faces in the result.
50     is static;
51
52     MakeShells (me : in out; AvoidFacesMap : MapOfOrientedShape from TopTools)
53         returns ListOfShape from TopTools is static;
54         ---Purpose: Make and return shells. 
55         --          <AvoidFacesMap> can contain faces that must not be
56         --          added to result shells.
57         ---C++: return const &
58     
59     
60         ---Category: class methods
61     
62     IsInside (myclass; E        : Edge    from TopoDS;
63                        F1, F2   : Face    from TopoDS;
64                        CountDot : Boolean from Standard;
65                        Dot      : in out Real    from Standard;
66                        GoodOri  : in out Boolean from Standard)
67         returns Boolean from Standard;
68         ---Purpose: check if <F2> is inside <F1> by edge <E>.
69         --          if <CountDot>, compute <Dot>: scalar production of
70         --          normalized  vectors  pointing  inside  faces,  and
71         --          check if faces are oriented well for sewing
72     
73     Normal (myclass; E : Edge from TopoDS;
74                      F : Face from TopoDS) returns Vec from gp;
75     
76     
77 fields
78
79     myNewShells : ListOfShape from TopTools; -- result
80     
81     myFaces     : ListOfShape from TopTools;
82     myEFMap     : IndexedDataMapOfShapeListOfShape from TopTools;
83     
84 end Loop3d;