Integration of OCCT 6.5.0 from SVN
[occt.git] / src / BRepFeat / BRepFeat_SplitShape.cdl
CommitLineData
7fd59977 1-- File: BRepFeat_SplitShape.cdl
2-- Created: Mon Sep 4 09:48:52 1995
3-- Author: Jacques GOUSSARD
4-- <jag@bravox>
5---Copyright: Matra Datavision 1995
6
7
8class SplitShape from BRepFeat inherits MakeShape from BRepBuilderAPI
9
10 ---Purpose: One of the most significant aspects of BRepFeat functionality is the use of local
11 -- operations as opposed to global ones. In a global operation, you would first construct a
12 -- form of the type you wanted in your final feature, and then remove matter so that it could
13 -- fit into your initial basis object. In a local operation, however, you specify the domain of
14 -- the feature construction with aspects of the shape on which the feature is being created.
15 -- These semantics are expressed in terms of a member shape of the basis shape from which -
16 -- or up to which - matter will be added or removed. As a result, local operations make
17 -- calculations simpler and faster than global operations.
18 -- In BRepFeat, the semantics of local operations define features constructed from a contour or a
19 -- part of the basis shape referred to as the tool. In a SplitShape object, wires or edges of a
20 -- face in the basis shape to be used as a part of the feature are cut out and projected to a plane
21 -- outside or inside the basis shape. By rebuilding the initial shape incorporating the edges and
22 -- the faces of the tool, protrusion or depression features can be constructed.
23
24
25uses Spliter from LocOpe,
26 WiresOnShape from LocOpe,
27 Shape from TopoDS,
28 Face from TopoDS,
29 Wire from TopoDS,
30 Edge from TopoDS,
31 Vertex from TopoDS,
32 ListOfShape from TopTools,
33 ShapeModification from BRepBuilderAPI
34
35raises NotDone from StdFail,
36 ConstructionError from Standard,
37 NoSuchObject from Standard
38
39is
40
41
42 Create
43 ---Purpose: Empty constructor
44 returns SplitShape from BRepFeat;
45 ---C++: inline
46
47
48 Create(S: Shape from TopoDS)
49 ---Purpose: Creates the process with the shape <S>.
50 returns SplitShape from BRepFeat;
51 ---C++: inline
52
53
54 Init(me: in out; S: Shape from TopoDS)
55 ---Purpose: Initializes the process on the shape <S>.
56 ---C++: inline
57 is static;
58
59
60 Add(me: in out; W: Wire from TopoDS;
61 F: Face from TopoDS)
62 ---Purpose: Adds the wire <W> on the face <F>.
63 -- Raises NoSuchObject if <F> does not belong to the original shape.
64 ---C++: inline
65 raises NoSuchObject from Standard,
66 ConstructionError from Standard
67
68 is static;
69
70
71
72 Add(me: in out; E: Edge from TopoDS;
73 F: Face from TopoDS)
74 ---Purpose: Adds the edge <E> on the face <F>.
75 ---C++: inline
76 raises NoSuchObject from Standard,
77 -- if <F> does not belong to the original shape.
78 ConstructionError from Standard
79
80 is static;
81
82
83
84 Add(me: in out; E : Edge from TopoDS;
85 EOn: Edge from TopoDS)
86 ---Purpose: Adds the edge <E> on the existing edge <EOn>.
87 ---C++: inline
88 raises NoSuchObject from Standard,
89 -- if <EOn> does not belong to the original shape.
90 ConstructionError from Standard
91
92 is static;
93
94
95 DirectLeft(me)
96 ---Purpose: Returns the faces which are the left of the
97 -- projected wires.
98 returns ListOfShape from TopTools
99 ---C++: return const&
100 raises NotDone from StdFail
101 --- The exception is raised when IsDone returns <Standard_False>.
102 is static;
103
104
105 Left(me)
106 ---Purpose: Returns the faces of the "left" part on the shape.
107 -- (It is build from DirectLeft, with the faces
108 -- connected to this set, and so on...).
109 -- Raises NotDone if IsDone returns <Standard_False>.
110 ---C++: return const&
111 returns ListOfShape from TopTools
112 raises NotDone from StdFail
113 is static;
114
115
116--- Methods inherited from MakeShape, that must be redefined.
117
118
119 Build(me: in out)
120
121 is redefined static;
122 --- Purpose: Builds the cut and the resulting faces and edges as well.
123 IsDeleted (me: in out; S : Shape from TopoDS)
124 returns Boolean
125 is redefined;
126 ---Purpose: Returns true if the shape has been deleted.
127
128 Modified(me: in out; F: Shape from TopoDS)
129 ---Purpose: Returns the list of generated Faces.
130 ---C++: return const &
131 returns ListOfShape from TopTools
132 is redefined static;
133
134fields
135
136 mySShape : Spliter from LocOpe;
137 myWOnShape : WiresOnShape from LocOpe;
138
139end SplitShape;