Open CASCADE Technology 6.6.0
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

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

#include <IFSelect_SelectPointed.hxx>

Inheritance diagram for IFSelect_SelectPointed:
Inheritance graph
[legend]

Public Member Functions

 IFSelect_SelectPointed ()
 Creates a SelectPointed

void Clear ()
 Clears the list of selected items
Also says the list is unset
All Add* methods and SetList say the list is set

Standard_Boolean IsSet () const
 Tells if the list has been set. Even if empty

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

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

To use it as an alternate input, one shot :

Standard_Boolean Add (const Handle< Standard_Transient > &item)
 Adds an item. Returns True if Done, False if is already
in the selected list

Standard_Boolean Remove (const Handle< Standard_Transient > &item)
 Removes an item. Returns True if Done, False if was not
in the selected list

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)

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

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

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.

Standard_Integer Rank (const Handle< Standard_Transient > &item) const
 Returns the rank of an item in the selected list, or 0.

Standard_Integer NbItems () const
 Returns the count of selected items

Handle_Standard_Transient Item (const Standard_Integer num) const
 Returns an item given its rank, or a Null Handle

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.

void Update (const Handle< IFSelect_Transformer > &trf)
 Rebuilds the selected list, by querying a Transformer
(same principle as from a CopyControl)

Interface_EntityIterator RootResult (const Interface_Graph &G) const
 Returns the list of selected items. Only the selected entities
which are present in the graph are given (this result assures
uniqueness).

TCollection_AsciiString Label () const
 Returns a text which identifies the type of selection made.
It is "Pointed Entities"


Constructor & Destructor Documentation

IFSelect_SelectPointed::IFSelect_SelectPointed ( )

Member Function Documentation

Standard_Boolean IFSelect_SelectPointed::Add ( const Handle< Standard_Transient > &  item)
Standard_Boolean IFSelect_SelectPointed::AddList ( const Handle< TColStd_HSequenceOfTransient > &  list)
void IFSelect_SelectPointed::Clear ( )
Standard_Boolean IFSelect_SelectPointed::IsSet ( ) const
Handle_Standard_Transient IFSelect_SelectPointed::Item ( const Standard_Integer  num) const
TCollection_AsciiString IFSelect_SelectPointed::Label ( ) const [virtual]

Implements IFSelect_Selection.

Standard_Integer IFSelect_SelectPointed::NbItems ( ) const
Standard_Integer IFSelect_SelectPointed::Rank ( const Handle< Standard_Transient > &  item) const
Standard_Boolean IFSelect_SelectPointed::Remove ( const Handle< Standard_Transient > &  item)
Standard_Boolean IFSelect_SelectPointed::RemoveList ( const Handle< TColStd_HSequenceOfTransient > &  list)
Interface_EntityIterator IFSelect_SelectPointed::RootResult ( const Interface_Graph G) const [virtual]

Implements IFSelect_Selection.

void IFSelect_SelectPointed::SetEntity ( const Handle< Standard_Transient > &  item)
void IFSelect_SelectPointed::SetList ( const Handle< TColStd_HSequenceOfTransient > &  list)
  • SetList or SetEntity to define the input list
  • RootResult to get it
  • then Clear to drop it
Standard_Boolean IFSelect_SelectPointed::Toggle ( const Handle< Standard_Transient > &  item)
Standard_Boolean IFSelect_SelectPointed::ToggleList ( const Handle< TColStd_HSequenceOfTransient > &  list)
void IFSelect_SelectPointed::Update ( const Handle< Interface_CopyControl > &  control)
void IFSelect_SelectPointed::Update ( const Handle< IFSelect_Transformer > &  trf)

The documentation for this class was generated from the following file:
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines