include/opencascade/HLRBRep_VertexList.hxx

0001 // Created on: 1997-04-17
0002 // Created by: Christophe MARION
0003 // Copyright (c) 1997-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 _HLRBRep_VertexList_HeaderFile
0018 #define _HLRBRep_VertexList_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_DefineAlloc.hxx>
0022 #include <Standard_Handle.hxx>
0023
0024 #include <HLRAlgo_Interference.hxx>
0025
0026 #include <NCollection_List.hxx>
0027 #include <HLRBRep_EdgeInterferenceTool.hxx>
0028 #include <Standard_Boolean.hxx>
0029 #include <TopAbs_Orientation.hxx>
0030 class HLRAlgo_Intersection;
0031
0032 class HLRBRep_VertexList
0033 {
0034 public:
0035   DEFINE_STANDARD_ALLOC
0036
0037   Standard_EXPORT HLRBRep_VertexList(const HLRBRep_EdgeInterferenceTool&                     T,
0038                                      const NCollection_List<HLRAlgo_Interference>::Iterator& I);
0039
0040   //! Returns True when the curve is periodic.
0041   Standard_EXPORT bool IsPeriodic() const;
0042
0043   //! Returns True when there are more vertices.
0044   Standard_EXPORT bool More() const;
0045
0046   //! Proceeds to the next vertex.
0047   Standard_EXPORT void Next();
0048
0049   //! Returns the current vertex
0050   Standard_EXPORT const HLRAlgo_Intersection& Current() const;
0051
0052   //! Returns True if the current vertex is on the boundary of the edge.
0053   Standard_EXPORT bool IsBoundary() const;
0054
0055   //! Returns True if the current vertex is an
0056   //! interference.
0057   Standard_EXPORT bool IsInterference() const;
0058
0059   //! Returns the orientation of the current vertex if
0060   //! it is on the boundary of the edge.
0061   Standard_EXPORT TopAbs_Orientation Orientation() const;
0062
0063   //! Returns the transition of the current vertex if
0064   //! it is an interference.
0065   Standard_EXPORT TopAbs_Orientation Transition() const;
0066
0067   //! Returns the transition of the current vertex
0068   //! relative to the boundary if it is an interference.
0069   Standard_EXPORT TopAbs_Orientation BoundaryTransition() const;
0070
0071 private:
0072   NCollection_List<HLRAlgo_Interference>::Iterator myIterator;
0073   HLRBRep_EdgeInterferenceTool                     myTool;
0074   bool                                             fromEdge;
0075   bool                                             fromInterf;
0076 };
0077
0078 #endif // _HLRBRep_VertexList_HeaderFile