OCC Main Page | DataExchange | Toolkits | Packages | Class Hierarchy | Data Structures | File List | Data Fields | Globals

# DataExchange
TKXSBase
IFSelect

# 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:

[legend]

## Public Member Functions
Standard_EXPORT | IFSelect_SelectPointed ()
| Creates a SelectPointed .
Standard_EXPORT 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_EXPORT Standard_Boolean | IsSet () const
| Tells if the list has been set. Even if empty .
Standard_EXPORT 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 .
Standard_EXPORT void | SetList (const Handle(TColStd_HSequenceOfTransient)&list)
| Sets a given list to define the list of selected items <list> can 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 .
Standard_EXPORT Standard_Boolean | Add (const Handle(Standard_Transient)&item)
| Adds an item. Returns True if Done, False if <item> is already in the selected list .
Standard_EXPORT Standard_Boolean | Remove (const Handle(Standard_Transient)&item)
| Removes an item. Returns True if Done, False if <item> was not in the selected list .
Standard_EXPORT 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_EXPORT 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_EXPORT 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_EXPORT 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_EXPORT Standard_Integer | Rank (const Handle(Standard_Transient)&item) const
| Returns the rank of an item in the selected list, or 0. .
Standard_EXPORT Standard_Integer | NbItems () const
| Returns the count of selected items .
Standard_EXPORT Handle_Standard_Transient | Item (const Standard_Integer num) const
| Returns an item given its rank, or a Null Handle .
Standard_EXPORT 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. .
Standard_EXPORT void | Update (const Handle(IFSelect_Transformer)&trf)
| Rebuilds the selected list, by querying a Transformer (same principle as from a CopyControl) .
Standard_EXPORT 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). .
Standard_EXPORT TCollection_AsciiString | Label () const
| Returns a text which identifies the type of selection made. It is "Pointed Entities" .
Standard_EXPORT const | Handle (Standard_Type)&DynamicType() const
## Private Attributes
Standard_Boolean | theset
TColStd_SequenceOfTransient | theitems

## Constructor & Destructor Documentation

Standard_EXPORT IFSelect_SelectPointed::IFSelect_SelectPointed | ( |  | ) |

## Member Function Documentation

Standard_EXPORT Standard_Boolean IFSelect_SelectPointed::Add | ( | const Handle(Standard_Transient)& | item | ) |

Standard_EXPORT Standard_Boolean IFSelect_SelectPointed::AddList | ( | const Handle(TColStd_HSequenceOfTransient)& | list | ) |

Standard_EXPORT void IFSelect_SelectPointed::Clear | ( |  | ) |

Standard_EXPORT const IFSelect_SelectPointed::Handle | ( | Standard_Type |  | ) | const

| Reimplemented from IFSelect_SelectBase.

Standard_EXPORT Standard_Boolean IFSelect_SelectPointed::IsSet | ( |  | ) | const

Standard_EXPORT Handle_Standard_Transient IFSelect_SelectPointed::Item | ( | const Standard_Integer | num | ) | const

Standard_EXPORT TCollection_AsciiString IFSelect_SelectPointed::Label | ( |  | ) | const`[virtual]`

| Implements IFSelect_Selection.

Standard_EXPORT Standard_Integer IFSelect_SelectPointed::NbItems | ( |  | ) | const

Standard_EXPORT Standard_Integer IFSelect_SelectPointed::Rank | ( | const Handle(Standard_Transient)& | item | ) | const

Standard_EXPORT Standard_Boolean IFSelect_SelectPointed::Remove | ( | const Handle(Standard_Transient)& | item | ) |

Standard_EXPORT Standard_Boolean IFSelect_SelectPointed::RemoveList | ( | const Handle(TColStd_HSequenceOfTransient)& | list | ) |

Standard_EXPORT Interface_EntityIterator IFSelect_SelectPointed::RootResult | ( | const Interface_Graph & | G | ) | const`[virtual]`

| Implements IFSelect_Selection.

Standard_EXPORT void IFSelect_SelectPointed::SetEntity | ( | const Handle(Standard_Transient)& | item | ) |

Standard_EXPORT void IFSelect_SelectPointed::SetList | ( | const Handle(TColStd_HSequenceOfTransient)& | list | ) |

Standard_EXPORT Standard_Boolean IFSelect_SelectPointed::Toggle | ( | const Handle(Standard_Transient)& | item | ) |

Standard_EXPORT Standard_Boolean IFSelect_SelectPointed::ToggleList | ( | const Handle(TColStd_HSequenceOfTransient)& | list | ) |

Standard_EXPORT void IFSelect_SelectPointed::Update | ( | const Handle(IFSelect_Transformer)& | trf | ) |

Standard_EXPORT void IFSelect_SelectPointed::Update | ( | const Handle(Interface_CopyControl)& | control | ) |

## Field Documentation

TColStd_SequenceOfTransient IFSelect_SelectPointed::theitems`[private]`

Standard_Boolean IFSelect_SelectPointed::theset`[private]`

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

- IFSelect_SelectPointed.hxx