0023024: Update headers of OCCT files
[occt.git] / src / BRepFeat / BRepFeat_MakeRevolutionForm.cdl
CommitLineData
b311480e 1-- Created on: 1997-10-14
2-- Created by: Olga KOULECHOVA
3-- Copyright (c) 1997-1999 Matra Datavision
4-- Copyright (c) 1999-2012 OPEN CASCADE SAS
5--
6-- The content of this file is subject to the Open CASCADE Technology Public
7-- License Version 6.5 (the "License"). You may not use the content of this file
8-- except in compliance with the License. Please obtain a copy of the License
9-- at http://www.opencascade.org and read it completely before using this file.
10--
11-- The Initial Developer of the Original Code is Open CASCADE S.A.S., having its
12-- main offices at: 1, place des Freres Montgolfier, 78280 Guyancourt, France.
13--
14-- The Original Code and all software distributed under the License is
15-- distributed on an "AS IS" basis, without warranty of any kind, and the
16-- Initial Developer hereby disclaims all such warranties, including without
17-- limitation, any warranties of merchantability, fitness for a particular
18-- purpose or non-infringement. Please see the License for the specific terms
19-- and conditions governing the rights and limitations under the License.
20
7fd59977 21
22
23class MakeRevolutionForm from BRepFeat inherits RibSlot from BRepFeat
24
25 ---Purpose: MakeRevolutionForm Generates a surface of
26 -- revolution in the feature as it slides along a
27 -- revolved face in the basis shape.
28 -- The semantics of mechanical features is built
29 -- around giving thickness to a contour. This
30 -- thickness can either be unilateral - on one side
31 -- of the contour - or bilateral - on both sides. As
32 -- in the semantics of form features, the thickness
33 -- is defined by construction of shapes in specific contexts.
34 -- The development contexts differ, however,in
35 -- case of mechanical features. Here they include extrusion:
36 -- - to a limiting face of the basis shape
37 -- - to or from a limiting plane
38 -- - to a height.
39
40uses Shape from TopoDS,
41 Face from TopoDS,
42 Wire from TopoDS,
43 Edge from TopoDS,
44 DataMapOfShapeListOfShape from TopTools,
45 Dir from gp,
46 Ax1 from gp,
47 Vec from gp,
48 DataMapOfShapeShape from TopTools,
49 ListOfShape from TopTools,
50 SequenceOfCurve from TColGeom,
51 Curve from Geom,
52 Plane from Geom,
53 Pnt from gp,
54 StatusError from BRepFeat
55
56raises ConstructionError from Standard
57
58is
59
60
61 Create
62
63 returns MakeRevolutionForm from BRepFeat;
64 ---Purpose: initializes the linear form class.
65 ---C++: inline
66
67 Create(Sbase : Shape from TopoDS;
68 W : Wire from TopoDS;
69 Plane : Plane from Geom;
70 Axis : Ax1 from gp;
71 Height1 : Real from Standard;
72 Height2 : Real from Standard;
73 Fuse : Integer from Standard;
74 Sliding : in out Boolean from Standard)
75
76 ---Purpose: a contour W, a shape Sbase and a plane P are initialized to serve as
77 -- the basic elements in the construction of the rib or groove. The axis Axis of the
78 -- revolved surface in the basis shape defines the feature's axis of revolution.
79 -- Height1 and Height2 may be used as limits to the construction of the feature.
80 -- Fuse offers a choice between:
81 -- - removing matter with a Boolean cut using the setting 0 in case of the groove
82 -- - adding matter with Boolean fusion using the setting 1 in case of the rib.
83 ---C++: inline
84 returns MakeRevolutionForm from BRepFeat;
85
86
87 Init(me: in out; Sbase : Shape from TopoDS;
88 W : Wire from TopoDS;
89 Plane : Plane from Geom;
90 Axis : Ax1 from gp;
91 Height1 : Real from Standard;
92 Height2 : Real from Standard;
93 Fuse : Integer from Standard;
94 Sliding : in out Boolean from Standard)
95
96 is static;
97 ---Purpose: Initializes this construction algorithm
98 -- A contour W, a shape Sbase and a plane P are initialized to serve as the basic elements
99 -- in the construction of the rib or groove. The axis Axis of the revolved surface in the basis
100 -- shape defines the feature's axis of revolution. Height1 and Height2 may be
101 -- used as limits to the construction of the feature.
102 -- Fuse offers a choice between:
103 -- - removing matter with a Boolean cut using the setting 0 in case of the groove
104 -- - adding matter with Boolean fusion using the setting 1 in case of the rib.
105
106 Add(me: in out; E: Edge from TopoDS; OnFace: Face from TopoDS)
107
108 ---Purpose: Indicates that the edge <E> will slide on the face
109 -- <OnFace>. Raises ConstructionError if the face does not belong to the
110 -- basis shape, or the edge to the prismed shape.
111 raises ConstructionError from Standard
112
113 is static;
114
115
116
117 Perform(me: in out)
118
119 is static;
120 ---Purpose: Performs a prism from the wire to the plane
121 -- along the basis shape S. Reconstructs the feature topologically.
122
123
124 Propagate(me: in out; L: in out ListOfShape from TopTools;
125 F: Face from TopoDS;
126 FPoint, LPoint: Pnt from gp;
127 falseside : in out Boolean from Standard)
128 returns Boolean from Standard
129 is static;
130
131
132fields
133
134 myAxe : Ax1 from gp;
135 myHeight1 : Real from Standard;
136 myHeight2 : Real from Standard;
137 mySliding : Boolean from Standard;
138 myPln : Plane from Geom;
139 myBnd : Real from Standard;
140 mySlface : DataMapOfShapeListOfShape from TopTools;
141 myListOfEdges : ListOfShape from TopTools;
142 myTol : Real from Standard;
143 myAngle1 : Real from Standard;
144 myAngle2 : Real from Standard;
145
146end MakeRevolutionForm;
147
148
149