src/HatchGen/HatchGen_PointOnHatching.hxx

   1 // Created on: 1993-10-29
   2 // Created by: Jean Marc LACHAUME
   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 _HatchGen_PointOnHatching_HeaderFile
  18 #define _HatchGen_PointOnHatching_HeaderFile
  19
  20 #include <Standard.hxx>
  21 #include <Standard_DefineAlloc.hxx>
  22 #include <Standard_Handle.hxx>
  23
  24 #include <HatchGen_PointsOnElement.hxx>
  25 #include <HatchGen_IntersectionPoint.hxx>
  26 #include <Standard_Real.hxx>
  27 #include <Standard_Integer.hxx>
  28 #include <Standard_Boolean.hxx>
  29 class Standard_OutOfRange;
  30 class IntRes2d_IntersectionPoint;
  31 class HatchGen_PointOnElement;
  32
  33
  34
  35 class HatchGen_PointOnHatching  : public HatchGen_IntersectionPoint
  36 {
  37 public:
  38
  39   DEFINE_STANDARD_ALLOC
  40
  41
  42   //! Creates an empty point.
  43   Standard_EXPORT HatchGen_PointOnHatching();
  44
  45   //! Creates a point from an intersection point.
  46   Standard_EXPORT HatchGen_PointOnHatching(const IntRes2d_IntersectionPoint& Point);
  47
  48   //! Adds a point on element to the point.
  49   Standard_EXPORT void AddPoint (const HatchGen_PointOnElement& Point, const Standard_Real Confusion);
  50
  51   //! Returns the number of elements intersecting the
  52   //! hatching at this point.
  53   Standard_EXPORT Standard_Integer NbPoints() const;
  54
  55   //! Returns the Index-th point on element of the point.
  56   //! The exception OutOfRange is raised if
  57   //! Index > NbPoints.
  58   Standard_EXPORT const HatchGen_PointOnElement& Point (const Standard_Integer Index) const;
  59
  60   //! Removes the Index-th point on element of the point.
  61   //! The exception OutOfRange is raised if
  62   //! Index > NbPoints.
  63   Standard_EXPORT void RemPoint (const Standard_Integer Index);
  64
  65   //! Removes all the points on element of the point.
  66   Standard_EXPORT void ClrPoints();
  67
  68   //! Tests if the point is lower than an other.
  69   //! A point on hatching P1 is said to be lower than an
  70   //! other P2 if :
  71   //! P2.myParam - P1.myParam > Confusion
  72   Standard_EXPORT Standard_Boolean IsLower (const HatchGen_PointOnHatching& Point, const Standard_Real Confusion) const;
  73
  74   //! Tests if the  point is equal to an other.
  75   //! A  point on hatching P1 is said to be equal to an
  76   //! other P2 if :
  77   //! | P2.myParam - P1.myParam | <= Confusion
  78   Standard_EXPORT Standard_Boolean IsEqual (const HatchGen_PointOnHatching& Point, const Standard_Real Confusion) const;
  79
  80   //! Tests if the point is greater than an other.
  81   //! A point on hatching P1 is said to be greater than an
  82   //! other P2 if :
  83   //! P1.myParam - P2.myParam > Confusion
  84   Standard_EXPORT Standard_Boolean IsGreater (const HatchGen_PointOnHatching& Point, const Standard_Real Confusion) const;
  85
  86   //! Dump of the point.
  87   Standard_EXPORT void Dump (const Standard_Integer Index = 0) const;
  88
  89
  90
  91
  92 protected:
  93
  94
  95
  96   HatchGen_PointsOnElement myPoints;
  97
  98
  99 private:
 100
 101
 102
 103
 104
 105 };
 106
 107
 108
 109
 110
 111
 112
 113 #endif // _HatchGen_PointOnHatching_HeaderFile