Commit | Line | Data |
---|---|---|
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 | 21 | class DiscretFactory from BRepMesh |
7fd59977 | 22 | |
0b97567d K |
23 | ---Purpose: |
24 | -- This class intended to setup / retrieve default triangulation algorithm. | |
25 | -- Use BRepMesh_DiscretFactory::Get() static method to retrieve global Factory instance. | |
26 | -- Use BRepMesh_DiscretFactory::Discret() method to retrieve meshing tool. | |
7fd59977 | 27 | |
28 | uses | |
0b97567d K |
29 | DiscretRoot from BRepMesh, |
30 | FactoryError from BRepMesh, | |
31 | PluginEntryType from BRepMesh, | |
32 | AsciiString from TCollection, | |
33 | MapOfAsciiString from TColStd, | |
34 | Shape from TopoDS, | |
35 | MapOfFunctions from Plugin | |
7fd59977 | 36 | |
0b97567d | 37 | --raises |
7fd59977 | 38 | |
0b97567d | 39 | is |
7fd59977 | 40 | Create |
0b97567d K |
41 | returns DiscretFactory from BRepMesh |
42 | is protected; | |
43 | ---C++: alias "Standard_EXPORT virtual ~BRepMesh_DiscretFactory();" | |
44 | ||
45 | Get (myclass) | |
46 | returns DiscretFactory from BRepMesh; | |
47 | ---C++: return & | |
48 | ---Purpose: | |
49 | -- Returns the global factory instance. | |
50 | ||
51 | Names (me) | |
52 | returns MapOfAsciiString from TColStd; | |
53 | ---C++: return const & | |
54 | ---Purpose: | |
55 | -- Returns the list of registered meshing algorithms. | |
56 | ||
57 | SetDefaultName ( me : out; | |
58 | theName : AsciiString from TCollection) | |
59 | returns Boolean from Standard; | |
60 | ---Purpose: | |
61 | -- Setup meshing algorithm by name. | |
62 | -- Returns true if requested tool is available. | |
63 | -- On fail Factory will continue to use previous algo. | |
64 | ||
65 | DefaultName (me) | |
66 | returns AsciiString from TCollection; | |
67 | ---C++: return const & | |
68 | ---Purpose: | |
69 | -- Returns name for current meshing algorithm. | |
7fd59977 | 70 | |
0b97567d K |
71 | SetFunctionName ( me : out; |
72 | theFuncName : AsciiString from TCollection) | |
73 | returns Boolean from Standard; | |
74 | ---Purpose: | |
75 | -- Advanced function. Changes function name to retrieve from plugin. | |
76 | -- Returns true if requested tool is available. | |
77 | -- On fail Factory will continue to use previous algo. | |
78 | ||
79 | SetDefault ( me : out; | |
80 | theName : AsciiString from TCollection; | |
81 | theFuncName : AsciiString from TCollection = "DISCRETALGO") | |
82 | returns Boolean from Standard; | |
83 | ---Purpose: | |
84 | -- Setup meshing algorithm that should be created by this Factory. | |
85 | -- Returns true if requested tool is available. | |
86 | -- On fail Factory will continue to use previous algo. | |
87 | -- Call ::ErrorStatus() method to retrieve fault reason. | |
88 | ||
89 | FunctionName (me) | |
90 | returns AsciiString from TCollection; | |
91 | ---C++: return const & | |
92 | ---Purpose: | |
93 | -- Returns function name that should be exported by plugin. | |
94 | ||
95 | Discret (me : out; | |
96 | theShape : Shape from TopoDS; | |
97 | theDeflection : Real from Standard; | |
98 | theAngle : Real from Standard) | |
99 | returns DiscretRoot from BRepMesh; | |
100 | ---Purpose: | |
101 | -- Returns triangulation algorithm instance. | |
102 | ||
103 | ErrorStatus (me) | |
104 | returns FactoryError from BRepMesh; | |
105 | ---Purpose: | |
106 | -- Returns error status for last meshing algorithm switch. | |
107 | ||
108 | Clear (me : out) | |
109 | is protected; | |
110 | ||
111 | fields | |
112 | myPluginEntry : PluginEntryType from BRepMesh is protected; | |
113 | myErrorStatus : FactoryError from BRepMesh is protected; | |
114 | myNames : MapOfAsciiString from TColStd is protected; | |
115 | myDefaultName : AsciiString from TCollection is protected; | |
116 | myFunctionName : AsciiString from TCollection is protected; | |
117 | myFactoryMethods : MapOfFunctions from Plugin is protected; | |
118 | ||
119 | end DiscretFactory; |