]> SALOME platform Git repositories - modules/geom.git/blob - src/GEOMAlgo/BlockFix_PeriodicSurfaceModifier.cdl
Salome HOME
GDD: Check that the PipeTShape is a block if it is required by user
[modules/geom.git] / src / GEOMAlgo / BlockFix_PeriodicSurfaceModifier.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:       BlockFix_PeriodicSurfaceModifier.cdl
24 --  Created:    Wed Dec 15 10:03:50 2004
25 --  Author:     Sergey KUUL
26 --
27 class PeriodicSurfaceModifier from BlockFix inherits Modification from BRepTools 
28
29         ---Purpose: 
30
31 uses
32     Vertex   from TopoDS, 
33     Edge     from TopoDS,
34     Face     from TopoDS,
35     Location from TopLoc,
36     Shape    from GeomAbs,
37     Pnt      from gp,
38     Curve    from Geom,
39     Curve    from Geom2d,
40     Surface  from Geom,
41     IndexedMapOfTransient from TColStd,
42     DataMapOfShapeInteger from TopTools
43
44 is
45     
46     Create returns mutable PeriodicSurfaceModifier from BlockFix;
47     
48     SetTolerance(me: mutable; Toler: Real);
49         ---Purpose: Sets the tolerance for recognition of geometry
50
51     NewSurface(me: mutable; F  :     Face     from TopoDS;
52                             S  : out Surface  from Geom;
53                             L  : out Location from TopLoc;
54                             Tol: out Real     from Standard;
55                             RevWires : out Boolean from Standard;
56                             RevFace  : out Boolean from Standard)
57     returns Boolean from Standard;
58         ---Purpose: Returns Standard_True if the face <F> has  been
59         --          modified. In this case, <S> is the new geometric
60         --          support of the face, <L> the new location,  <Tol>
61         --          the new tolerance.  Otherwise, returns
62         --          Standard_False, and <S>, <L>, <Tol> are  not
63         --          significant.
64         
65     NewCurve(me: mutable; E  :     Edge     from TopoDS;
66                           C  : out Curve    from Geom;
67                           L  : out Location from TopLoc;
68                           Tol: out Real     from Standard)
69     returns Boolean from Standard;
70         ---Purpose: Returns Standard_True  if  the edge  <E> has  been
71         --          modified.  In this case,  <C> is the new geometric
72         --          support of the  edge, <L> the  new location, <Tol>
73         --          the         new    tolerance.   Otherwise, returns
74         --          Standard_False,    and  <C>,  <L>,   <Tol> are not
75         --          significant.
76
77     NewPoint(me: mutable; V  :     Vertex   from TopoDS;
78                           P  : out Pnt      from gp;
79                           Tol: out Real     from Standard)
80     returns Boolean from Standard;
81         ---Purpose: Returns  Standard_True if the  vertex <V> has been
82         --          modified.  In this  case, <P> is the new geometric
83         --          support of the vertex,   <Tol> the new  tolerance.
84         --          Otherwise, returns Standard_False, and <P>,  <Tol>
85         --          are not significant.
86
87     NewCurve2d(me: mutable; E    :     Edge     from TopoDS;
88                             F    :     Face     from TopoDS;
89                             NewE :     Edge     from TopoDS;
90                             NewF :     Face     from TopoDS;
91                             C    : out Curve    from Geom2d;
92                             Tol  : out Real     from Standard)
93     returns Boolean from Standard;
94         ---Purpose: Returns Standard_True if  the edge  <E> has a  new
95         --          curve on surface on the face <F>.In this case, <C>
96         --          is the new geometric support of  the edge, <L> the
97         --          new location, <Tol> the new tolerance.
98         --          
99         --          Otherwise, returns  Standard_False, and <C>,  <L>,
100         --          <Tol> are not significant.
101         --          
102         --          <NewE> is the new  edge created from  <E>.  <NewF>
103         --          is the new face created from <F>. They may be usefull.
104
105     NewParameter(me: mutable; V  :     Vertex from TopoDS;
106                               E  :     Edge   from TopoDS;
107                               P  : out Real   from Standard;
108                               Tol: out Real   from Standard)
109     returns Boolean from Standard;
110         ---Purpose: Returns Standard_True if the Vertex  <V> has a new
111         --          parameter on the  edge <E>. In  this case,  <P> is
112         --          the parameter,    <Tol>  the     new    tolerance.
113         --          Otherwise, returns Standard_False, and <P>,  <Tol>
114         --          are not significant.
115
116     Continuity(me: mutable; E          : Edge from TopoDS;
117                             F1,F2      : Face from TopoDS;
118                             NewE       : Edge from TopoDS;
119                             NewF1,NewF2: Face from TopoDS)
120     returns Shape from GeomAbs;
121         ---Purpose: Returns the  continuity of  <NewE> between <NewF1>
122         --          and <NewF2>.
123         --          
124         --          <NewE> is the new  edge created from <E>.  <NewF1>
125         --          (resp. <NewF2>) is the new  face created from <F1>
126         --          (resp. <F2>).
127     
128
129 fields 
130     
131     myTolerance    : Real;
132     myMapOfFaces   : DataMapOfShapeInteger from TopTools;
133     myMapOfSurfaces: IndexedMapOfTransient from TColStd;
134
135 end PeriodicSurfaceModifier;