0024023: Revamp the OCCT Handle -- ambiguity
[occt.git] / src / BRepOffsetAPI / BRepOffsetAPI_MakePipe.cdl
CommitLineData
b311480e 1-- Created on: 1994-07-12
2-- Created by: Bruno DUMORTIER
3-- Copyright (c) 1994-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
17class MakePipe from BRepOffsetAPI inherits MakeSweep from BRepPrimAPI
18
19 ---Purpose: Describes functions to build pipes.
20 -- A pipe is built a basis shape (called the profile) along
21 -- a wire (called the spine) by sweeping.
22 -- The profile must not contain solids.
23 -- A MakePipe object provides a framework for:
24 -- - defining the construction of a pipe,
25 -- - implementing the construction algorithm, and
26 -- - consulting the result.
27 -- Warning
28 -- The MakePipe class implements pipe constructions
29 -- with G1 continuous spines only.
30uses
31 Pipe from BRepFill,
a31abc03 32 Trihedron from GeomFill,
7fd59977 33 Wire from TopoDS,
34 Shape from TopoDS,
35 Edge from TopoDS,
36 ListOfShape from TopTools
37
38is
39
40
41 Create( Spine : Wire from TopoDS;
42 Profile : Shape from TopoDS )
43 ---Purpose: Constructs a pipe by sweeping the shape Profile along
44 -- the wire Spine.The angle made by the spine with the profile is
45 -- maintained along the length of the pipe.
46 -- Warning
47 -- Spine must be G1 continuous; that is, on the connection
48 -- vertex of two edges of the wire, the tangent vectors on
49 -- the left and on the right must have the same direction,
50 -- though not necessarily the same magnitude.
51 -- Exceptions
52 -- Standard_DomainError if the profile is a solid or a
53 -- composite solid.
54 returns MakePipe from BRepOffsetAPI;
55
471ce736 56 Create( Spine : Wire from TopoDS;
57 Profile : Shape from TopoDS;
58 aMode : Trihedron from GeomFill;
59 ForceApproxC1 : Boolean from Standard = Standard_False)
60 ---Purpose: the same as previous but with setting of
61 -- mode of sweep and the flag that indicates attempt
62 -- to approximate a C1-continuous surface if a swept
63 -- surface proved to be C0.
64 returns MakePipe from BRepOffsetAPI;
7fd59977 65
66 Pipe(me) returns Pipe from BRepFill
67 ---C++: return const &
68 ---Level: Advanced
69 is static;
70
71
72 Build(me : in out)
73 is redefined;
74 ---Purpose: Builds the resulting shape (redefined from MakeShape).
75 ---Level: Public
76
77
78 FirstShape (me : in out)
79 ---Purpose: Returns the TopoDS Shape of the bottom of the prism.
80 returns Shape from TopoDS;
81
82
83 LastShape (me : in out)
84 ---Purpose: Returns the TopoDS Shape of the top of the prism.
85 returns Shape from TopoDS;
86
87
88 Generated (me: in out; SSpine, SProfile : Shape from TopoDS)
89 ---Level: Public
90 returns Shape from TopoDS;
91
92
73920cd4 93 ErrorOnSurface (me)
94 ---Level: Public
95 returns Real from Standard;
96
97
7fd59977 98fields
99
100 myPipe : Pipe from BRepFill;
101
102end MakePipe;