0023024: Update headers of OCCT files
[occt.git] / src / BRepSweep / BRepSweep_Prism.cdl
CommitLineData
b311480e 1-- Created on: 1993-06-22
2-- Created by: Laurent BOURESCHE
3-- Copyright (c) 1993-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 Prism from BRepSweep
24
25---Purpose: Provides natural constructors to build BRepSweep
26-- translated swept Primitives.
27
28uses
29 Location from TopLoc,
30 NumShape from Sweep,
31 Translation from BRepSweep,
32 Shape from TopoDS,
33 Vec from gp,
34 Dir from gp
35
36raises
37 ConstructionError from Standard
38
39is
40 Create (S : Shape from TopoDS;
41 V : Vec from gp;
42 Copy : Boolean from Standard = Standard_False;
43 Canonize: Boolean from Standard = Standard_True)
44 ---Purpose: Builds the prism of base S and vector V. If C is true,
45 -- S is copied. If Canonize is true then generated surfaces
46 -- are attempted to be canonized in simple types
47 returns Prism from BRepSweep;
48
49 Create (S : Shape from TopoDS;
50 D : Dir from gp;
51 Inf : Boolean from Standard = Standard_True;
52 Copy : Boolean from Standard = Standard_False;
53 Canonize : Boolean from Standard = Standard_True)
54 ---Purpose: Builds a semi-infinite or an infinite prism of base S.
55 -- If Copy is true S is copied. If Inf is true the prism
56 -- is infinite, if Inf is false the prism is infinite in
57 -- the direction D. If Canonize is true then generated surfaces
58 -- are attempted to be canonized in simple types
59 returns Prism from BRepSweep;
60
61 Shape (me : in out)
62 ---Purpose: Returns the TopoDS Shape attached to the prism.
63 returns Shape from TopoDS
64 is static;
65
66 Shape (me : in out; aGenS : Shape from TopoDS)
67 ---Purpose: Returns the TopoDS Shape generated with aGenS
68 -- (subShape of the generating shape).
69 returns Shape from TopoDS
70 is static;
71
72 FirstShape (me : in out)
73 ---Purpose: Returns the TopoDS Shape of the bottom of the prism.
74 returns Shape from TopoDS
75 is static;
76
77 FirstShape (me : in out; aGenS : Shape from TopoDS)
78 ---Purpose: Returns the TopoDS Shape of the bottom of the prism.
79 -- generated with aGenS (subShape of the generating
80 -- shape).
81 returns Shape from TopoDS
82 is static;
83
84 LastShape (me : in out)
85 ---Purpose: Returns the TopoDS Shape of the top of the prism.
86 returns Shape from TopoDS
87 is static;
88
89 LastShape (me : in out; aGenS : Shape from TopoDS)
90 ---Purpose: Returns the TopoDS Shape of the top of the prism.
91 -- generated with aGenS (subShape of the generating
92 -- shape).
93 returns Shape from TopoDS
94 is static;
95
96 Vec(me)
97 ---Purpose: Returns the Vector of the Prism, if it is an infinite
98 -- prism the Vec is unitar.
99 returns Vec from gp
100 is static;
101
102 NumShape (me)
103 returns NumShape from Sweep
104 ---Purpose: used to build the NumShape of a limited prism.
105 is static private;
106
107 NumShape (me; Inf : Boolean from Standard)
108 returns NumShape from Sweep
109 ---Purpose: used to build the NumShape of an infinite prism.
110 is static private;
111
112 Location(me; V : Vec from gp)
113 returns Location from TopLoc
114 ---Purpose: used to build the Location.
115 is static private;
116
117fields
118
119 myTranslation : Translation from BRepSweep;
120
121end Prism from BRepSweep;