src/StdPrs/StdPrs_ToolRFace.hxx

   1 // Created on: 1993-01-26
   2 // Created by: Jean-Louis FRENKEL
   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 _StdPrs_ToolRFace_HeaderFile
  18 #define _StdPrs_ToolRFace_HeaderFile
  19
  20 #include <Standard.hxx>
  21 #include <Standard_DefineAlloc.hxx>
  22 #include <Standard_Handle.hxx>
  23
  24 #include <TopoDS_Face.hxx>
  25 #include <TopExp_Explorer.hxx>
  26 #include <Geom2dAdaptor_Curve.hxx>
  27 #include <TopAbs_Orientation.hxx>
  28 class BRepAdaptor_HSurface;
  29
  30 //! Iterator over 2D curves restricting a face (skipping internal/external edges).
  31 //! In addition, the algorithm skips NULL curves - IsInvalidGeometry() can be checked if this should be handled within algorithm.
  32 class StdPrs_ToolRFace
  33 {
  34 public:
  35
  36   DEFINE_STANDARD_ALLOC
  37
  38   //! Empty constructor.
  39   Standard_EXPORT StdPrs_ToolRFace();
  40
  41   //! Constructor with initialization.
  42   Standard_EXPORT StdPrs_ToolRFace(const Handle(BRepAdaptor_HSurface)& aSurface);
  43
  44   //! Return TRUE indicating that iterator looks only for oriented edges.
  45   Standard_Boolean IsOriented() const { return Standard_True; }
  46
  47   //! Move iterator to the first element.
  48   void Init()
  49   {
  50     myExplorer.Init (myFace, TopAbs_EDGE);
  51     next();
  52   }
  53
  54   //! Return TRUE if iterator points to the curve.
  55   Standard_Boolean More() const { return myExplorer.More(); }
  56
  57   //! Go to the next curve in the face.
  58   void Next()
  59   {
  60     myExplorer.Next();
  61     next();
  62   }
  63
  64   //! Return current curve.
  65   const Adaptor2d_Curve2d& Value() const { return myCurve; }
  66
  67   //! Return current edge orientation.
  68   TopAbs_Orientation Orientation() const { return myExplorer.Current().Orientation(); }
  69
  70   //! Return TRUE if NULL curves have been skipped.
  71   Standard_Boolean IsInvalidGeometry() const { return myHasNullCurves; }
  72
  73 private:
  74
  75   //! Find nearest valid item for the iterator.
  76   Standard_EXPORT void next();
  77
  78 private:
  79
  80   TopoDS_Face myFace;
  81   TopExp_Explorer myExplorer;
  82   Geom2dAdaptor_Curve myCurve;
  83   Standard_Boolean myHasNullCurves;
  84
  85 };
  86
  87 #endif // _StdPrs_ToolRFace_HeaderFile