0024023: Revamp the OCCT Handle -- ambiguity
[occt.git] / src / BRepFill / BRepFill_CompatibleWires.cdl
CommitLineData
b311480e 1-- Created on: 1998-07-02
2-- Created by: Joelle CHAUVET
3-- Copyright (c) 1998-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 CompatibleWires from BRepFill
18
ff8178ef 19 ---Purpose: Constructs a sequence of Wires (with good orientation
20 -- and origin) agreed each other so that the surface passing
21 -- through these sections is not twisted
7fd59977 22
23uses
24
25 Edge from TopoDS,
26 SequenceOfShape from TopTools,
27 ListOfShape from TopTools,
28 DataMapOfShapeListOfShape from TopTools
29
30raises
31 ConstructionError from Standard,
32 NoSuchObject from Standard
33
34is
35
36 Create returns CompatibleWires from BRepFill;
37
38 Create ( Sections : SequenceOfShape from TopTools)
39 returns CompatibleWires from BRepFill;
40
41 Init ( me : in out;
42 Sections : SequenceOfShape from TopTools)
43 raises
44 ConstructionError from Standard
45 is static;
46
47 SetPercent ( me : in out; percent : Real = 0.01)
48 is static;
49
50 Perform (me : in out;
51 WithRotation : Boolean = Standard_True)
52 ---Purpose: Performs CompatibleWires According to the orientation
53 -- and the origin of each other
54 raises
55 ConstructionError from Standard
56 is static;
57
58 IsDone ( me)
59 returns Boolean from Standard
60 is static;
61
62
63
64 Shape(me) returns SequenceOfShape from TopTools
65 ---Purpose: returns the generated sequence.
66 ---C++ : return const &
67 is static;
68
69 GeneratedShapes (me ; SubSection : Edge from TopoDS)
70 ---Purpose: Returns the shapes created from a subshape
71 -- <SubSection> of a section.
72 --
73 ---C++ : return const &
74 returns ListOfShape from TopTools
75 is static;
76
77 Generated (me)
78 ---C++: return const &
79 returns DataMapOfShapeListOfShape from TopTools
80 is static;
81
82 SameNumberByPolarMethod (me : in out;
83 WithRotation : Boolean = Standard_True)
84 ---Purpose: Insert cutting points on closed wires to have same
85 -- number of edges. The sequence of shapes must
86 -- be a sequence of wires.
87 is static private;
88
89 SameNumberByACR (me : in out; report : Boolean from Standard )
90 ---Purpose: Insert cutting points on open wires to have same
91 -- number of edges. The sequence of shapes must
92 -- be a sequence of wires.
93 is static private;
94
95 ComputeOrigin (me : in out; polar : Boolean from Standard )
96 ---Purpose: Computes origins and orientation on closed wires to
97 -- avoid twisted results. The sequence of shapes must
98 -- be a sequence of wires. <polar> must be true
99 -- if SameNumberByPolarMethod was used before.
100 is static private;
101
102 SearchOrigin (me : in out)
103 ---Purpose: Computes origins and orientation on open wires to
104 -- avoid twisted results. The sequence of shapes must
105 -- be a sequence of wires.
106
107 is static private;
108
109fields
110
111 myInit : SequenceOfShape from TopTools;
112 myWork : SequenceOfShape from TopTools;
113 myPercent : Real from Standard;
114 myDegen1 : Boolean from Standard;
115 myDegen2 : Boolean from Standard;
116 myIsDone : Boolean from Standard;
117 myMap : DataMapOfShapeListOfShape from TopTools;
118
119end CompatibleWires;
120
121
122
123
124
125
126
127
128