Fix for the issue #593: do not remove naming attribute, but use TNaming_Builder for...

[modules/shaper.git] / src / SketcherPrs / SketcherPrs_SensitivePoint.h

diff --git a/src/SketcherPrs/SketcherPrs_SensitivePoint.h b/src/SketcherPrs/SketcherPrs_SensitivePoint.h
index bc3628b8a256d39f1cec6b81f8d64d2efa0e4e33..ca30fe4344b58f39f5bad8b54deb50c30c475e2e 100644 (file)
--- a/src/SketcherPrs/SketcherPrs_SensitivePoint.h
+++ b/src/SketcherPrs/SketcherPrs_SensitivePoint.h
@@ -15,6 +15,11 @@
 
 DEFINE_STANDARD_HANDLE(SketcherPrs_SensitivePoint, Select3D_SensitiveEntity)
 
+/**
+* \ingroup GUI
+* This sensitive point is done in order to optimize process of the sinzitive area update
+* It referes on point array directly and this lets to avoid procedure of the point synchronisation
+*/
 class SketcherPrs_SensitivePoint : public Select3D_SensitiveEntity
 {
 public: 
@@ -31,6 +36,8 @@ public:
   //! the point area in the selection process.
   Standard_EXPORT   void Areas (SelectBasics_ListOfBox2d& aresult) ;
   
+  //! Update location of the point
+  //! \param aLocation a new location
   Standard_EXPORT   Handle(Select3D_SensitiveEntity) GetConnected (const TopLoc_Location& aLocation) ;
   
   //! Checks whether the sensitive entity matches the picking
@@ -38,6 +45,12 @@ public:
   //! For details please refer to base class declaration.
   Standard_EXPORT   Standard_Boolean Matches (const SelectBasics_PickArgs& thePickArgs, Standard_Real& theMatchDMin, Standard_Real& theMatchDepth) ;
   
+  /// Returns true if the current point is matches with given rectangle
+  /// \param XMin an X min coordinate
+  /// \param YMin an Y min coordinate
+  /// \param XMax an X max coordinate
+  /// \param YMax an Y max coordinate
+  /// \param aTol a tolerance
   Standard_EXPORT   Standard_Boolean Matches (const Standard_Real XMin, const Standard_Real YMin, const Standard_Real XMax, const Standard_Real YMax, const Standard_Real aTol) ;
   
   Standard_EXPORT virtual   Standard_Boolean Matches (const TColgp_Array1OfPnt2d& Polyline, const Bnd_Box2d& aBox, const Standard_Real aTol) ;