1 -- Created on: 2008-04-10
2 -- Created by: Peter KURNEV <pkv@irinox>
3 -- Copyright (c) 2008-2012 OPEN CASCADE SAS
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.
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.
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.
21 class DiscretFactory from BRepMesh
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.
29 DiscretRoot from BRepMesh,
30 FactoryError from BRepMesh,
31 PluginEntryType from BRepMesh,
32 AsciiString from TCollection,
33 MapOfAsciiString from TColStd,
35 MapOfFunctions from Plugin
41 returns DiscretFactory from BRepMesh
43 ---C++: alias "Standard_EXPORT virtual ~BRepMesh_DiscretFactory();"
46 returns DiscretFactory from BRepMesh;
49 -- Returns the global factory instance.
52 returns MapOfAsciiString from TColStd;
53 ---C++: return const &
55 -- Returns the list of registered meshing algorithms.
57 SetDefaultName ( me : out;
58 theName : AsciiString from TCollection)
59 returns Boolean from Standard;
61 -- Setup meshing algorithm by name.
62 -- Returns true if requested tool is available.
63 -- On fail Factory will continue to use previous algo.
66 returns AsciiString from TCollection;
67 ---C++: return const &
69 -- Returns name for current meshing algorithm.
71 SetFunctionName ( me : out;
72 theFuncName : AsciiString from TCollection)
73 returns Boolean from Standard;
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.
79 SetDefault ( me : out;
80 theName : AsciiString from TCollection;
81 theFuncName : AsciiString from TCollection = "DISCRETALGO")
82 returns Boolean from Standard;
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.
90 returns AsciiString from TCollection;
91 ---C++: return const &
93 -- Returns function name that should be exported by plugin.
96 theShape : Shape from TopoDS;
97 theDeflection : Real from Standard;
98 theAngle : Real from Standard)
99 returns DiscretRoot from BRepMesh;
101 -- Returns triangulation algorithm instance.
104 returns FactoryError from BRepMesh;
106 -- Returns error status for last meshing algorithm switch.
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;