include/opencascade/IFSelect_SelectControl.hxx

0001 // Created on: 1994-02-16
0002 // Created by: Christian CAILLET
0003 // Copyright (c) 1994-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 _IFSelect_SelectControl_HeaderFile
0018 #define _IFSelect_SelectControl_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_Type.hxx>
0022
0023 #include <IFSelect_Selection.hxx>
0024 class IFSelect_SelectionIterator;
0025
0026 //! A SelectControl kind Selection works with two input Selections
0027 //! in a dissymmetric way : the Main Input which gives an input
0028 //! list of Entities, to be processed, and the Second Input which
0029 //! gives another list, to be used to filter the main input.
0030 //!
0031 //! e.g. : SelectDiff retains the items of the Main Input which
0032 //! are not in the Control Input (which acts as Diff Input)
0033 //! or a specific selection which retains Entities from the Main
0034 //! Input if and only if they are concerned by an entity from
0035 //! the Control Input (such as Views in IGES, etc...)
0036 //!
0037 //! The way RootResult and Label are produced are at charge of
0038 //! each sub-class
0039 class IFSelect_SelectControl : public IFSelect_Selection
0040 {
0041
0042 public:
0043   //! Returns the Main Input Selection
0044   Standard_EXPORT occ::handle<IFSelect_Selection> MainInput() const;
0045
0046   //! Returns True if a Control Input is defined
0047   //! Thus, Result can be computed differently if there is a
0048   //! Control Input or if there is none
0049   Standard_EXPORT bool HasSecondInput() const;
0050
0051   //! Returns the Control Input Selection, or a Null Handle
0052   Standard_EXPORT occ::handle<IFSelect_Selection> SecondInput() const;
0053
0054   //! Sets a Selection to be the Main Input
0055   Standard_EXPORT void SetMainInput(const occ::handle<IFSelect_Selection>& sel);
0056
0057   //! Sets a Selection to be the Control Input
0058   Standard_EXPORT void SetSecondInput(const occ::handle<IFSelect_Selection>& sel);
0059
0060   //! Puts in an Iterator the Selections from which "me" depends
0061   //! That is to say, the list of Input Selections
0062   Standard_EXPORT void FillIterator(IFSelect_SelectionIterator& iter) const override;
0063
0064   DEFINE_STANDARD_RTTIEXT(IFSelect_SelectControl, IFSelect_Selection)
0065
0066 private:
0067   occ::handle<IFSelect_Selection> themain;
0068   occ::handle<IFSelect_Selection> thesecond;
0069 };
0070
0071 #endif // _IFSelect_SelectControl_HeaderFile