Open CASCADE Technology  7.3.1.dev
Public Member Functions
IFSelect_SelectPointed Class Reference

This type of Selection is intended to describe a direct selection without an explicit criterium, for instance the result of picking viewed entities on a graphic screen. More...

#include <IFSelect_SelectPointed.hxx>

Inheritance diagram for IFSelect_SelectPointed:
Inheritance graph
[legend]

Public Member Functions

 IFSelect_SelectPointed ()
 Creates a SelectPointed. More...
 
void Clear ()
 Clears the list of selected items Also says the list is unset All Add* methods and SetList say the list is set. More...
 
Standard_Boolean IsSet () const
 Tells if the list has been set. Even if empty. More...
 
void SetEntity (const Handle< Standard_Transient > &item)
 As SetList but with only one entity If <ent> is Null, the list is said as being set but is empty. More...
 
void SetList (const Handle< TColStd_HSequenceOfTransient > &list)
 Sets a given list to define the list of selected items

be empty or null : in this case, the list is said as being set, but it is empty. More...

 
Standard_Boolean Add (const Handle< Standard_Transient > &item)
 Adds an item. Returns True if Done, False if is already in the selected list. More...
 
Standard_Boolean Remove (const Handle< Standard_Transient > &item)
 Removes an item. Returns True if Done, False if was not in the selected list. More...
 
Standard_Boolean Toggle (const Handle< Standard_Transient > &item)
 Toggles status of an item : adds it if not pointed or removes it if already pointed. Returns the new status (Pointed or not) More...
 
Standard_Boolean AddList (const Handle< TColStd_HSequenceOfTransient > &list)
 Adds all the items defined in a list. Returns True if at least one item has been added, False else. More...
 
Standard_Boolean RemoveList (const Handle< TColStd_HSequenceOfTransient > &list)
 Removes all the items defined in a list. Returns True if at least one item has been removed, False else. More...
 
Standard_Boolean ToggleList (const Handle< TColStd_HSequenceOfTransient > &list)
 Toggles status of all the items defined in a list : adds it if not pointed or removes it if already pointed. More...
 
Standard_Integer Rank (const Handle< Standard_Transient > &item) const
 Returns the rank of an item in the selected list, or 0. More...
 
Standard_Integer NbItems () const
 Returns the count of selected items. More...
 
Handle< Standard_TransientItem (const Standard_Integer num) const
 Returns an item given its rank, or a Null Handle. More...
 
void Update (const Handle< Interface_CopyControl > &control)
 Rebuilds the selected list. Any selected entity which has a bound result is replaced by this result, else it is removed. More...
 
void Update (const Handle< IFSelect_Transformer > &trf)
 Rebuilds the selected list, by querying a Transformer (same principle as from a CopyControl) More...
 
Interface_EntityIterator RootResult (const Interface_Graph &G) const override
 Returns the list of selected items. Only the selected entities which are present in the graph are given (this result assures uniqueness). More...
 
TCollection_AsciiString Label () const override
 Returns a text which identifies the type of selection made. It is "Pointed Entities". More...
 
- Public Member Functions inherited from IFSelect_SelectBase
void FillIterator (IFSelect_SelectionIterator &iter) const override
 Puts in an Iterator the Selections from which "me" depends This list is empty for all SelectBase type Selections. More...
 
- Public Member Functions inherited from IFSelect_Selection
Interface_EntityIterator UniqueResult (const Interface_Graph &G) const
 Returns the list of selected entities, each of them beeing unique. Default definition works from RootResult. According HasUniqueResult, UniqueResult returns directly RootResult, or build a Unique Result from it with a Graph. More...
 
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) More...
 
- Public Member Functions inherited from Standard_Transient
 Standard_Transient ()
 Empty constructor. More...
 
 Standard_Transient (const Standard_Transient &)
 Copy constructor – does nothing. More...
 
Standard_Transientoperator= (const Standard_Transient &)
 Assignment operator, needed to avoid copying reference counter. More...
 
virtual ~Standard_Transient ()
 Destructor must be virtual. More...
 
virtual void Delete () const
 Memory deallocator for transient classes. More...
 
virtual const opencascade::handle< Standard_Type > & DynamicType () const
 Returns a type descriptor about this object. More...
 
Standard_Boolean IsInstance (const opencascade::handle< Standard_Type > &theType) const
 Returns a true value if this is an instance of Type. More...
 
Standard_Boolean IsInstance (const Standard_CString theTypeName) const
 Returns a true value if this is an instance of TypeName. More...
 
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. More...
 
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. More...
 
Standard_TransientThis () 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. More...
 
Standard_Integer GetRefCount () const
 Get the reference counter of this object. More...
 
void IncrementRefCounter () const
 Increments the reference counter of this object. More...
 
Standard_Integer DecrementRefCounter () const
 Decrements the reference counter of this object; returns the decremented value. More...
 

Additional Inherited Members

- Public Types inherited from Standard_Transient
typedef void base_type
 Returns a type descriptor about this object. More...
 
- Static Public Member Functions inherited from Standard_Transient
static const char * get_type_name ()
 Returns a type descriptor about this object. More...
 
static const opencascade::handle< Standard_Type > & get_type_descriptor ()
 Returns type descriptor of Standard_Transient class. More...
 
- 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. More...
 

Detailed Description

This type of Selection is intended to describe a direct selection without an explicit criterium, for instance the result of picking viewed entities on a graphic screen.

It can also be used to provide a list as internal alternate input : this use implies to clear the list once queried

Constructor & Destructor Documentation

◆ IFSelect_SelectPointed()

IFSelect_SelectPointed::IFSelect_SelectPointed ( )

Creates a SelectPointed.

Member Function Documentation

◆ Add()

Standard_Boolean IFSelect_SelectPointed::Add ( const Handle< Standard_Transient > &  item)

Adds an item. Returns True if Done, False if is already in the selected list.

◆ AddList()

Standard_Boolean IFSelect_SelectPointed::AddList ( const Handle< TColStd_HSequenceOfTransient > &  list)

Adds all the items defined in a list. Returns True if at least one item has been added, False else.

◆ Clear()

void IFSelect_SelectPointed::Clear ( )

Clears the list of selected items Also says the list is unset All Add* methods and SetList say the list is set.

◆ IsSet()

Standard_Boolean IFSelect_SelectPointed::IsSet ( ) const

Tells if the list has been set. Even if empty.

◆ Item()

Handle< Standard_Transient > IFSelect_SelectPointed::Item ( const Standard_Integer  num) const

Returns an item given its rank, or a Null Handle.

◆ Label()

TCollection_AsciiString IFSelect_SelectPointed::Label ( ) const
overridevirtual

Returns a text which identifies the type of selection made. It is "Pointed Entities".

Implements IFSelect_Selection.

◆ NbItems()

Standard_Integer IFSelect_SelectPointed::NbItems ( ) const

Returns the count of selected items.

◆ Rank()

Standard_Integer IFSelect_SelectPointed::Rank ( const Handle< Standard_Transient > &  item) const

Returns the rank of an item in the selected list, or 0.

◆ Remove()

Standard_Boolean IFSelect_SelectPointed::Remove ( const Handle< Standard_Transient > &  item)

Removes an item. Returns True if Done, False if was not in the selected list.

◆ RemoveList()

Standard_Boolean IFSelect_SelectPointed::RemoveList ( const Handle< TColStd_HSequenceOfTransient > &  list)

Removes all the items defined in a list. Returns True if at least one item has been removed, False else.

◆ RootResult()

Interface_EntityIterator IFSelect_SelectPointed::RootResult ( const Interface_Graph G) const
overridevirtual

Returns the list of selected items. Only the selected entities which are present in the graph are given (this result assures uniqueness).

Implements IFSelect_Selection.

◆ SetEntity()

void IFSelect_SelectPointed::SetEntity ( const Handle< Standard_Transient > &  item)

As SetList but with only one entity If <ent> is Null, the list is said as being set but is empty.

◆ SetList()

void IFSelect_SelectPointed::SetList ( const Handle< TColStd_HSequenceOfTransient > &  list)

Sets a given list to define the list of selected items

be empty or null : in this case, the list is said as being set, but it is empty.

To use it as an alternate input, one shot :

  • SetList or SetEntity to define the input list
  • RootResult to get it
  • then Clear to drop it

◆ Toggle()

Standard_Boolean IFSelect_SelectPointed::Toggle ( const Handle< Standard_Transient > &  item)

Toggles status of an item : adds it if not pointed or removes it if already pointed. Returns the new status (Pointed or not)

◆ ToggleList()

Standard_Boolean IFSelect_SelectPointed::ToggleList ( const Handle< TColStd_HSequenceOfTransient > &  list)

Toggles status of all the items defined in a list : adds it if not pointed or removes it if already pointed.

◆ Update() [1/2]

void IFSelect_SelectPointed::Update ( const Handle< Interface_CopyControl > &  control)

Rebuilds the selected list. Any selected entity which has a bound result is replaced by this result, else it is removed.

◆ Update() [2/2]

void IFSelect_SelectPointed::Update ( const Handle< IFSelect_Transformer > &  trf)

Rebuilds the selected list, by querying a Transformer (same principle as from a CopyControl)


The documentation for this class was generated from the following file: