0031939: Coding - correction of spelling errors in comments [part 10]
[occt.git] / src / HLRBRep / HLRBRep_VertexList.hxx
CommitLineData
42cf5bc1 1// Created on: 1997-04-17
2// Created by: Christophe MARION
3// Copyright (c) 1997-1999 Matra Datavision
4// Copyright (c) 1999-2014 OPEN CASCADE SAS
5//
6// This file is part of Open CASCADE Technology software library.
7//
8// This library is free software; you can redistribute it and/or modify it under
9// the terms of the GNU Lesser General Public License version 2.1 as published
10// by the Free Software Foundation, with special exception defined in the file
11// OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
12// distribution for complete text of the license and disclaimer of any warranty.
13//
14// Alternatively, this file may be used under the terms of Open CASCADE
15// commercial license or contractual agreement.
16
17#ifndef _HLRBRep_VertexList_HeaderFile
18#define _HLRBRep_VertexList_HeaderFile
19
20#include <Standard.hxx>
21#include <Standard_DefineAlloc.hxx>
22#include <Standard_Handle.hxx>
23
24#include <HLRAlgo_ListIteratorOfInterferenceList.hxx>
25#include <HLRBRep_EdgeInterferenceTool.hxx>
26#include <Standard_Boolean.hxx>
27#include <TopAbs_Orientation.hxx>
28class HLRBRep_EdgeInterferenceTool;
29class HLRAlgo_Intersection;
30
31
32
33class HLRBRep_VertexList
34{
35public:
36
37 DEFINE_STANDARD_ALLOC
38
39
40 Standard_EXPORT HLRBRep_VertexList(const HLRBRep_EdgeInterferenceTool& T, const HLRAlgo_ListIteratorOfInterferenceList& I);
41
42 //! Returns True when the curve is periodic.
43 Standard_EXPORT Standard_Boolean IsPeriodic() const;
44
45 //! Returns True when there are more vertices.
46 Standard_EXPORT Standard_Boolean More() const;
47
48 //! Proceeds to the next vertex.
49 Standard_EXPORT void Next();
50
51 //! Returns the current vertex
52 Standard_EXPORT const HLRAlgo_Intersection& Current() const;
53
316ea293 54 //! Returns True if the current vertex is on the boundary of the edge.
42cf5bc1 55 Standard_EXPORT Standard_Boolean IsBoundary() const;
56
57 //! Returns True if the current vertex is an
58 //! interference.
59 Standard_EXPORT Standard_Boolean IsInterference() const;
60
61 //! Returns the orientation of the current vertex if
62 //! it is on the boundary of the edge.
63 Standard_EXPORT TopAbs_Orientation Orientation() const;
64
65 //! Returns the transition of the current vertex if
66 //! it is an interference.
67 Standard_EXPORT TopAbs_Orientation Transition() const;
68
69 //! Returns the transition of the current vertex
70 //! relative to the boundary if it is an interference.
71 Standard_EXPORT TopAbs_Orientation BoundaryTransition() const;
72
73
74
75
76protected:
77
78
79
80
81
82private:
83
84
85
86 HLRAlgo_ListIteratorOfInterferenceList myIterator;
87 HLRBRep_EdgeInterferenceTool myTool;
88 Standard_Boolean fromEdge;
89 Standard_Boolean fromInterf;
90
91
92};
93
94
95
96
97
98
99
100#endif // _HLRBRep_VertexList_HeaderFile