Issue #559: Control doesn't have variable if its text is empty

[modules/shaper.git] / src / ModuleBase / ModuleBase_ViewerFilters.h

diff --git a/src/ModuleBase/ModuleBase_ViewerFilters.h b/src/ModuleBase/ModuleBase_ViewerFilters.h
index e4aa93ae29b299bc3713a20f0424f7d5f6f1f712..a5d404ee81a84d850261c5a506c4244e8cd2b57e 100644 (file)
--- 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
@@ -17,6 +19,8 @@ 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 +29,25 @@ DEFINE_STANDARD_HANDLE(ModuleBase_ShapeDocumentFilter, SelectMgr_Filter);
 class ModuleBase_ShapeDocumentFilter: public SelectMgr_Filter
 {
 public:
+  /// Constructor
+  /// \param theWorkshop instance of workshop interface
   Standard_EXPORT ModuleBase_ShapeDocumentFilter(ModuleBase_IWorkshop* theWorkshop): SelectMgr_Filter(),
     myWorkshop(theWorkshop) {}
 
+  /// 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)
 
 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,33 +55,24 @@ 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) {}
-
-  Standard_EXPORT virtual Standard_Boolean IsOk(const Handle(SelectMgr_EntityOwner)& theOwner) const;
+  /// Constructor
+  Standard_EXPORT ModuleBase_ShapeInPlaneFilter(): SelectMgr_Filter() {}
 
-  DEFINE_STANDARD_RTTI(ModuleBase_ShapeInPlaneFilter)
-private:
-  gp_Pln myPlane;
-};
+  /// Set working plane
+  /// \param thePane plane object
+  void setPlane(const gp_Pln& thePane) { myPlane = thePane; }
 
+  /// Returns current working plane
+  gp_Pln plane() const { return myPlane; }
 
-/**
-* 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 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_RTTI(ModuleBase_ShapeInPlaneFilter)
 private:
-  QStringList myTypes;
+  /// Working plane
+  gp_Pln myPlane;
 };
 
-#endif
\ No newline at end of file
+#endif