X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=src%2FModuleBase%2FModuleBase_ViewerFilters.h;h=58cc0e137831c32055ac02c5b7a4ad522ecff72d;hb=38dd97c8f7a3605ec6c362c3aefdefa3ee2675be;hp=4860776f4126689ef296c0244e619a5c2d49469c;hpb=a7f44a41bdf29e7bd978ff3b8c8bd514d1223be7;p=modules%2Fshaper.git

diff --git a/src/ModuleBase/ModuleBase_ViewerFilters.h b/src/ModuleBase/ModuleBase_ViewerFilters.h
index 4860776f4..58cc0e137 100644
--- a/src/ModuleBase/ModuleBase_ViewerFilters.h
+++ b/src/ModuleBase/ModuleBase_ViewerFilters.h
@@ -1,3 +1,5 @@
+// Copyright (C) 2014-20xx CEA/DEN, EDF R&D
+
 // File:        ModuleBase_ViewerFilters.h
 // Created:     07 Okt 2014
 // Author:      Vitaly SMETANNIKOV
@@ -10,13 +12,16 @@
 
 #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
@@ -25,18 +30,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)
 
 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
 */
@@ -44,35 +58,25 @@ DEFINE_STANDARD_HANDLE(ModuleBase_ShapeInPlaneFilter, SelectMgr_Filter);
 class ModuleBase_ShapeInPlaneFilter: public SelectMgr_Filter
 {
 public:
+  /// Constructor
   Standard_EXPORT ModuleBase_ShapeInPlaneFilter(): SelectMgr_Filter() {}
 
-  void setPlane(const gp_Pln& thePane) { myPlane = thePane; }
-  gp_Pln plane() const { return myPlane; }
-
-  Standard_EXPORT virtual Standard_Boolean IsOk(const Handle(SelectMgr_EntityOwner)& theOwner) const;
-
-  DEFINE_STANDARD_RTTI(ModuleBase_ShapeInPlaneFilter)
-private:
-  gp_Pln myPlane;
-};
-
+  /// Set working plane
+  /// \param thePlane a plane object
+  void setPlane(const std::shared_ptr<GeomAPI_Pln>& thePlane) { myPlane = thePlane; }
 
-/**
-* A filter which provides filtering of selection in 3d viewer.
-* Installing of this filter lets to select only object of requested type
-*/
-DEFINE_STANDARD_HANDLE(ModuleBase_ObjectTypesFilter, SelectMgr_Filter);
-class ModuleBase_ObjectTypesFilter: public ModuleBase_ShapeDocumentFilter
-{
-public:
-  Standard_EXPORT ModuleBase_ObjectTypesFilter(ModuleBase_IWorkshop* theWorkshop, const QStringList& theTypes): 
-      ModuleBase_ShapeDocumentFilter(theWorkshop), myTypes(theTypes) {}
+  /// 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_ObjectTypesFilter)
+  DEFINE_STANDARD_RTTIEXT(ModuleBase_ShapeInPlaneFilter, SelectMgr_Filter)
 private:
-  QStringList myTypes;
+  /// Working plane
+  std::shared_ptr<GeomAPI_Pln> myPlane;
 };
 
-#endif
\ No newline at end of file
+#endif