0025748: Parallel version of progress indicator
[occt.git] / src / ShapeProcess / ShapeProcess.hxx
1 // Created on: 2000-08-21
2 // Created by: Andrey BETENEV
3 // Copyright (c) 2000-2014 OPEN CASCADE SAS
4 //
5 // This file is part of Open CASCADE Technology software library.
6 //
7 // This library is free software; you can redistribute it and/or modify it under
8 // the terms of the GNU Lesser General Public License version 2.1 as published
9 // by the Free Software Foundation, with special exception defined in the file
10 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
11 // distribution for complete text of the license and disclaimer of any warranty.
12 //
13 // Alternatively, this file may be used under the terms of Open CASCADE
14 // commercial license or contractual agreement.
15
16 #ifndef _ShapeProcess_HeaderFile
17 #define _ShapeProcess_HeaderFile
18
19 #include <Standard.hxx>
20 #include <Standard_DefineAlloc.hxx>
21 #include <Standard_Handle.hxx>
22
23 #include <Standard_Boolean.hxx>
24 #include <Standard_CString.hxx>
25 #include <Message_ProgressRange.hxx>
26
27 class ShapeProcess_Operator;
28 class ShapeProcess_Context;
29 class ShapeProcess_Context;
30 class ShapeProcess_ShapeContext;
31 class ShapeProcess_Operator;
32 class ShapeProcess_UOperator;
33 class ShapeProcess_OperLibrary;
34
35 //! Shape Processing module
36 //! allows to define and apply general Shape Processing as a
37 //! customizable sequence of Shape Healing operators. The
38 //! customization is implemented via user-editable resource
39 //! file which defines sequence of operators to be executed
40 //! and their parameters.
41 class ShapeProcess 
42 {
43 public:
44
45   DEFINE_STANDARD_ALLOC
46
47   
48   //! Registers operator to make it visible for Performer
49   Standard_EXPORT static Standard_Boolean RegisterOperator (const Standard_CString name, const Handle(ShapeProcess_Operator)& op);
50   
51   //! Finds operator by its name
52   Standard_EXPORT static Standard_Boolean FindOperator (const Standard_CString name, Handle(ShapeProcess_Operator)& op);
53   
54   //! Performs a specified sequence of operators on Context
55   //! Resource file and other data should be already loaded
56   //! to Context (including description of sequence seq)
57   Standard_EXPORT static Standard_Boolean Perform 
58                    (const Handle(ShapeProcess_Context)& context,
59                     const Standard_CString seq,
60                     const Message_ProgressRange& theProgress = Message_ProgressRange());
61
62
63
64
65 protected:
66
67
68
69
70
71 private:
72
73
74
75
76 friend class ShapeProcess_Context;
77 friend class ShapeProcess_ShapeContext;
78 friend class ShapeProcess_Operator;
79 friend class ShapeProcess_UOperator;
80 friend class ShapeProcess_OperLibrary;
81
82 };
83
84
85
86
87
88
89
90 #endif // _ShapeProcess_HeaderFile