include/opencascade/StdSelect_EdgeFilter.hxx

0001 // Created on: 1996-03-11
0002 // Created by: Robert COUBLANC
0003 // Copyright (c) 1996-1999 Matra Datavision
0004 // Copyright (c) 1999-2014 OPEN CASCADE SAS
0005 //
0006 // This file is part of Open CASCADE Technology software library.
0007 //
0008 // This library is free software; you can redistribute it and/or modify it under
0009 // the terms of the GNU Lesser General Public License version 2.1 as published
0010 // by the Free Software Foundation, with special exception defined in the file
0011 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
0012 // distribution for complete text of the license and disclaimer of any warranty.
0013 //
0014 // Alternatively, this file may be used under the terms of Open CASCADE
0015 // commercial license or contractual agreement.
0016
0017 #ifndef _StdSelect_EdgeFilter_HeaderFile
0018 #define _StdSelect_EdgeFilter_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_Type.hxx>
0022
0023 #include <StdSelect_TypeOfEdge.hxx>
0024 #include <SelectMgr_Filter.hxx>
0025 #include <TopAbs_ShapeEnum.hxx>
0026 class SelectMgr_EntityOwner;
0027
0028 //! A framework to define a filter to select a specific type of edge.
0029 //! The types available include:
0030 //! -   any edge
0031 //! -   a linear edge
0032 //! -   a circular edge.
0033 class StdSelect_EdgeFilter : public SelectMgr_Filter
0034 {
0035
0036 public:
0037   //! Constructs an edge filter object defined by the type of edge Edge.
0038   Standard_EXPORT StdSelect_EdgeFilter(const StdSelect_TypeOfEdge Edge);
0039
0040   //! Sets the type of edge aNewType. aNewType is to be highlighted in selection.
0041   Standard_EXPORT void SetType(const StdSelect_TypeOfEdge aNewType);
0042
0043   //! Returns the type of edge to be highlighted in selection.
0044   Standard_EXPORT StdSelect_TypeOfEdge Type() const;
0045
0046   Standard_EXPORT bool IsOk(const occ::handle<SelectMgr_EntityOwner>& anobj) const override;
0047
0048   Standard_EXPORT bool ActsOn(const TopAbs_ShapeEnum aStandardMode) const override;
0049
0050   DEFINE_STANDARD_RTTIEXT(StdSelect_EdgeFilter, SelectMgr_Filter)
0051
0052 private:
0053   StdSelect_TypeOfEdge mytype;
0054 };
0055
0056 #endif // _StdSelect_EdgeFilter_HeaderFile