0023024: Update headers of OCCT files
[occt.git] / src / BRepProj / BRepProj_Projection.cdl
CommitLineData
b311480e 1-- Created on: 1998-11-13
2-- Created by: Jean-Michel BOULCOURT
3-- Copyright (c) 1998-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
23
24class Projection from BRepProj
25
26 ---Purpose: The Projection class provides conical and
27 -- cylindrical projections of Edge or Wire on
28 -- a Shape from TopoDS. The result will be a Edge
29 -- or Wire from TopoDS.
30
31uses
32 Dir from gp,
33 Pnt from gp,
34 Shape from TopoDS,
35 Edge from TopoDS,
36 Wire from TopoDS,
37 Face from TopoDS,
38 Compound from TopoDS,
39 HSequenceOfShape from TopTools
40
41raises
42 NoSuchObject from Standard,
43 ConstructionError from Standard,
44 NullObject from Standard
45
46is
47
48 Create(Wire, Shape : Shape from TopoDS;
49 D : Dir from gp)
50 returns Projection from BRepProj
51 raises NullObject from Standard,
52 ConstructionError from Standard;
53 ---Purpose: Makes a Cylindrical projection of Wire om Shape
54
55 Create(Wire, Shape : Shape from TopoDS;
56 P : Pnt from gp)
57 returns Projection from BRepProj
58 raises NullObject from Standard,
59 ConstructionError from Standard;
60 ---Purpose: Makes a Conical projection of Wire om Shape
61
62
63 IsDone(me) returns Boolean from Standard
64 ---Purpose: returns False if the section failed
65 ---C++: inline
66 is static;
67
68 Init(me : in out)
69 ---Purpose: Resets the iterator by resulting wires.
70 ---C++: inline
71 is static;
72
73 More(me) returns Boolean from Standard
74 ---Purpose: Returns True if there is a current result wire
75 ---C++: inline
76 is static;
77
78 Next(me : in out)
79 ---Purpose: Move to the next result wire.
80 ---C++: inline
81 is static;
82
83 Current(me)
84 returns Wire from TopoDS
85 ---Purpose: Returns the current result wire.
86 ---C++: inline
87 is static;
88
89 Shape(me)
90 returns Compound from TopoDS
91 ---Purpose: Returns the complete result as compound of wires.
92 ---C++: inline
93 is static;
94
95 BuildSection(me: in out; Shape, Tool: Shape from TopoDS)
96 is private;
97 ---Purpose: Performs section of theShape by theTool
98 --- and stores result in the fields.
99
100fields
101
102 myIsDone : Boolean from Standard;
103 myLsh : Shape from TopoDS;
104 myShape : Compound from TopoDS;
105 mySection : HSequenceOfShape from TopTools;
106 myItr : Integer from Standard;
107
108end Projection;
109