507324cd8ec797e283afa620cc05657ccdcaf847
[occt.git] / src / MAT2d / MAT2d_SketchExplorer.hxx
1 // Created on: 1993-07-12
2 // Created by: Yves FRICAUD
3 // Copyright (c) 1993-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 _MAT2d_SketchExplorer_HeaderFile
18 #define _MAT2d_SketchExplorer_HeaderFile
19
20 #include <Standard.hxx>
21 #include <Standard_DefineAlloc.hxx>
22 #include <Standard_Handle.hxx>
23
24 #include <Standard_Integer.hxx>
25 #include <Standard_Boolean.hxx>
26 class Geom2d_Curve;
27
28
29 //! SketchExplorer  is  an iterator on  a  sketch.   A
30 //! sketch is a set of contours, each contour is a set
31 //! of curves from Geom2d.
32 //! It's use by BisectingLocus.
33 class MAT2d_SketchExplorer 
34 {
35 public:
36
37   DEFINE_STANDARD_ALLOC
38
39   
40   //! Returns the number of contours in the figure.
41   Standard_EXPORT Standard_Integer NumberOfContours() const;
42   
43   //! Initializes the curves explorer on the contour
44   //! of range <ContourIndex>.
45   Standard_EXPORT void Init (const Standard_Integer ContourIndex);
46   
47   //! Returns False if  there is no  more curves on the
48   //! current contour.
49   Standard_EXPORT Standard_Boolean More() const;
50   
51   //! Moves to the next curve of the current contour.
52   Standard_EXPORT void Next();
53   
54   //! Returns the current curve on the current contour.
55   Standard_EXPORT Handle(Geom2d_Curve) Value() const;
56
57
58
59
60 protected:
61
62
63
64
65
66 private:
67
68
69
70
71
72 };
73
74
75
76
77
78
79
80 #endif // _MAT2d_SketchExplorer_HeaderFile