Salome HOME
Merge from V5_1_main 14/05/2010
[modules/geom.git] / src / GEOMAlgo / GEOMAlgo_Tools.cdl
1 --  Copyright (C) 2007-2010  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
23 -- File:        GEOMAlgo_Tools.cdl
24 -- Created:     Mon Dec  6 11:26:02 2004
25 -- Author:      Peter KURNEV
26 --
27 class Tools from GEOMAlgo 
28
29         ---Purpose: 
30
31 uses    
32     Pnt from gp, 
33     Surface from Geom, 
34     ShapeEnum from TopAbs,  
35     Edge  from TopoDS, 
36     Face  from TopoDS, 
37     Shape from TopoDS,
38     ListOfShape from TopTools,  
39     IndexedDataMapOfShapeListOfShape from TopTools,
40     Context from IntTools, 
41     IndexedDataMapOfPassKeyShapeListOfShape from GEOMAlgo  --qft 
42     
43 --raises
44
45 is   
46     IsCompositeShape(myclass;  
47             aS  :Shape from TopoDS) 
48         returns Boolean from Standard;    
49
50     RefineSDShapes(myclass; 
51             aMSD:out IndexedDataMapOfPassKeyShapeListOfShape from GEOMAlgo; --qft
52             aTol:Real from Standard; 
53             aCtx:out Context from IntTools) 
54         returns Integer from Standard;
55
56     FindSDShapes(myclass; 
57             aLE :ListOfShape from TopTools;   
58             aTol:Real from Standard; 
59             aMEE:out IndexedDataMapOfShapeListOfShape from TopTools; 
60             aCtx:out Context from IntTools) 
61         returns Integer from Standard;
62      
63     FindSDShapes(myclass; 
64             aE1   :Shape from TopoDS; 
65             aLE   :ListOfShape from TopTools; 
66             aTol  :Real from Standard;   
67             aLESD :out ListOfShape from TopTools;
68             aCtx  :out Context from IntTools) 
69         returns Integer from Standard;  
70          
71     ProjectPointOnShape(myclass;  
72             aP1: Pnt from gp;  
73             aS  :Shape from TopoDS;  
74             aP2:out Pnt from gp; 
75             aCtx  :out Context from IntTools) 
76         returns Boolean from Standard;  
77   
78     PointOnShape(myclass;  
79             aS  :Shape from TopoDS; 
80             aP3D:out Pnt from gp); 
81              
82     PointOnEdge(myclass;  
83             aE  :Edge from TopoDS; 
84             aP3D:out Pnt from gp); 
85              
86     PointOnEdge(myclass;  
87             aE  :Edge from TopoDS; 
88             aT  :Real from Standard;   
89             aP3D:out Pnt from gp); 
90
91     PointOnFace(myclass;  
92             aF  :Face from TopoDS; 
93             aP3D:out Pnt from gp); 
94      
95     PointOnFace(myclass;  
96             aF  :Face from TopoDS; 
97             aU  :Real from Standard; 
98             aV  :Real from Standard; 
99             aP3D:out Pnt from gp);     
100
101     RefinePCurveForEdgeOnFace  (myclass; 
102             aE  :  Edge from TopoDS; 
103             aF  :  Face from TopoDS; 
104             aU1 : Real from Standard; 
105             aU2 : Real from Standard); 
106
107     IsUPeriodic(myclass;  
108             aS:Surface from Geom) 
109         returns Boolean from Standard;   
110
111 --fields
112
113 end Tools;