include/opencascade/StdSelect_FaceFilter.hxx

0001 // Created on: 1996-03-08
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_FaceFilter_HeaderFile
0018 #define _StdSelect_FaceFilter_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_Type.hxx>
0022
0023 #include <StdSelect_TypeOfFace.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 face.
0029 //! The types available include:
0030 //! -   any face
0031 //! -   a planar face
0032 //! -   a cylindrical face
0033 //! -   a spherical face
0034 //! -   a toroidal face
0035 //! -   a revol face.
0036 class StdSelect_FaceFilter : public SelectMgr_Filter
0037 {
0038
0039 public:
0040   //! Constructs a face filter object defined by the type of face aTypeOfFace.
0041   Standard_EXPORT StdSelect_FaceFilter(const StdSelect_TypeOfFace aTypeOfFace);
0042
0043   //! Sets the type of face aNewType. aNewType is to be highlighted in selection.
0044   Standard_EXPORT void SetType(const StdSelect_TypeOfFace aNewType);
0045
0046   //! Returns the type of face to be highlighted in selection.
0047   Standard_EXPORT StdSelect_TypeOfFace Type() const;
0048
0049   Standard_EXPORT bool IsOk(const occ::handle<SelectMgr_EntityOwner>& anobj) const override;
0050
0051   Standard_EXPORT bool ActsOn(const TopAbs_ShapeEnum aStandardMode) const override;
0052
0053   DEFINE_STANDARD_RTTIEXT(StdSelect_FaceFilter, SelectMgr_Filter)
0054
0055 private:
0056   StdSelect_TypeOfFace mytype;
0057 };
0058
0059 #endif // _StdSelect_FaceFilter_HeaderFile