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:

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.
bool	IsSet () const
	Tells if the list has been set. Even if empty.
void	SetEntity (const occ::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 occ::handle< NCollection_HSequence< occ::handle< Standard_Transient > > > &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.
bool	Add (const occ::handle< Standard_Transient > &item)
	Adds an item. Returns True if Done, False if is already in the selected list.
bool	Remove (const occ::handle< Standard_Transient > &item)
	Removes an item. Returns True if Done, False if was not in the selected list.
bool	Toggle (const occ::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).
bool	AddList (const occ::handle< NCollection_HSequence< occ::handle< Standard_Transient > > > &list)
	Adds all the items defined in a list. Returns True if at least one item has been added, False else.
bool	RemoveList (const occ::handle< NCollection_HSequence< occ::handle< Standard_Transient > > > &list)
	Removes all the items defined in a list. Returns True if at least one item has been removed, False else.
bool	ToggleList (const occ::handle< NCollection_HSequence< occ::handle< Standard_Transient > > > &list)
	Toggles status of all the items defined in a list : adds it if not pointed or removes it if already pointed.
int	Rank (const occ::handle< Standard_Transient > &item) const
	Returns the rank of an item in the selected list, or 0.
int	NbItems () const
	Returns the count of selected items.
occ::handle< Standard_Transient >	Item (const int numnum) const
	Returns an item given its rank, or a Null Handle.
void	Update (const occ::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 occ::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 override
	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 override
	Returns a text which identifies the type of selection made. It is "Pointed Entities".
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.
Public Member Functions inherited from IFSelect_Selection
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).
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 ()=default
	Destructor must be virtual.
virtual const opencascade::handle< Standard_Type > &	DynamicType () const
	Returns a type descriptor about this object.
bool	IsInstance (const opencascade::handle< Standard_Type > &theType) const
	Returns a true value if this is an instance of Type.
bool	IsInstance (const char *const theTypeName) const
	Returns a true value if this is an instance of TypeName.
bool	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.
bool	IsKind (const char *const 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.
int	GetRefCount () const noexcept
	Get the reference counter of this object.
void	IncrementRefCounter () noexcept
	Increments the reference counter of this object. Uses relaxed memory ordering since incrementing only requires atomicity, not synchronization with other memory operations.
int	DecrementRefCounter () noexcept
	Decrements the reference counter of this object; returns the decremented value. Uses release ordering for the decrement to ensure all writes to the object are visible before the count reaches zero. An acquire fence is added only when the count reaches zero, ensuring proper synchronization before deletion. This is more efficient than using acq_rel for every decrement.
virtual void	Delete () const
	Memory deallocator for transient classes.

Additional Inherited Members
typedef void	base_type
	Returns a type descriptor about this object.
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 bool	HasUniqueResult () const
	Returns True if RootResult guarantees uniqueness for each Entity. Called by UniqueResult. Default answer is False. Can be redefined.

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()

bool IFSelect_SelectPointed::Add

(

const occ::handle< Standard_Transient > &

item

)

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

AddList()

bool IFSelect_SelectPointed::AddList

(

const occ::handle< NCollection_HSequence< occ::handle< Standard_Transient > > > &

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()

bool IFSelect_SelectPointed::IsSet

(

)

const

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

Item()

occ::handle< Standard_Transient > IFSelect_SelectPointed::Item

(

const int

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()

int IFSelect_SelectPointed::NbItems

(

)

const

Returns the count of selected items.

Rank()

int IFSelect_SelectPointed::Rank

(

const occ::handle< Standard_Transient > &

item

)

const

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

Remove()

bool IFSelect_SelectPointed::Remove

(

const occ::handle< Standard_Transient > &

item

)

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

RemoveList()

bool IFSelect_SelectPointed::RemoveList

(

const occ::handle< NCollection_HSequence< occ::handle< Standard_Transient > > > &

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 occ::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 occ::handle< NCollection_HSequence< occ::handle< Standard_Transient > > > &

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()

bool IFSelect_SelectPointed::Toggle

(

const occ::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()

bool IFSelect_SelectPointed::ToggleList

(

const occ::handle< NCollection_HSequence< occ::handle< Standard_Transient > > > &

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 occ::handle< IFSelect_Transformer > &

trf

)

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

Update() [2/2]

void IFSelect_SelectPointed::Update

(

const occ::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.

---

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

• IFSelect_SelectPointed.hxx