[occt.git] / src / BOPAlgo / BOPAlgo_ToolsProvider.hxx

// Created by: Oleg AGASHIN
// Copyright (c) 2017 OPEN CASCADE SAS
//
// This file is part of Open CASCADE Technology software library.
//
// This library is free software; you can redistribute it and/or modify it under
// the terms of the GNU Lesser General Public License version 2.1 as published
// by the Free Software Foundation, with special exception defined in the file
// OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
// distribution for complete text of the license and disclaimer of any warranty.
//
// Alternatively, this file may be used under the terms of Open CASCADE
// commercial license or contractual agreement. 

#ifndef _BOPAlgo_ToolsProvider_HeaderFile
#define _BOPAlgo_ToolsProvider_HeaderFile

#include <Standard.hxx>
#include <Standard_DefineAlloc.hxx>
#include <Standard_Handle.hxx>

#include <BOPAlgo_Builder.hxx>

//! Auxiliary class providing API to operate tool arguments.
class BOPAlgo_ToolsProvider : public BOPAlgo_Builder
{
public:

  DEFINE_STANDARD_ALLOC

  //! Empty constructor
  Standard_EXPORT BOPAlgo_ToolsProvider();

  Standard_EXPORT BOPAlgo_ToolsProvider(const Handle(NCollection_BaseAllocator)& theAllocator);

  //! Clears internal fields and arguments
  Standard_EXPORT virtual void Clear() Standard_OVERRIDE;

  //! Adds Tool argument of the operation
  Standard_EXPORT virtual void AddTool(const TopoDS_Shape& theShape);

  //! Adds the Tool arguments of the operation
  Standard_EXPORT virtual void SetTools(const TopTools_ListOfShape& theShapes);

  //! Returns the Tool arguments of the operation
  const TopTools_ListOfShape& Tools() const
  {
    return myTools;
  }

protected:

  TopTools_ListOfShape myTools;
  TopTools_MapOfShape  myMapTools;
};

#endif // _BOPAlgo_ToolsProvider_HeaderFile
Commit	Line	Data
5fbe3d01	1	// Created by: Oleg AGASHIN
	2	// Copyright (c) 2017 OPEN CASCADE SAS
	3	//
	4	// This file is part of Open CASCADE Technology software library.
	5	//
	6	// This library is free software; you can redistribute it and/or modify it under
	7	// the terms of the GNU Lesser General Public License version 2.1 as published
	8	// by the Free Software Foundation, with special exception defined in the file
	9	// OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
	10	// distribution for complete text of the license and disclaimer of any warranty.
	11	//
	12	// Alternatively, this file may be used under the terms of Open CASCADE
	13	// commercial license or contractual agreement.
	14
	15	#ifndef _BOPAlgo_ToolsProvider_HeaderFile
	16	#define _BOPAlgo_ToolsProvider_HeaderFile
	17
	18	#include <Standard.hxx>
	19	#include <Standard_DefineAlloc.hxx>
	20	#include <Standard_Handle.hxx>
	21
	22	#include <BOPAlgo_Builder.hxx>
	23
	24	//! Auxiliary class providing API to operate tool arguments.
	25	class BOPAlgo_ToolsProvider : public BOPAlgo_Builder
	26	{
	27	public:
	28
	29	DEFINE_STANDARD_ALLOC
	30
	31	//! Empty constructor
	32	Standard_EXPORT BOPAlgo_ToolsProvider();
	33
1155d05a	34	Standard_EXPORT BOPAlgo_ToolsProvider(const Handle(NCollection_BaseAllocator)& theAllocator);
5fbe3d01	35
	36	//! Clears internal fields and arguments
	37	Standard_EXPORT virtual void Clear() Standard_OVERRIDE;
	38
	39	//! Adds Tool argument of the operation
	40	Standard_EXPORT virtual void AddTool(const TopoDS_Shape& theShape);
	41
	42	//! Adds the Tool arguments of the operation
1155d05a	43	Standard_EXPORT virtual void SetTools(const TopTools_ListOfShape& theShapes);
5fbe3d01	44
5fbe3d01	45	//! Returns the Tool arguments of the operation
1155d05a	46	const TopTools_ListOfShape& Tools() const
5fbe3d01	47	{
	48	return myTools;
	49	}
	50
	51	protected:
	52
1155d05a	53	TopTools_ListOfShape myTools;
1155d05a	54	TopTools_MapOfShape myMapTools;
5fbe3d01	55	};
	56
	57	#endif // _BOPAlgo_ToolsProvider_HeaderFile