0024750: Replace instantiations of TCollection generic classes by NCollection templat...
[occt.git] / src / ShapeCustom / ShapeCustom_ConvertToRevolution.cdl
CommitLineData
b311480e 1-- Created on: 1999-05-08
2-- Created by: Andrey BETENEV
3-- Copyright (c) 1999 Matra Datavision
973c2be1 4-- Copyright (c) 1999-2014 OPEN CASCADE SAS
b311480e 5--
973c2be1 6-- This file is part of Open CASCADE Technology software library.
b311480e 7--
d5f74e42 8-- This library is free software; you can redistribute it and/or modify it under
9-- the terms of the GNU Lesser General Public License version 2.1 as published
973c2be1 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.
b311480e 13--
973c2be1 14-- Alternatively, this file may be used under the terms of Open CASCADE
15-- commercial license or contractual agreement.
7fd59977 16
da2db6a7 17private class ConvertToRevolution from ShapeCustom inherits Modification from ShapeCustom
7fd59977 18
19 ---Purpose: implements a modification for the BRepTools
20 -- Modifier algortihm. Converts all elementary
21 -- surfaces into surfaces of revolution.
22
23uses
24 Vertex from TopoDS,
25 Edge from TopoDS,
26 Face from TopoDS,
27 Location from TopLoc,
28
29 Shape from GeomAbs,
30
31 Pnt from gp,
32 Curve from Geom,
33 Curve from Geom2d,
34 Surface from Geom
35
36is
37
6e33d3ce 38 Create returns ConvertToRevolution from ShapeCustom;
7fd59977 39
40 NewSurface(me: mutable; F : Face from TopoDS;
41 S : out Surface from Geom;
42 L : out Location from TopLoc;
43 Tol: out Real from Standard;
44 RevWires : out Boolean from Standard;
45 RevFace : out Boolean from Standard)
46 returns Boolean from Standard;
47 ---Purpose: Returns Standard_True if the face <F> has been
48 -- modified. In this case, <S> is the new geometric
49 -- support of the face, <L> the new location, <Tol>
50 -- the new tolerance. Otherwise, returns
51 -- Standard_False, and <S>, <L>, <Tol> are not
52 -- significant.
53
54 NewCurve(me: mutable; E : Edge from TopoDS;
55 C : out Curve from Geom;
56 L : out Location from TopLoc;
57 Tol: out Real from Standard)
58 returns Boolean from Standard;
59 ---Purpose: Returns Standard_True if the edge <E> has been
60 -- modified. In this case, <C> is the new geometric
61 -- support of the edge, <L> the new location, <Tol>
62 -- the new tolerance. Otherwise, returns
63 -- Standard_False, and <C>, <L>, <Tol> are not
64 -- significant.
65
66 NewPoint(me: mutable; V : Vertex from TopoDS;
67 P : out Pnt from gp;
68 Tol: out Real from Standard)
69 returns Boolean from Standard;
70 ---Purpose: Returns Standard_True if the vertex <V> has been
71 -- modified. In this case, <P> is the new geometric
72 -- support of the vertex, <Tol> the new tolerance.
73 -- Otherwise, returns Standard_False, and <P>, <Tol>
74 -- are not significant.
75
76 NewCurve2d(me: mutable; E : Edge from TopoDS;
77 F : Face from TopoDS;
78 NewE : Edge from TopoDS;
79 NewF : Face from TopoDS;
80 C : out Curve from Geom2d;
81 Tol : out Real from Standard)
82 returns Boolean from Standard;
83 ---Purpose: Returns Standard_True if the edge <E> has a new
84 -- curve on surface on the face <F>.In this case, <C>
85 -- is the new geometric support of the edge, <L> the
86 -- new location, <Tol> the new tolerance.
87 --
88 -- Otherwise, returns Standard_False, and <C>, <L>,
89 -- <Tol> are not significant.
90 --
91 -- <NewE> is the new edge created from <E>. <NewF>
92 -- is the new face created from <F>. They may be usefull.
93
94 NewParameter(me: mutable; V : Vertex from TopoDS;
95 E : Edge from TopoDS;
96 P : out Real from Standard;
97 Tol: out Real from Standard)
98 returns Boolean from Standard;
99 ---Purpose: Returns Standard_True if the Vertex <V> has a new
100 -- parameter on the edge <E>. In this case, <P> is
101 -- the parameter, <Tol> the new tolerance.
102 -- Otherwise, returns Standard_False, and <P>, <Tol>
103 -- are not significant.
104
105 Continuity(me: mutable; E : Edge from TopoDS;
106 F1,F2 : Face from TopoDS;
107 NewE : Edge from TopoDS;
108 NewF1,NewF2: Face from TopoDS)
109 returns Shape from GeomAbs;
110 ---Purpose: Returns the continuity of <NewE> between <NewF1>
111 -- and <NewF2>.
112 --
113 -- <NewE> is the new edge created from <E>. <NewF1>
114 -- (resp. <NewF2>) is the new face created from <F1>
115 -- (resp. <F2>).
116
117end ConvertToRevolution;