Finalization of the sketch drawer "Create dimensions" flag implemented

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

diff --git a/src/SketcherPrs/SketcherPrs_SensitivePoint.h b/src/SketcherPrs/SketcherPrs_SensitivePoint.h
index 033b81a0dabd7c8e1d18bd479d0fa23b45db7025..281c823a60ddcfac3ea22af4200add33f3d5e1f4 100644 (file)
--- a/src/SketcherPrs/SketcherPrs_SensitivePoint.h
+++ b/src/SketcherPrs/SketcherPrs_SensitivePoint.h
@@ -1,8 +1,22 @@
-// Copyright (C) 2014-20xx CEA/DEN, EDF R&D
-
-// File:        SketcherPrs_SensitivePoint.h
-// Created:     24 March 2015
-// Author:      Vitaly SMETANNIKOV
+// Copyright (C) 2014-2017  CEA/DEN, EDF R&D
+//
+// This library is free software; you can redistribute it and/or
+// modify it under the terms of the GNU Lesser General Public
+// License as published by the Free Software Foundation; either
+// version 2.1 of the License, or (at your option) any later version.
+//
+// This library is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+// Lesser General Public License for more details.
+//
+// You should have received a copy of the GNU Lesser General Public
+// License along with this library; if not, write to the Free Software
+// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+//
+// See http://www.salome-platform.org/ or
+// email : webmaster.salome@opencascade.com<mailto:webmaster.salome@opencascade.com>
+//
 
 #ifndef SketcherPrs_SensitivePoint_H
 #define SketcherPrs_SensitivePoint_H
@@ -20,20 +34,24 @@ DEFINE_STANDARD_HANDLE(SketcherPrs_SensitivePoint, Select3D_SensitiveEntity)
 */
 class SketcherPrs_SensitivePoint : public Select3D_SensitiveEntity
 {
-public: 
+public:
   //! Constructs a sensitive point object defined by the
-  //! owner OwnerId and the point Point.
-  Standard_EXPORT SketcherPrs_SensitivePoint(const Handle(SelectBasics_EntityOwner)& OwnerId, int theId);
-  
+  //! \param OwnerId an Id of the Owner.
+  //! \param theId and Id of its point
+  Standard_EXPORT SketcherPrs_SensitivePoint(const Handle(SelectBasics_EntityOwner)& OwnerId,
+                                             int theId);
+
+  /// Returns number of sub-elements
   Standard_EXPORT virtual Standard_Integer NbSubElements() Standard_OVERRIDE;
 
   //! Update location of the point
-  //! \param aLocation a new location
   Standard_EXPORT virtual Handle(Select3D_SensitiveEntity) GetConnected() Standard_OVERRIDE;
 
   //! Checks whether the point overlaps current selecting volume
-  Standard_EXPORT virtual Standard_Boolean Matches (SelectBasics_SelectingVolumeManager& theMgr,
-                                                    SelectBasics_PickResult& thePickResult) Standard_OVERRIDE;
+  //! \param theMgr selection manager
+  //! \param thePickResult returns pick result
+  Standard_EXPORT virtual Standard_Boolean Matches(SelectBasics_SelectingVolumeManager& theMgr,
+                                     SelectBasics_PickResult& thePickResult) Standard_OVERRIDE;
 
   //! Returns the point used at the time of construction.
   Standard_EXPORT gp_Pnt Point() const;
@@ -46,11 +64,12 @@ public:
   //! transformation is set, it will be applied
   Standard_EXPORT virtual Select3D_BndBox3d BoundingBox() Standard_OVERRIDE;
 
+  /// Clear sub-elements
   Standard_EXPORT virtual void Clear() Standard_OVERRIDE;
 
-  DEFINE_STANDARD_RTTI(SketcherPrs_SensitivePoint)
+  DEFINE_STANDARD_RTTIEXT(SketcherPrs_SensitivePoint, Select3D_SensitiveEntity)
 
-private: 
+private:
   int myId;
 };