0023024: Update headers of OCCT files
[occt.git] / src / BOP / BOP_SolidBuilder.cdl
CommitLineData
b311480e 1-- Created on: 2001-06-25
2-- Created by: Michael KLOKOV
3-- Copyright (c) 2001-2012 OPEN CASCADE SAS
4--
5-- The content of this file is subject to the Open CASCADE Technology Public
6-- License Version 6.5 (the "License"). You may not use the content of this file
7-- except in compliance with the License. Please obtain a copy of the License
8-- at http://www.opencascade.org and read it completely before using this file.
9--
10-- The Initial Developer of the Original Code is Open CASCADE S.A.S., having its
11-- main offices at: 1, place des Freres Montgolfier, 78280 Guyancourt, France.
12--
13-- The Original Code and all software distributed under the License is
14-- distributed on an "AS IS" basis, without warranty of any kind, and the
15-- Initial Developer hereby disclaims all such warranties, including without
16-- limitation, any warranties of merchantability, fitness for a particular
17-- purpose or non-infringement. Please see the License for the specific terms
18-- and conditions governing the rights and limitations under the License.
19
7fd59977 20
21class SolidBuilder from BOP
22
23 ---Purpose:
24 --- Construct Solids from a Shell Faces Set (SFS)
25 ---
26uses
27
28 Shell from TopoDS,
29 Face from TopoDS,
30 ShapeSet from BOP,
31 LoopSet from BOP,
32 ShellFaceSet from BOP,
33 BlockBuilder from BOP,
34 BlockIterator from BOP,
35 SolidAreaBuilder from BOP
36
37is
38
39 Create returns SolidBuilder from BOP;
40 ---Purpose:
41 --- Empty constructor;
42 ---
43 Create(theSFS: in out ShellFaceSet from BOP;
44 theForceClassFlag: Boolean from Standard = Standard_False)
45 returns SolidBuilder from BOP;
46 ---Purpose:
47 --- The constructor that just calls the method
48 --- InitSolidBuilder() below
49 ---
50 InitSolidBuilder(me : in out;
51 theSFS: in out ShellFaceSet from BOP;
52 theForceClassFlag: Boolean from Standard);
53 ---Purpose:
54 --- Launches the algorithm consisting of four steps
55 --- 1. Split the SFS on shells ( BOP_SFSCorrector object)
56 --- 2. Make Loops from shells ( this->MakeLoops() )
57 --- 3. Make Areas from Loops ( BOP_SolidAreaBuilder object)
58 --- 4. Make Solids from Areas ( see methods below )
59 ---
60
61 ---
62 --- O u t p u t m e t h o d s
63 ---
64 --- Iterator on Solids
65 ---
66 InitSolid(me: in out)
67 returns Integer from Standard;
68
69 MoreSolid(me)
70 returns Boolean from Standard;
71
72 NextSolid(me : in out);
73 ---
74 --- Iterator on Shells
75 ---
76 InitShell(me : in out)
77 returns Integer from Standard;
78
79 MoreShell(me)
80 returns Boolean from Standard;
81
82 NextShell(me : in out);
83
84 IsOldShell(me)
85 returns Boolean from Standard;
86
87 OldShell(me) returns Shell from TopoDS;
88 ---
89 --- Iterator on Shells
90 ---
91 InitFace(me : in out)
92 returns Integer from Standard;
93
94 MoreFace(me)
95 returns Boolean from Standard;
96
97 NextFace(me : in out);
98
99 Face(me)
100 returns Face from TopoDS;
101 ---C++: return const &
102 ---Purpose:
103 --- Returns current new face of current new shell.
104 ---
105
106 ------------------------------------------------------
107 -- P r i v a t e b l o c k
108 --
109 MakeLoops(me: in out; theSFS: in out ShapeSet from BOP)
110 is private;
111
112fields
113
114 myLoopSet : LoopSet from BOP;
115 myBlockIterator : BlockIterator from BOP;
116 myBlockBuilder : BlockBuilder from BOP;
117 mySolidAreaBuilder: SolidAreaBuilder from BOP;
118
119end SolidBuilder from BOP;