X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=src%2FModuleBase%2FModuleBase_ViewerFilters.h;h=0b34930942fe239327a6951b98e335ca2facd7b4;hb=7b95df2653284e65f416373ff010af49ee8c68ef;hp=4860776f4126689ef296c0244e619a5c2d49469c;hpb=9ef2d81a8b97eee85d6506d95f2481fe7fae1e56;p=modules%2Fshaper.git

diff --git a/src/ModuleBase/ModuleBase_ViewerFilters.h b/src/ModuleBase/ModuleBase_ViewerFilters.h
index 4860776f4..0b3493094 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
@@ -25,14 +27,19 @@ 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;
 };
 
@@ -44,15 +51,23 @@ DEFINE_STANDARD_HANDLE(ModuleBase_ShapeInPlaneFilter, SelectMgr_Filter);
 class ModuleBase_ShapeInPlaneFilter: public SelectMgr_Filter
 {
 public:
+  /// Constructor
   Standard_EXPORT ModuleBase_ShapeInPlaneFilter(): SelectMgr_Filter() {}
 
+  /// 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; }
 
+  /// 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)
 private:
+  /// Working plane
   gp_Pln myPlane;
 };
 
@@ -60,18 +75,26 @@ private:
 /**
 * A filter which provides filtering of selection in 3d viewer.
 * Installing of this filter lets to select only object of requested type
+* Accepts following objects types:
+* - "construction" - to select ModelAPI_ResultConstruction objects
 */
 DEFINE_STANDARD_HANDLE(ModuleBase_ObjectTypesFilter, SelectMgr_Filter);
 class ModuleBase_ObjectTypesFilter: public ModuleBase_ShapeDocumentFilter
 {
 public:
+  /// Constructor
+  /// \param theWorkshop instance of workshop interface
+  /// \param theTypes list of object types
   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)
 private:
+  /// List of object types
   QStringList myTypes;
 };