0022746: Progress indicator in ShapeHealing
[occt.git] / src / ShapeFix / ShapeFix_Solid.cdl
CommitLineData
7fd59977 1-- File: ShapeFix_Solid.cdl
2-- Created: Wed Jun 3 12:33:37 1998
3-- Author: data exchange team
4-- <det@nnov.matra-dtv.fr>
5---Copyright: Matra Datavision 1998
6
7
8class Solid from ShapeFix inherits Root from ShapeFix
9
10 ---Purpose: Provides method to build a solid from a shells and
11 -- orients them in order to have a valid solid with finite volume
12
13uses
14
15 Shell from TopoDS,
16 Solid from TopoDS,
17 Shape from TopoDS,
18 Shell from ShapeFix,
19 Status from ShapeExtend,
b485ee79
KD
20 BasicMsgRegistrator from ShapeExtend,
21 ProgressIndicator from Message
7fd59977 22
23is
24 Create returns Solid from ShapeFix;
25 ---Purpose: Empty constructor;
26
27 Create (solid : Solid from TopoDS) returns Solid from ShapeFix;
28 ---Purpose: Initializes by solid.
29
30 Init(me: mutable; solid : Solid from TopoDS) is virtual;
31 ---Purpose: Initializes by solid .
32
b485ee79
KD
33 Perform(me: mutable;
34 theProgress : ProgressIndicator from Message = 0) returns Boolean is virtual;
7fd59977 35 ---Purpose: Iterates on shells and performs fixes
b485ee79
KD
36 -- (calls ShapeFix_Shell for each subshell). The passed
37 -- progress indicator allows user to consult the current
38 -- progress stage and abort algorithm if needed.
7fd59977 39
40 SolidFromShell (me: mutable; shell: Shell from TopoDS)
41 returns Solid from TopoDS;
42 ---Purpose: Calls MakeSolid and orients the solid to be "not infinite"
43
44 Status (me; status : Status from ShapeExtend) returns Boolean;
45 ---Purpose: Returns the status of the last Fix.
46
47 Solid (me) returns Shape from TopoDS;
48 ---Purpose: Returns resulting solid.
49
50 FixShellTool (me) returns Shell from ShapeFix;
51 ---Purpose: Returns tool for fixing shells.
b485ee79 52 ---C++:inline
7fd59977 53
54 SetMsgRegistrator (me: mutable; msgreg: BasicMsgRegistrator from ShapeExtend) is redefined;
b485ee79 55 ---Purpose: Sets message registrator
7fd59977 56
57 SetPrecision (me: mutable; preci: Real) is redefined;
58 ---Purpose: Sets basic precision value (also to FixShellTool)
59
60 SetMinTolerance (me: mutable; mintol: Real) is redefined;
61 ---Purpose: Sets minimal allowed tolerance (also to FixShellTool)
62
63 SetMaxTolerance (me: mutable; maxtol: Real) is redefined;
64 ---Purpose: Sets maximal allowed tolerance (also to FixShellTool)
65
66 FixShellMode (me: mutable) returns Integer;
67 ---C++: return &
b485ee79
KD
68 ---C++: inline
69 ---Purpose: Returns (modifiable) the mode for applying fixes of
70 -- ShapeFix_Shell, by default True.
7fd59977 71 CreateOpenSolidMode(me: mutable) returns Boolean;
72 ---C++: return &
b485ee79
KD
73 ---C++: inline
74 ---Purpose: Returns (modifiable) the mode for creation of solids.
75 -- If mode myCreateOpenSolidMode is equal to true
76 -- solids are created from open shells
77 -- else solids are created from closed shells only.
78 -- ShapeFix_Shell, by default False.
7fd59977 79 Shape(me : mutable) returns Shape from TopoDS;
80 ---Purpose: In case of multiconnexity returns compound of fixed solids
81 -- else returns one solid.
82fields
83
84 mySolid : Shape from TopoDS is protected;
85 myFixShell : Shell from ShapeFix is protected;
86 myStatus : Integer is protected;
87 myFixShellMode : Integer is protected;
88 myCreateOpenSolidMode : Boolean;
89
90end Solid;