include/opencascade/Sweep_NumShape.hxx

0001 // Created on: 1993-02-03
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_NumShape_HeaderFile
0018 #define _Sweep_NumShape_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_DefineAlloc.hxx>
0022 #include <Standard_Handle.hxx>
0023
0024 #include <TopAbs_ShapeEnum.hxx>
0025 #include <Standard_Boolean.hxx>
0026 #include <TopAbs_Orientation.hxx>
0027
0028
0029 //! Gives    a  simple  indexed   representation  of a
0030 //! Directing Edge topology.
0031 class Sweep_NumShape
0032 {
0033 public:
0034
0035   DEFINE_STANDARD_ALLOC
0036
0037
0038   //! Creates a dummy indexed edge.
0039   Standard_EXPORT Sweep_NumShape();
0040
0041   //! Creates a new simple indexed edge.
0042   //!
0043   //! For an Edge : Index is the  number of vertices (0,
0044   //! 1 or 2),Type is TopAbs_EDGE, Closed  is true if it
0045   //! is a  closed edge, BegInf is true  if  the Edge is
0046   //! infinite at the  begenning, EndInf is true  if the
0047   //! edge is infinite at the end.
0048   //!
0049   //! For a Vertex : Index is the index of the vertex in
0050   //! the edge (1 or 2),  Type  is TopAbsVERTEX, all the
0051   //! other fields have no meanning.
0052   Standard_EXPORT Sweep_NumShape(const Standard_Integer Index, const TopAbs_ShapeEnum Type, const Standard_Boolean Closed = Standard_False, const Standard_Boolean BegInf = Standard_False, const Standard_Boolean EndInf = Standard_False);
0053
0054   //! Reinitialize a simple indexed edge.
0055   //!
0056   //! For an Edge : Index is the  number of vertices (0,
0057   //! 1 or 2),Type is TopAbs_EDGE, Closed  is true if it
0058   //! is a  closed edge, BegInf is true  if  the Edge is
0059   //! infinite at the  begenning, EndInf is true  if the
0060   //! edge is infinite at the end.
0061   //!
0062   //! For a Vertex : Index is the index of the vertex in
0063   //! the edge (1 or 2), Type is TopAbsVERTEX, Closed is
0064   //! true if it is the vertex of a closed edge, all the
0065   //! other fields have no meanning.
0066   Standard_EXPORT void Init (const Standard_Integer Index, const TopAbs_ShapeEnum Type, const Standard_Boolean Closed = Standard_False, const Standard_Boolean BegInf = Standard_False, const Standard_Boolean EndInf = Standard_False);
0067
0068     Standard_Integer Index() const;
0069
0070     TopAbs_ShapeEnum Type() const;
0071
0072     Standard_Boolean Closed() const;
0073
0074     Standard_Boolean BegInfinite() const;
0075
0076     Standard_Boolean EndInfinite() const;
0077
0078   Standard_EXPORT TopAbs_Orientation Orientation() const;
0079
0080
0081
0082
0083 protected:
0084
0085
0086
0087
0088
0089 private:
0090
0091
0092
0093   TopAbs_ShapeEnum myType;
0094   Standard_Integer myIndex;
0095   Standard_Boolean myClosed;
0096   Standard_Boolean myBegInf;
0097   Standard_Boolean myEndInf;
0098
0099
0100 };
0101
0102
0103 #include <Sweep_NumShape.lxx>
0104
0105
0106
0107
0108
0109 #endif // _Sweep_NumShape_HeaderFile