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