include/opencascade/HatchGen_PointOnHatching.hxx

0001 // Created on: 1993-10-29
0002 // Created by: Jean Marc LACHAUME
0003 // Copyright (c) 1993-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 _HatchGen_PointOnHatching_HeaderFile
0018 #define _HatchGen_PointOnHatching_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_DefineAlloc.hxx>
0022 #include <Standard_Handle.hxx>
0023
0024 #include <HatchGen_PointOnElement.hxx>
0025 #include <NCollection_Sequence.hxx>
0026 #include <HatchGen_IntersectionPoint.hxx>
0027 #include <Standard_Boolean.hxx>
0028 class IntRes2d_IntersectionPoint;
0029 class HatchGen_PointOnElement;
0030
0031 class HatchGen_PointOnHatching : public HatchGen_IntersectionPoint
0032 {
0033 public:
0034   DEFINE_STANDARD_ALLOC
0035
0036   //! Creates an empty point.
0037   Standard_EXPORT HatchGen_PointOnHatching();
0038
0039   //! Creates a point from an intersection point.
0040   Standard_EXPORT HatchGen_PointOnHatching(const IntRes2d_IntersectionPoint& Point);
0041
0042   //! Adds a point on element to the point.
0043   Standard_EXPORT void AddPoint(const HatchGen_PointOnElement& Point, const double Confusion);
0044
0045   //! Returns the number of elements intersecting the
0046   //! hatching at this point.
0047   Standard_EXPORT int NbPoints() const;
0048
0049   //! Returns the Index-th point on element of the point.
0050   //! The exception OutOfRange is raised if
0051   //! Index > NbPoints.
0052   Standard_EXPORT const HatchGen_PointOnElement& Point(const int Index) const;
0053
0054   //! Removes the Index-th point on element of the point.
0055   //! The exception OutOfRange is raised if
0056   //! Index > NbPoints.
0057   Standard_EXPORT void RemPoint(const int Index);
0058
0059   //! Removes all the points on element of the point.
0060   Standard_EXPORT void ClrPoints();
0061
0062   //! Tests if the point is lower than an other.
0063   //! A point on hatching P1 is said to be lower than an
0064   //! other P2 if :
0065   //! P2.myParam - P1.myParam > Confusion
0066   Standard_EXPORT bool IsLower(const HatchGen_PointOnHatching& Point, const double Confusion) const;
0067
0068   //! Tests if the point is equal to an other.
0069   //! A point on hatching P1 is said to be equal to an
0070   //! other P2 if :
0071   //! | P2.myParam - P1.myParam | <= Confusion
0072   Standard_EXPORT bool IsEqual(const HatchGen_PointOnHatching& Point, const double Confusion) const;
0073
0074   //! Tests if the point is greater than an other.
0075   //! A point on hatching P1 is said to be greater than an
0076   //! other P2 if :
0077   //! P1.myParam - P2.myParam > Confusion
0078   Standard_EXPORT bool IsGreater(const HatchGen_PointOnHatching& Point,
0079                                  const double                    Confusion) const;
0080
0081   //! Dump of the point.
0082   Standard_EXPORT void Dump(const int Index = 0) const override;
0083
0084 protected:
0085   NCollection_Sequence<HatchGen_PointOnElement> myPoints;
0086 };
0087
0088 #endif // _HatchGen_PointOnHatching_HeaderFile