X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=src%2FModuleBase%2FModuleBase_ViewerFilters.h;h=8314f70546b69907268289f9e879098ef691e7ea;hb=061a63480f6840b6d945f7744b3b972e2d4cb25d;hp=e4aa93ae29b299bc3713a20f0424f7d5f6f1f712;hpb=652a5949418f13aa7db1f1d405a369f4644ba33a;p=modules%2Fshaper.git diff --git a/src/ModuleBase/ModuleBase_ViewerFilters.h b/src/ModuleBase/ModuleBase_ViewerFilters.h index e4aa93ae2..8314f7054 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 #include -#include + +#include 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,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 +56,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; - - DEFINE_STANDARD_RTTI(ModuleBase_ShapeInPlaneFilter) -private: - gp_Pln myPlane; -}; + /// Constructor + Standard_EXPORT ModuleBase_ShapeInPlaneFilter(): SelectMgr_Filter() {} + /// Set working plane + /// \param thePlane a plane object + void setPlane(const std::shared_ptr& 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 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_ObjectTypesFilter) + DEFINE_STANDARD_RTTI(ModuleBase_ShapeInPlaneFilter) private: - QStringList myTypes; + /// Working plane + std::shared_ptr myPlane; }; -#endif \ No newline at end of file +#endif