Open CASCADE Technology 6.6.0
|
A framework to define finding, sorting the sensitive
primitives in a view. Services are also provided to
define the return of the owners of those primitives
selected. The primitives are sorted by criteria such
as priority of the primitive or its depth in the view
relative to that of other primitives.
This framework is undefined for either 2D or 3D,
and is consequently used by both
StdSelect_ViewerSelector2d and
StdSelect_ViewerSelector3d, which inherit it, and
which in turn, return 2D and 3D owners of sensitive
primitives respectively.
Note that in 3D, the inheriting framework
StdSelect_ViewerSelector3d is only to be used
if you do not want to use the services provided by
AIS. In 2D, you will, however, need the services
provided by the StdSelect_ViewerSelector2d.
Two tools are available to find and select objects
found at a given position in the view. If you want to
select the owners of all the objects detected at
point x,y, you use the Init - More - Next - Picked
loop. If, on the other hand, you want to select only
one object detected at that point, you use the Init -
More - OnePicked loop. In this iteration, More is
used to see if an object was picked and
OnePicked, to get the object closest to the pick position.
Viewer selectors are driven by
SelectMgr_SelectionManager, and manipulate
the SelectMgr_Selection objects given to them by
the selection manager.
#include <SelectMgr_ViewerSelector.hxx>
Public Member Functions | |
virtual void | Convert (const Handle< SelectMgr_Selection > &aSelection) |
to be redefined if conversion is necessary for SensitiveEntities... | |
void | Clear () |
Empties all the tables, removes all selections... | |
void | UpdateConversion () |
converts all the sensitive entities ; | |
void | SetSensitivity (const Standard_Real aTol) |
changes the Sensitivity of picking Input value is Real. | |
Standard_Real | Sensitivity () const |
returns the Sensitivity of picking | |
void | SetClipping (const Standard_Real Xc, const Standard_Real Yc, const Standard_Real Height, const Standard_Real Width) |
sets the clipping limits of dynamic picking input value are Real | |
void | SetClipping (const Bnd_Box2d &aRectangle) |
sets the clipping limits of dynamic picking input value are Real | |
void | InitSelect (const Standard_Real Xr, const Standard_Real Yr) |
Performs a pick action. Xr, Yr are the real 2D mouse coordinates in the view. The selector looks for areas and owners that are touched. | |
void | InitSelect (const Bnd_Box2d &aRect) |
Performs a pick action. aRect is a Box2d (real coordinates) for the selection. The selector looks for areas and owners that are touched. | |
void | InitSelect (const Standard_Real Xmin, const Standard_Real Ymin, const Standard_Real Xmax, const Standard_Real Ymax) |
Performs a pick action | |
void | InitSelect (const TColgp_Array1OfPnt2d &Polyline) |
pick action - input values of a polyline selection for selection. | |
virtual void | SortResult () |
Sorts the detected entites by priority and distance. to be redefined if other criterion are used... | |
void | Init () |
Begins an iteration scanning for the owners detected at a position in the view. | |
Standard_Boolean | More () |
Continues the interation scanning for the owners detected at a position in the view, or | |
void | Next () |
Returns the next owner found in the iteration. This is a scan for the owners detected at a position in the view. | |
Handle_SelectMgr_EntityOwner | Picked () const |
Returns the current selected entity detected by the selector; | |
Handle_SelectMgr_EntityOwner | OnePicked () |
Returns the picked element with the highest priority, and which is the closest to the last successful mouse position. | |
void | SetPickClosest (const Standard_Boolean preferClosest) |
Set preference of selecting one object for OnePicked() method: | |
Standard_Integer | NbPicked () const |
Returns the number of owners found at a position in the view by the Init - More - Next - Picked iteration. | |
Handle_SelectMgr_EntityOwner | Picked (const Standard_Integer aRank) const |
Returns the entity which is at rank <aRank> in the list of stored ones. | |
Standard_Boolean | HasStored () |
Returns True if a successful pick was stored, i.e. LastPosition method means something... | |
void | LastPosition (Standard_Real &Xr, Standard_Real &Yr) const |
Gives the last successful pick position; is useful to get objects really picked | |
Standard_Boolean | Contains (const Handle< SelectMgr_SelectableObject > &aSelectableObject) const |
Standard_Boolean | Modes (const Handle< SelectMgr_SelectableObject > &aSelectableObject, TColStd_ListOfInteger &ModeList, const SelectMgr_StateOfSelection WantedState=SelectMgr_SOS_Any) const |
Returns the list of selection modes ModeList found in this selector for the selectable object aSelectableObject. Returns true if aSelectableObject is referenced inside this selector; returns false if the object is not present in this selector. | |
Standard_Boolean | IsActive (const Handle< SelectMgr_SelectableObject > &aSelectableObject, const Standard_Integer aMode) const |
Returns true if the selectable object aSelectableObject having the selection mode aMode is active in this selector. | |
Standard_Boolean | IsInside (const Handle< SelectMgr_SelectableObject > &aSelectableObject, const Standard_Integer aMode) const |
Returns true if the selectable object aSelectableObject having the selection mode aMode is in this selector. | |
SelectMgr_StateOfSelection | Status (const Handle< SelectMgr_Selection > &aSelection) const |
Returns the selection status Status of the selection aSelection. | |
void | Dump (Standard_OStream &S) const |
TCollection_AsciiString | Status (const Handle< SelectMgr_SelectableObject > &aSelectableObject) const |
TCollection_AsciiString | Status () const |
gives general information about the Selector | |
void | UpdateSort () |
Handle_SelectBasics_SensitiveEntity | Primitive (const Standard_Integer Rank) const |
const SelectMgr_DataMapOfIntegerSensitive & | Primitives () const |
void | SetUpdateSortPossible (const Standard_Boolean possible) |
Standard_Boolean | IsUpdateSortPossible () const |
Protected Member Functions | |
SelectMgr_ViewerSelector () | |
virtual void | LoadResult () |
virtual void | LoadResult (const Bnd_Box2d &aBox) |
virtual void | LoadResult (const TColgp_Array1OfPnt2d &Polyline) |
Protected Attributes | |
SelectMgr_DataMapOfIntegerSensitive | myentities |
SelectMgr_DataMapOfSelectionActivation | myselections |
Standard_Boolean | toupdate |
Standard_Boolean | tosort |
Standard_Boolean | preferclosest |
Standard_Real | mytolerance |
SelectBasics_SortAlgo | myselector |
Bnd_Box2d | myclip |
SelectMgr_IndexedDataMapOfOwnerCriterion | mystored |
SelectMgr_ViewerSelector::SelectMgr_ViewerSelector | ( | ) | [protected] |
void SelectMgr_ViewerSelector::Clear | ( | ) |
Standard_Boolean SelectMgr_ViewerSelector::Contains | ( | const Handle< SelectMgr_SelectableObject > & | aSelectableObject | ) | const |
virtual void SelectMgr_ViewerSelector::Convert | ( | const Handle< SelectMgr_Selection > & | aSelection | ) | [virtual] |
Reimplemented in StdSelect_ViewerSelector3d.
void SelectMgr_ViewerSelector::Dump | ( | Standard_OStream & | S | ) | const |
Standard_Boolean SelectMgr_ViewerSelector::HasStored | ( | ) |
void SelectMgr_ViewerSelector::Init | ( | ) |
void SelectMgr_ViewerSelector::InitSelect | ( | const Standard_Real | Xr, |
const Standard_Real | Yr | ||
) |
void SelectMgr_ViewerSelector::InitSelect | ( | const Bnd_Box2d & | aRect | ) |
void SelectMgr_ViewerSelector::InitSelect | ( | const Standard_Real | Xmin, |
const Standard_Real | Ymin, | ||
const Standard_Real | Xmax, | ||
const Standard_Real | Ymax | ||
) |
void SelectMgr_ViewerSelector::InitSelect | ( | const TColgp_Array1OfPnt2d & | Polyline | ) |
Standard_Boolean SelectMgr_ViewerSelector::IsActive | ( | const Handle< SelectMgr_SelectableObject > & | aSelectableObject, |
const Standard_Integer | aMode | ||
) | const |
Standard_Boolean SelectMgr_ViewerSelector::IsInside | ( | const Handle< SelectMgr_SelectableObject > & | aSelectableObject, |
const Standard_Integer | aMode | ||
) | const |
Standard_Boolean SelectMgr_ViewerSelector::IsUpdateSortPossible | ( | ) | const |
void SelectMgr_ViewerSelector::LastPosition | ( | Standard_Real & | Xr, |
Standard_Real & | Yr | ||
) | const |
virtual void SelectMgr_ViewerSelector::LoadResult | ( | ) | [protected, virtual] |
virtual void SelectMgr_ViewerSelector::LoadResult | ( | const TColgp_Array1OfPnt2d & | Polyline | ) | [protected, virtual] |
virtual void SelectMgr_ViewerSelector::LoadResult | ( | const Bnd_Box2d & | aBox | ) | [protected, virtual] |
Standard_Boolean SelectMgr_ViewerSelector::Modes | ( | const Handle< SelectMgr_SelectableObject > & | aSelectableObject, |
TColStd_ListOfInteger & | ModeList, | ||
const SelectMgr_StateOfSelection | WantedState = SelectMgr_SOS_Any |
||
) | const |
Standard_Boolean SelectMgr_ViewerSelector::More | ( | ) |
Standard_Integer SelectMgr_ViewerSelector::NbPicked | ( | ) | const |
void SelectMgr_ViewerSelector::Next | ( | ) |
Handle_SelectMgr_EntityOwner SelectMgr_ViewerSelector::OnePicked | ( | ) |
Handle_SelectMgr_EntityOwner SelectMgr_ViewerSelector::Picked | ( | ) | const |
Handle_SelectMgr_EntityOwner SelectMgr_ViewerSelector::Picked | ( | const Standard_Integer | aRank | ) | const |
Handle_SelectBasics_SensitiveEntity SelectMgr_ViewerSelector::Primitive | ( | const Standard_Integer | Rank | ) | const |
const SelectMgr_DataMapOfIntegerSensitive& SelectMgr_ViewerSelector::Primitives | ( | ) | const |
Standard_Real SelectMgr_ViewerSelector::Sensitivity | ( | ) | const |
void SelectMgr_ViewerSelector::SetClipping | ( | const Standard_Real | Xc, |
const Standard_Real | Yc, | ||
const Standard_Real | Height, | ||
const Standard_Real | Width | ||
) |
void SelectMgr_ViewerSelector::SetClipping | ( | const Bnd_Box2d & | aRectangle | ) |
void SelectMgr_ViewerSelector::SetPickClosest | ( | const Standard_Boolean | preferClosest | ) |
void SelectMgr_ViewerSelector::SetSensitivity | ( | const Standard_Real | aTol | ) |
void SelectMgr_ViewerSelector::SetUpdateSortPossible | ( | const Standard_Boolean | possible | ) |
virtual void SelectMgr_ViewerSelector::SortResult | ( | ) | [virtual] |
TCollection_AsciiString SelectMgr_ViewerSelector::Status | ( | ) | const |
TCollection_AsciiString SelectMgr_ViewerSelector::Status | ( | const Handle< SelectMgr_SelectableObject > & | aSelectableObject | ) | const |
SelectMgr_StateOfSelection SelectMgr_ViewerSelector::Status | ( | const Handle< SelectMgr_Selection > & | aSelection | ) | const |
void SelectMgr_ViewerSelector::UpdateConversion | ( | ) |
void SelectMgr_ViewerSelector::UpdateSort | ( | ) |
Bnd_Box2d SelectMgr_ViewerSelector::myclip [protected] |
Standard_Real SelectMgr_ViewerSelector::mytolerance [protected] |
Standard_Boolean SelectMgr_ViewerSelector::tosort [protected] |
Standard_Boolean SelectMgr_ViewerSelector::toupdate [protected] |