src/IMeshTools/IMeshTools_ModelBuilder.hxx

   1 // Created on: 2016-04-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_ModelBuilder_HeaderFile
  17 #define _IMeshTools_ModelBuilder_HeaderFile
  18
  19 #include <Message_Algorithm.hxx>
  20 #include <Standard_Type.hxx>
  21 #include <TopoDS_Shape.hxx>
  22
  23 class IMeshData_Model;
  24 struct IMeshTools_Parameters;
  25
  26 //! Interface class represents API for tool building discrete model.
  27 //!
  28 //! The following statuses should be used by default:
  29 //! Message_Done1 - model has been sucessfully built.
  30 //! Message_Fail1 - empty shape.
  31 //! Message_Fail2 - model has not been build due to unexpected reason.
  32 class IMeshTools_ModelBuilder : public Message_Algorithm
  33 {
  34 public:
  35
  36   //! Destructor.
  37   Standard_EXPORT virtual ~IMeshTools_ModelBuilder()
  38   {
  39   }
  40
  41   //! Creates discrete model for the given shape.
  42   //! Returns nullptr in case of failure.
  43   Standard_EXPORT virtual Handle (IMeshData_Model) Perform (
  44     const TopoDS_Shape&          theShape,
  45     const IMeshTools_Parameters& theParameters) = 0;
  46
  47   DEFINE_STANDARD_RTTI_INLINE(IMeshTools_ModelBuilder, Message_Algorithm)
  48
  49 protected:
  50
  51   //! Constructor.
  52   Standard_EXPORT IMeshTools_ModelBuilder()
  53   {
  54   }
  55 };
  56
  57 #endif