X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=src%2FModuleBase%2FModuleBase_ViewerFilters.h;h=7481d9f5d0a29f4ec0641d359431fd32404fb70b;hb=97917d3698f5a2f7fc9596e7c755ff8f6751e373;hp=d26d3db3ed617f5db6ab13a66eb4b4b47a5e048b;hpb=916cd9d11f7643ffdca1db94ba6d49cf581b2f66;p=modules%2Fshaper.git

diff --git a/src/ModuleBase/ModuleBase_ViewerFilters.h b/src/ModuleBase/ModuleBase_ViewerFilters.h
index d26d3db3e..7481d9f5d 100644
--- a/src/ModuleBase/ModuleBase_ViewerFilters.h
+++ b/src/ModuleBase/ModuleBase_ViewerFilters.h
@@ -1,20 +1,39 @@
-// File:        ModuleBase_ViewerFilters.h
-// Created:     07 Okt 2014
-// Author:      Vitaly SMETANNIKOV
-
+// Copyright (C) 2014-2019  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
+//
 
 #ifndef ModuleBase_ViewerFilters_H
 #define ModuleBase_ViewerFilters_H
 
+#include <QStringList>
+
 #include <SelectMgr_Filter.hxx>
 #include <SelectMgr_EntityOwner.hxx>
-#include <gp_Pln.hxx>
+
+#include <GeomAPI_Pln.h>
 
 
 class ModuleBase_IWorkshop;
 
 
 /**
+* \class ModuleBase_ShapeDocumentFilter
+* \ingroup GUI
 * A filter which provides filtering of selection in 3d viewer.
 * Installing of this filter lets to select objects which belong to 
 * currently active document or to global document
@@ -23,18 +42,27 @@ DEFINE_STANDARD_HANDLE(ModuleBase_ShapeDocumentFilter, SelectMgr_Filter);
 class ModuleBase_ShapeDocumentFilter: public SelectMgr_Filter
 {
 public:
-  Standard_EXPORT ModuleBase_ShapeDocumentFilter(ModuleBase_IWorkshop* theWorkshop): SelectMgr_Filter(),
+  /// Constructor
+  /// \param theWorkshop instance of workshop interface
+  Standard_EXPORT
+    ModuleBase_ShapeDocumentFilter(ModuleBase_IWorkshop* theWorkshop): SelectMgr_Filter(),
     myWorkshop(theWorkshop) {}
 
-  Standard_EXPORT virtual Standard_Boolean IsOk(const Handle(SelectMgr_EntityOwner)& theOwner) const;
+  /// Returns True if the given owner is acceptable for selection
+  /// \param theOwner the selected owner
+  Standard_EXPORT virtual
+    Standard_Boolean IsOk(const Handle(SelectMgr_EntityOwner)& theOwner) const;
 
-  DEFINE_STANDARD_RTTI(ModuleBase_ShapeDocumentFilter)
+  DEFINE_STANDARD_RTTIEXT(ModuleBase_ShapeDocumentFilter, SelectMgr_Filter)
 
-private:
+protected:
+  /// Reference to workshop
   ModuleBase_IWorkshop* myWorkshop;
 };
 
 /**
+* \class ModuleBase_ShapeInPlaneFilter
+* \ingroup GUI
 * A filter which provides filtering of selection in 3d viewer.
 * Installing of this filter lets to select of Vertexes and Edges which belongs to the given plane
 */
@@ -42,14 +70,25 @@ DEFINE_STANDARD_HANDLE(ModuleBase_ShapeInPlaneFilter, SelectMgr_Filter);
 class ModuleBase_ShapeInPlaneFilter: public SelectMgr_Filter
 {
 public:
-  Standard_EXPORT ModuleBase_ShapeInPlaneFilter(const gp_Pln& thePane): 
-      SelectMgr_Filter(), myPlane(thePane) {}
+  /// Constructor
+  Standard_EXPORT ModuleBase_ShapeInPlaneFilter(): SelectMgr_Filter() {}
+
+  /// Set working plane
+  /// \param thePlane a plane object
+  void setPlane(const std::shared_ptr<GeomAPI_Pln>& thePlane) { myPlane = thePlane; }
+
+  /// Returns current working plane
+  std::shared_ptr<GeomAPI_Pln> plane() const { return myPlane; }
 
-  Standard_EXPORT virtual Standard_Boolean IsOk(const Handle(SelectMgr_EntityOwner)& theOwner) const;
+  /// Returns True if the given owner is acceptable for selection
+  /// \param theOwner the selected owner
+  Standard_EXPORT virtual
+    Standard_Boolean IsOk(const Handle(SelectMgr_EntityOwner)& theOwner) const;
 
-  DEFINE_STANDARD_RTTI(ModuleBase_ShapeInPlaneFilter)
+  DEFINE_STANDARD_RTTIEXT(ModuleBase_ShapeInPlaneFilter, SelectMgr_Filter)
 private:
-  gp_Pln myPlane;
+  /// Working plane
+  std::shared_ptr<GeomAPI_Pln> myPlane;
 };
 
-#endif
\ No newline at end of file
+#endif