include/opencascade/BRepSweep_Tool.hxx

0001 // Created on: 1993-06-08
0002 // Created by: Laurent BOURESCHE
0003 // Copyright (c) 1993-1999 Matra Datavision
0004 // Copyright (c) 1999-2014 OPEN CASCADE SAS
0005 //
0006 // This file is part of Open CASCADE Technology software library.
0007 //
0008 // This library is free software; you can redistribute it and/or modify it under
0009 // the terms of the GNU Lesser General Public License version 2.1 as published
0010 // by the Free Software Foundation, with special exception defined in the file
0011 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
0012 // distribution for complete text of the license and disclaimer of any warranty.
0013 //
0014 // Alternatively, this file may be used under the terms of Open CASCADE
0015 // commercial license or contractual agreement.
0016
0017 #ifndef _BRepSweep_Tool_HeaderFile
0018 #define _BRepSweep_Tool_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_DefineAlloc.hxx>
0022 #include <Standard_Handle.hxx>
0023
0024 #include <TopTools_ShapeMapHasher.hxx>
0025 #include <NCollection_IndexedMap.hxx>
0026 #include <TopAbs_ShapeEnum.hxx>
0027 #include <TopAbs_Orientation.hxx>
0028 class TopoDS_Shape;
0029
0030 //! Provides the indexation and type analysis services
0031 //! required by the TopoDS generating Shape of BRepSweep.
0032 class BRepSweep_Tool
0033 {
0034 public:
0035   DEFINE_STANDARD_ALLOC
0036
0037   //! Initialize the tool with <aShape>. The IndexTool
0038   //! must prepare an indexation for all the subshapes
0039   //! of this shape.
0040   Standard_EXPORT BRepSweep_Tool(const TopoDS_Shape& aShape);
0041
0042   //! Returns the number of subshapes in the shape.
0043   Standard_EXPORT int NbShapes() const;
0044
0045   //! Returns the index of <aShape>.
0046   Standard_EXPORT int Index(const TopoDS_Shape& aShape) const;
0047
0048   //! Returns the Shape at Index anIdex.
0049   Standard_EXPORT TopoDS_Shape Shape(const int anIndex) const;
0050
0051   //! Returns the type of <aShape>.
0052   Standard_EXPORT TopAbs_ShapeEnum Type(const TopoDS_Shape& aShape) const;
0053
0054   //! Returns the Orientation of <aShape>.
0055   Standard_EXPORT TopAbs_Orientation Orientation(const TopoDS_Shape& aShape) const;
0056
0057   //! Set the Orientation of <aShape> with Or.
0058   Standard_EXPORT void SetOrientation(TopoDS_Shape& aShape, const TopAbs_Orientation Or) const;
0059
0060 private:
0061   NCollection_IndexedMap<TopoDS_Shape, TopTools_ShapeMapHasher> myMap;
0062 };
0063
0064 #endif // _BRepSweep_Tool_HeaderFile