include/opencascade/Sweep_NumShapeTool.hxx

0001 // Created on: 1993-06-02
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 _Sweep_NumShapeTool_HeaderFile
0018 #define _Sweep_NumShapeTool_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_DefineAlloc.hxx>
0022
0023 #include <Sweep_NumShape.hxx>
0024 #include <Standard_Integer.hxx>
0025 #include <TopAbs_ShapeEnum.hxx>
0026 #include <TopAbs_Orientation.hxx>
0027
0028
0029 //! This class provides  the indexation and  type analysis
0030 //! services required by  the NumShape Directing Shapes of
0031 //! Swept Primitives.
0032 class Sweep_NumShapeTool
0033 {
0034 public:
0035
0036   DEFINE_STANDARD_ALLOC
0037
0038
0039   //! Create a new NumShapeTool with <aShape>.  The Tool
0040   //! must prepare an indexation  for  all the subshapes
0041   //! of this shape.
0042   Standard_EXPORT Sweep_NumShapeTool(const Sweep_NumShape& aShape);
0043
0044   //! Returns the number of subshapes in the shape.
0045   Standard_EXPORT Standard_Integer NbShapes() const;
0046
0047   //! Returns the index of <aShape>.
0048   Standard_EXPORT Standard_Integer Index (const Sweep_NumShape& aShape) const;
0049
0050   //! Returns the Shape at index anIndex
0051   Standard_EXPORT Sweep_NumShape Shape (const Standard_Integer anIndex) const;
0052
0053   //! Returns the type of <aShape>.
0054   Standard_EXPORT TopAbs_ShapeEnum Type (const Sweep_NumShape& aShape) const;
0055
0056   //! Returns the orientation of <aShape>.
0057   Standard_EXPORT TopAbs_Orientation Orientation (const Sweep_NumShape& aShape) const;
0058
0059   //! Returns true if there is a First Vertex in the Shape.
0060   Standard_EXPORT Standard_Boolean HasFirstVertex() const;
0061
0062   //! Returns true if there is a Last Vertex in the Shape.
0063   Standard_EXPORT Standard_Boolean HasLastVertex() const;
0064
0065   //! Returns the first vertex.
0066   Standard_EXPORT Sweep_NumShape FirstVertex() const;
0067
0068   //! Returns the last vertex.
0069   Standard_EXPORT Sweep_NumShape LastVertex() const;
0070
0071
0072
0073
0074 protected:
0075
0076
0077
0078
0079
0080 private:
0081
0082
0083
0084   Sweep_NumShape myNumShape;
0085
0086
0087 };
0088
0089
0090
0091
0092
0093
0094
0095 #endif // _Sweep_NumShapeTool_HeaderFile