0023024: Update headers of OCCT files
[occt.git] / src / BRepMesh / BRepMesh_DiscretRoot.cdl
CommitLineData
b311480e 1-- Created on: 2008-04-10
2-- Created by: Peter KURNEV <pkv@irinox>
3-- Copyright (c) 2008-2012 OPEN CASCADE SAS
0b97567d 4--
b311480e 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
0b97567d 21deferred class DiscretRoot from BRepMesh
7fd59977 22
0b97567d
K
23inherits Transient from Standard
24
25 ---Purpose:
26 -- This is a common interface for meshing algorithms
27 -- instantiated by Mesh Factory and implemented by plugins.
7fd59977 28
29uses
0b97567d
K
30 Shape from TopoDS
31
7fd59977 32--raises
33
0b97567d
K
34is
35 Initialize
36 returns DiscretRoot from BRepMesh;
37
38 SetDeflection ( me : mutable;
39 theDeflection : Real from Standard);
40 ---Purpose:
41 -- Setup linear deflection.
42
43 ---C++: alias "Standard_EXPORT virtual ~BRepMesh_DiscretRoot();"
44
45 Deflection (me)
46 returns Real from Standard;
47 ---Purpose:
48 -- Returns linear deflection.
49
50 SetAngle ( me : mutable;
51 theAngle : Real from Standard);
52 ---Purpose:
53 -- Setup angular deflection.
54
55 Angle (me)
56 returns Real from Standard;
57 ---Purpose:
58 -- Returns angular deflection.
59
60 SetShape ( me : mutable;
61 theShape : Shape from TopoDS);
62 ---Purpose:
63 -- Set the shape to triangulate.
64
65 Shape (me)
66 returns Shape from TopoDS;
67 ---C++: return const &
68
69 Perform (me : mutable)
70 is deferred;
71 ---Purpose:
72 -- Compute triangulation for set shape.
73
74 IsDone (me)
75 returns Boolean from Standard;
76 ---Purpose:
77 -- Returns true if triangualtion was performed and has success.
78
79 --
80 -- Protected methods
81 --
82 SetDone (me : mutable)
83 is protected;
84
85 SetNotDone (me : mutable)
86 is protected;
87
88 Init (me : mutable)
89 is virtual protected;
90
91fields
92 myDeflection : Real from Standard is protected;
7fd59977 93 myAngle : Real from Standard is protected;
0b97567d
K
94 myShape : Shape from TopoDS is protected;
95 myIsDone : Boolean from Standard is protected;
96
7fd59977 97end DiscretRoot;