0025113: Mesh - Progress indication and user break functionality for BRepMesh component
[occt.git] / src / IMeshTools / IMeshTools_MeshAlgo.hxx
1 // Created on: 2016-07-07
2 // Copyright (c) 2016 OPEN CASCADE SAS
3 // Created by: Oleg AGASHIN
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 _IMeshTools_MeshAlgo_HeaderFile
17 #define _IMeshTools_MeshAlgo_HeaderFile
18
19 #include <Standard_Transient.hxx>
20 #include <Standard_Type.hxx>
21 #include <IMeshData_Types.hxx>
22 #include <Message_ProgressRange.hxx>
23
24 struct IMeshTools_Parameters;
25
26 //! Interface class providing API for algorithms intended to create mesh for discrete face.
27 class IMeshTools_MeshAlgo : public Standard_Transient
28 {
29 public:
30
31   //! Destructor.
32   Standard_EXPORT virtual ~IMeshTools_MeshAlgo()
33   {
34   }
35
36   //! Performs processing of the given face.
37   Standard_EXPORT virtual void Perform(
38     const IMeshData::IFaceHandle& theDFace,
39     const IMeshTools_Parameters&  theParameters,
40     const Message_ProgressRange&  theRange) = 0;
41
42   DEFINE_STANDARD_RTTI_INLINE(IMeshTools_MeshAlgo, Standard_Transient)
43
44 protected:
45
46   //! Constructor.
47   Standard_EXPORT IMeshTools_MeshAlgo()
48   {
49   }
50 };
51
52 #endif