include/opencascade/ShapeProcess.hxx

0001 // Created on: 2000-08-21
0002 // Created by: Andrey BETENEV
0003 // Copyright (c) 2000-2014 OPEN CASCADE SAS
0004 //
0005 // This file is part of Open CASCADE Technology software library.
0006 //
0007 // This library is free software; you can redistribute it and/or modify it under
0008 // the terms of the GNU Lesser General Public License version 2.1 as published
0009 // by the Free Software Foundation, with special exception defined in the file
0010 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
0011 // distribution for complete text of the license and disclaimer of any warranty.
0012 //
0013 // Alternatively, this file may be used under the terms of Open CASCADE
0014 // commercial license or contractual agreement.
0015
0016 #ifndef _ShapeProcess_HeaderFile
0017 #define _ShapeProcess_HeaderFile
0018
0019 #include <Standard.hxx>
0020 #include <Standard_DefineAlloc.hxx>
0021 #include <Standard_Handle.hxx>
0022
0023 #include <Message_ProgressRange.hxx>
0024
0025 class ShapeProcess_Operator;
0026 class ShapeProcess_Context;
0027
0028 //! Shape Processing module
0029 //! allows to define and apply general Shape Processing as a
0030 //! customizable sequence of Shape Healing operators. The
0031 //! customization is implemented via user-editable resource
0032 //! file which defines sequence of operators to be executed
0033 //! and their parameters.
0034 class ShapeProcess
0035 {
0036 public:
0037
0038   DEFINE_STANDARD_ALLOC
0039
0040
0041   //! Registers operator to make it visible for Performer
0042   Standard_EXPORT static Standard_Boolean RegisterOperator (const Standard_CString name, const Handle(ShapeProcess_Operator)& op);
0043
0044   //! Finds operator by its name
0045   Standard_EXPORT static Standard_Boolean FindOperator (const Standard_CString name, Handle(ShapeProcess_Operator)& op);
0046
0047   //! Performs a specified sequence of operators on Context
0048   //! Resource file and other data should be already loaded
0049   //! to Context (including description of sequence seq)
0050   Standard_EXPORT static Standard_Boolean Perform
0051                    (const Handle(ShapeProcess_Context)& context,
0052                     const Standard_CString seq,
0053                     const Message_ProgressRange& theProgress = Message_ProgressRange());
0054
0055 };
0056
0057 #endif // _ShapeProcess_HeaderFile