A SelectControl kind Selection works with two input Selections in a dissymmetric way : the Main Input which gives an input list of Entities, to be processed, and the Second Input which gives another list, to be used to filter the main input. More...
#include <IFSelect_SelectControl.hxx>
Public Member Functions | |
| Handle< IFSelect_Selection > | MainInput () const |
| Returns the Main Input Selection. | |
| Standard_Boolean | HasSecondInput () const |
| Returns True if a Control Input is defined Thus, Result can be computed differently if there is a Control Input or if there is none. | |
| Handle< IFSelect_Selection > | SecondInput () const |
| Returns the Control Input Selection, or a Null Handle. | |
| void | SetMainInput (const Handle< IFSelect_Selection > &sel) |
| Sets a Selection to be the Main Input. | |
| void | SetSecondInput (const Handle< IFSelect_Selection > &sel) |
| Sets a Selection to be the Control Input. | |
| void | FillIterator (IFSelect_SelectionIterator &iter) const override |
| Puts in an Iterator the Selections from which "me" depends That is to say, the list of Input Selections. | |
 Public Member Functions inherited from IFSelect_Selection | |
| virtual Interface_EntityIterator | RootResult (const Interface_Graph &G) const =0 |
| Returns the list of selected entities, computed from Input given as a Graph. Specific to each class of Selection Note that uniqueness of each entity is not required here This method can raise an exception as necessary. | |
| Interface_EntityIterator | UniqueResult (const Interface_Graph &G) const |
| Returns the list of selected entities, each of them being unique. Default definition works from RootResult. According HasUniqueResult, UniqueResult returns directly RootResult, or build a Unique Result from it with a Graph. | |
| virtual Interface_EntityIterator | CompleteResult (const Interface_Graph &G) const |
| Returns the list of entities involved by a Selection, i.e. UniqueResult plus the shared entities (directly or not) | |
| virtual TCollection_AsciiString | Label () const =0 |
| Returns a text which defines the criterium applied by a Selection (can be used to be printed, displayed ...) Specific to each class. | |
| Public Member Functions inherited from Standard_Transient | |
| Standard_Transient () | |
| Empty constructor. | |
| Standard_Transient (const Standard_Transient &) | |
| Copy constructor – does nothing. | |
| Standard_Transient & | operator= (const Standard_Transient &) |
| Assignment operator, needed to avoid copying reference counter. | |
| virtual | ~Standard_Transient () |
| Destructor must be virtual. | |
| virtual const opencascade::handle< Standard_Type > & | DynamicType () const |
| Returns a type descriptor about this object. | |
| Standard_Boolean | IsInstance (const opencascade::handle< Standard_Type > &theType) const |
| Returns a true value if this is an instance of Type. | |
| Standard_Boolean | IsInstance (const Standard_CString theTypeName) const |
| Returns a true value if this is an instance of TypeName. | |
| Standard_Boolean | IsKind (const opencascade::handle< Standard_Type > &theType) const |
| Returns true if this is an instance of Type or an instance of any class that inherits from Type. Note that multiple inheritance is not supported by OCCT RTTI mechanism. | |
| Standard_Boolean | IsKind (const Standard_CString theTypeName) const |
| Returns true if this is an instance of TypeName or an instance of any class that inherits from TypeName. Note that multiple inheritance is not supported by OCCT RTTI mechanism. | |
| Standard_Transient * | This () const |
| Returns non-const pointer to this object (like const_cast). For protection against creating handle to objects allocated in stack or call from constructor, it will raise exception Standard_ProgramError if reference counter is zero. | |
| Standard_Integer | GetRefCount () const noexcept |
| Get the reference counter of this object. | |
| void | IncrementRefCounter () noexcept |
| Increments the reference counter of this object. | |
| Standard_Integer | DecrementRefCounter () noexcept |
| Decrements the reference counter of this object; returns the decremented value. | |
| virtual void | Delete () const |
| Memory deallocator for transient classes. | |
Additional Inherited Members | |
| Public Types inherited from Standard_Transient | |
| typedef void | base_type |
| Returns a type descriptor about this object. | |
| Static Public Member Functions inherited from Standard_Transient | |
| static constexpr const char * | get_type_name () |
| Returns a type descriptor about this object. | |
| static const opencascade::handle< Standard_Type > & | get_type_descriptor () |
| Returns type descriptor of Standard_Transient class. | |
| Protected Member Functions inherited from IFSelect_Selection | |
| virtual Standard_Boolean | HasUniqueResult () const |
| Returns True if RootResult guarantees uniqueness for each Entity. Called by UniqueResult. Default answer is False. Can be redefined. | |
Detailed Description
A SelectControl kind Selection works with two input Selections in a dissymmetric way : the Main Input which gives an input list of Entities, to be processed, and the Second Input which gives another list, to be used to filter the main input.
e.g. : SelectDiff retains the items of the Main Input which are not in the Control Input (which acts as Diff Input) or a specific selection which retains Entities from the Main Input if and only if they are concerned by an entity from the Control Input (such as Views in IGES, etc...)
The way RootResult and Label are produced are at charge of each sub-class
Member Function Documentation
◆ FillIterator()
|
overridevirtual |
Puts in an Iterator the Selections from which "me" depends That is to say, the list of Input Selections.
Implements IFSelect_Selection.
◆ HasSecondInput()
| Standard_Boolean IFSelect_SelectControl::HasSecondInput | ( | ) | const |
Returns True if a Control Input is defined Thus, Result can be computed differently if there is a Control Input or if there is none.
◆ MainInput()
| Handle< IFSelect_Selection > IFSelect_SelectControl::MainInput | ( | ) | const |
Returns the Main Input Selection.
◆ SecondInput()
| Handle< IFSelect_Selection > IFSelect_SelectControl::SecondInput | ( | ) | const |
Returns the Control Input Selection, or a Null Handle.
◆ SetMainInput()
| void IFSelect_SelectControl::SetMainInput | ( | const Handle< IFSelect_Selection > & | sel | ) |
Sets a Selection to be the Main Input.
◆ SetSecondInput()
| void IFSelect_SelectControl::SetSecondInput | ( | const Handle< IFSelect_Selection > & | sel | ) |
Sets a Selection to be the Control Input.
The documentation for this class was generated from the following file:
