include/opencascade/BRepAlgoAPI_Algo.hxx

0001 // Created by: Peter KURNEV
0002 // Copyright (c) 2014 OPEN CASCADE SAS
0003 //
0004 // This file is part of Open CASCADE Technology software library.
0005 //
0006 // This library is free software; you can redistribute it and/or modify it under
0007 // the terms of the GNU Lesser General Public License version 2.1 as published
0008 // by the Free Software Foundation, with special exception defined in the file
0009 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
0010 // distribution for complete text of the license and disclaimer of any warranty.
0011 //
0012 // Alternatively, this file may be used under the terms of Open CASCADE
0013 // commercial license or contractual agreement.
0014
0015 #ifndef _BRepAlgoAPI_Algo_HeaderFile
0016 #define _BRepAlgoAPI_Algo_HeaderFile
0017
0018 #include <Standard.hxx>
0019 #include <Standard_DefineAlloc.hxx>
0020 #include <Standard_Handle.hxx>
0021
0022 #include <Standard_Integer.hxx>
0023 #include <BRepBuilderAPI_MakeShape.hxx>
0024 #include <BOPAlgo_Options.hxx>
0025
0026 class TopoDS_Shape;
0027
0028 //! Provides the root interface for the API algorithms
0029
0030 class BRepAlgoAPI_Algo : public BRepBuilderAPI_MakeShape,
0031                          protected BOPAlgo_Options
0032 {
0033 public:
0034
0035   DEFINE_STANDARD_ALLOC
0036
0037   //! Returns a shape built by the shape construction algorithm.
0038   //! Does not check if the shape is built.
0039   Standard_EXPORT virtual const TopoDS_Shape& Shape() Standard_OVERRIDE;
0040
0041   // Provide access to methods of protected base class BOPAlgo_Options
0042   // (inherited as protected to avoid problems with SWIG wrapper)
0043   using BOPAlgo_Options::Clear;
0044   using BOPAlgo_Options::SetRunParallel;
0045   using BOPAlgo_Options::RunParallel;
0046   using BOPAlgo_Options::SetFuzzyValue;
0047   using BOPAlgo_Options::FuzzyValue;
0048   using BOPAlgo_Options::HasErrors;
0049   using BOPAlgo_Options::HasWarnings;
0050   using BOPAlgo_Options::HasError;
0051   using BOPAlgo_Options::HasWarning;
0052   using BOPAlgo_Options::DumpErrors;
0053   using BOPAlgo_Options::DumpWarnings;
0054   using BOPAlgo_Options::ClearWarnings;
0055   using BOPAlgo_Options::GetReport;
0056   using BOPAlgo_Options::SetUseOBB;
0057
0058 protected:
0059
0060   //! Empty constructor
0061   Standard_EXPORT BRepAlgoAPI_Algo();
0062
0063   //! Destructor
0064   Standard_EXPORT virtual ~BRepAlgoAPI_Algo();
0065
0066   //! Empty constructor
0067   Standard_EXPORT BRepAlgoAPI_Algo(const Handle(NCollection_BaseAllocator)& theAllocator);
0068
0069 private:
0070
0071 };
0072
0073 #endif // _BRepAlgoAPI_Algo_HeaderFile