include/opencascade/BOPAlgo_ToolsProvider.hxx

0001 // Created by: Oleg AGASHIN
0002 // Copyright (c) 2017 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 _BOPAlgo_ToolsProvider_HeaderFile
0016 #define _BOPAlgo_ToolsProvider_HeaderFile
0017
0018 #include <Standard.hxx>
0019 #include <Standard_DefineAlloc.hxx>
0020 #include <Standard_Handle.hxx>
0021
0022 #include <BOPAlgo_Builder.hxx>
0023
0024 //! Auxiliary class providing API to operate tool arguments.
0025 class BOPAlgo_ToolsProvider : public BOPAlgo_Builder
0026 {
0027 public:
0028
0029   DEFINE_STANDARD_ALLOC
0030
0031   //! Empty constructor
0032   Standard_EXPORT BOPAlgo_ToolsProvider();
0033
0034   Standard_EXPORT BOPAlgo_ToolsProvider(const Handle(NCollection_BaseAllocator)& theAllocator);
0035
0036   //! Clears internal fields and arguments
0037   Standard_EXPORT virtual void Clear() Standard_OVERRIDE;
0038
0039   //! Adds Tool argument of the operation
0040   Standard_EXPORT virtual void AddTool(const TopoDS_Shape& theShape);
0041
0042   //! Adds the Tool arguments of the operation
0043   Standard_EXPORT virtual void SetTools(const TopTools_ListOfShape& theShapes);
0044
0045   //! Returns the Tool arguments of the operation
0046   const TopTools_ListOfShape& Tools() const
0047   {
0048     return myTools;
0049   }
0050
0051 protected:
0052
0053   TopTools_ListOfShape myTools;
0054   TopTools_MapOfShape  myMapTools;
0055 };
0056
0057 #endif // _BOPAlgo_ToolsProvider_HeaderFile