Integration of OCCT 6.5.0 from SVN
[occt.git] / src / BRepOffsetAPI / BRepOffsetAPI_MakeOffset.cdl
CommitLineData
7fd59977 1-- File: BRepOffsetAPI_MakeOffset.cdl
2-- Created: Mon Sep 18 13:40:56 1995
3-- Author: Bruno DUMORTIER
4-- <dub@fuegox>
5---Copyright: Matra Datavision 1995
6
7
8class MakeOffset from BRepOffsetAPI inherits MakeShape from BRepBuilderAPI
9
10 ---Purpose: Describes algorithms for offsetting wires from a set of
11 -- wires contained in a planar face.
12 -- A MakeOffset object provides a framework for:
13 -- - defining the construction of an offset,
14 -- - implementing the construction algorithm, and
15 -- - consulting the result.
16
17uses
18 Shape from TopoDS,
19 Wire from TopoDS,
20 Face from TopoDS,
21 ListOfShape from TopTools,
22 OffsetWire from BRepFill,
23 ListOfOffsetWire from BRepFill,
24 JoinType from GeomAbs
25
26
27raises
28 ConstructionError from Standard
29
30is
31 Create returns MakeOffset from BRepOffsetAPI;
32 ---Purpose: Constructs an algorithm for creating an empty offset
33 Create( Spine : Face from TopoDS;
34 Join : JoinType from GeomAbs = GeomAbs_Arc)
35 returns MakeOffset from BRepOffsetAPI;
36 ---Purpose: Constructs an algorithm for creating an algorithm
37 -- to build parallels to the spine Spine
38 Init( me : in out;
39 Spine : Face from TopoDS;
40 Join : JoinType from GeomAbs = GeomAbs_Arc)
41 ---Purpose: Initializes the algorithm to construct parallels to the spine Spine.
42 -- Join defines the type of parallel generated by the
43 -- salient vertices of the spine. The default type is
44 -- GeomAbs_Arc where the vertices generate sections
45 -- of a circle. At present, this is the only construction type implemented.
46 is static;
47
48 Create( Spine : Wire from TopoDS;
49 Join : JoinType from GeomAbs = GeomAbs_Arc)
50 returns MakeOffset from BRepOffsetAPI;
51
52 Init( me : in out;
53 Join : JoinType from GeomAbs = GeomAbs_Arc)
54 ---Purpose: Initialize the evaluation of Offseting.
55 is static;
56
57 AddWire (me : in out;
58 Spine : Wire from TopoDS)
59 ---Purpose: Initializes the algorithm to construct parallels to the wire Spine.
60 is static;
61
62 Perform (me : in out;
63 Offset : Real from Standard;
64 Alt : Real from Standard = 0.0)
65 ---Purpose: Computes a parallel to the spine at distance Offset and
66 -- at an altitude Alt from the plane of the spine in relation
67 -- to the normal to the spine.
68 -- Exceptions: Standard_ConstructionError if the offset is not built.
69 raises
70 ConstructionError from Standard
71 is static;
72
73
74 Build(me : in out)
75 is redefined;
76 ---Purpose: Builds the resulting shape (redefined from MakeShape).
77 ---Level: Public
78
79 Generated (me: in out; S : Shape from TopoDS)
80 ---Purpose: returns a list of the created shapes
81 -- from the shape <S>.
82 ---C++: return const &
83 ---Level: Public
84 returns ListOfShape from TopTools
85 is redefined;
86
87
88fields
89
90 myIsInitialized : Boolean from Standard;
91 myLastIsLeft : Boolean from Standard;
92 myJoin : JoinType from GeomAbs;
93 myFace : Face from TopoDS;
94 myWires : ListOfShape from TopTools;
95 myLeft : ListOfOffsetWire from BRepFill;
96 myRight : ListOfOffsetWire from BRepFill;
97
98end MakeOffset;