Salome HOME
Join modifications from BR_Dev_For_4_0 tag V4_1_1.
[modules/geom.git] / src / GEOMAlgo / GEOMAlgo_Tools.cdl
1 -- Copyright (C) 2005  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
2 -- CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
3 -- 
4 -- This library is free software; you can redistribute it and/or
5 -- modify it under the terms of the GNU Lesser General Public
6 -- License as published by the Free Software Foundation; either 
7 -- version 2.1 of the License.
8 -- 
9 -- This library is distributed in the hope that it will be useful 
10 -- but WITHOUT ANY WARRANTY; without even the implied warranty of 
11 -- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU 
12 -- Lesser General Public License for more details.
13 --
14 -- You should have received a copy of the GNU Lesser General Public  
15 -- License along with this library; if not, write to the Free Software 
16 -- Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
17 --
18 -- See http:--www.salome-platform.org/ or email : webmaster.salome@opencascade.com
19 --
20 -- File:        GEOMAlgo_Tools.cdl
21 -- Created:     Mon Dec  6 11:26:02 2004
22 -- Author:      Peter KURNEV
23 --              <pkv@irinox>
24
25
26 class Tools from GEOMAlgo 
27
28         ---Purpose: 
29
30 uses    
31     Pnt from gp, 
32     Surface from Geom, 
33     ShapeEnum from TopAbs,  
34     Edge  from TopoDS, 
35     Face  from TopoDS, 
36     Shape from TopoDS,
37     ListOfShape from TopTools,  
38     IndexedDataMapOfShapeListOfShape from TopTools,
39     Context from IntTools, 
40     IndexedDataMapOfPassKeyShapeListOfShape from GEOMAlgo  --qft 
41     
42 --raises
43
44 is   
45     IsCompositeShape(myclass;  
46             aS  :Shape from TopoDS) 
47         returns Boolean from Standard;    
48
49     RefineSDShapes(myclass; 
50             aMSD:out IndexedDataMapOfPassKeyShapeListOfShape from GEOMAlgo; --qft
51             aTol:Real from Standard; 
52             aCtx:out Context from IntTools) 
53         returns Integer from Standard;
54
55     FindSDShapes(myclass; 
56             aLE :ListOfShape from TopTools;   
57             aTol:Real from Standard; 
58             aMEE:out IndexedDataMapOfShapeListOfShape from TopTools; 
59             aCtx:out Context from IntTools) 
60         returns Integer from Standard;
61      
62     FindSDShapes(myclass; 
63             aE1   :Shape from TopoDS; 
64             aLE   :ListOfShape from TopTools; 
65             aTol  :Real from Standard;   
66             aLESD :out ListOfShape from TopTools;
67             aCtx  :out Context from IntTools) 
68         returns Integer from Standard;  
69          
70     ProjectPointOnShape(myclass;  
71             aP1: Pnt from gp;  
72             aS  :Shape from TopoDS;  
73             aP2:out Pnt from gp; 
74             aCtx  :out Context from IntTools) 
75         returns Boolean from Standard;  
76   
77     PointOnShape(myclass;  
78             aS  :Shape from TopoDS; 
79             aP3D:out Pnt from gp); 
80              
81     PointOnEdge(myclass;  
82             aE  :Edge from TopoDS; 
83             aP3D:out Pnt from gp); 
84              
85     PointOnEdge(myclass;  
86             aE  :Edge from TopoDS; 
87             aT  :Real from Standard;   
88             aP3D:out Pnt from gp); 
89
90     PointOnFace(myclass;  
91             aF  :Face from TopoDS; 
92             aP3D:out Pnt from gp); 
93      
94     PointOnFace(myclass;  
95             aF  :Face from TopoDS; 
96             aU  :Real from Standard; 
97             aV  :Real from Standard; 
98             aP3D:out Pnt from gp);     
99
100     RefinePCurveForEdgeOnFace  (myclass; 
101             aE  :  Edge from TopoDS; 
102             aF  :  Face from TopoDS; 
103             aU1 : Real from Standard; 
104             aU2 : Real from Standard); 
105
106     IsUPeriodic(myclass;  
107             aS:Surface from Geom) 
108         returns Boolean from Standard;   
109
110 --fields
111
112 end Tools;