0026159: Visualization - revise tolerance implementation for selection
[occt.git] / src / SelectMgr / SelectMgr_ViewerSelector.hxx
1 // Created on: 1995-02-15
2 // Created by: Roberc Coublanc
3 // Copyright (c) 1995-1999 Matra Datavision
4 // Copyright (c) 1999-2014 OPEN CASCADE SAS
5 //
6 // This file is part of Open CASCADE Technology software library.
7 //
8 // This library is free software; you can redistribute it and/or modify it under
9 // the terms of the GNU Lesser General Public License version 2.1 as published
10 // by the Free Software Foundation, with special exception defined in the file
11 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
12 // distribution for complete text of the license and disclaimer of any warranty.
13 //
14 // Alternatively, this file may be used under the terms of Open CASCADE
15 // commercial license or contractual agreement.
16
17 // Modified by  ...
18 //              ROB JAN/07/98 : Improve Storage of detected entities
19 //              AGV OCT/23/03 : Optimize the method SortResult() (OCC4201)
20
21 #ifndef _SelectMgr_ViewerSelector_HeaderFile
22 #define _SelectMgr_ViewerSelector_HeaderFile
23
24 #include <MMgt_TShared.hxx>
25 #include <NCollection_Handle.hxx>
26 #include <NCollection_DataMap.hxx>
27 #include <OSD_Chronometer.hxx>
28 #include <TColStd_SequenceOfInteger.hxx>
29 #include <Handle_TColStd_HArray1OfInteger.hxx>
30
31 #include <Standard.hxx>
32 #include <Standard_DefineHandle.hxx>
33
34 #include <SelectMgr_IndexedDataMapOfOwnerCriterion.hxx>
35 #include <SelectMgr_SelectingVolumeManager.hxx>
36 #include <SelectMgr_Selection.hxx>
37 #include <SelectMgr_SelectableObject.hxx>
38 #include <SelectMgr_SelectableObjectSet.hxx>
39 #include <Handle_SelectMgr_EntityOwner.hxx>
40 #include <SelectMgr_StateOfSelection.hxx>
41 #include <Standard_OStream.hxx>
42 #include <Handle_SelectBasics_SensitiveEntity.hxx>
43
44 class TColStd_HArray1OfInteger;
45 class SelectMgr_SelectionManager;
46 class SelectMgr_Selection;
47 class SelectMgr_SensitiveEntitySet;
48 class SelectMgr_EntityOwner;
49 class TColStd_ListOfInteger;
50 class TCollection_AsciiString;
51 class SelectBasics_SensitiveEntity;
52 class SelectMgr_SelectableObjectSet;
53
54 typedef NCollection_DataMap<Handle(SelectMgr_SelectableObject), NCollection_Handle<SelectMgr_SensitiveEntitySet> > SelectMgr_MapOfObjectSensitives;
55 typedef NCollection_DataMap<Handle(SelectMgr_SelectableObject), NCollection_Handle<SelectMgr_SensitiveEntitySet> >::Iterator SelectMgr_MapOfObjectSensitivesIterator;
56
57 typedef NCollection_DataMap<Handle(SelectMgr_EntityOwner), Standard_Integer> SelectMgr_MapOfOwnerDetectedEntities;
58 typedef NCollection_DataMap<Handle(SelectMgr_EntityOwner), Standard_Integer>::Iterator SelectMgr_MapOfOwnerDetectedEntitiesIterator;
59
60 //! An internal class for calculation of current largest tolerance value which will be applied
61 //! for creation of selecting frustum by default. Each time the selection set is deactivated,
62 //! maximum tolerance value will be recalculated. If a user enables custom precision using
63 //! StdSelect_ViewerSelector3d::SetPixelTolerance, it will be applied to all sensitive entities
64 //! without any checks.
65 class SelectMgr_ToleranceMap
66 {
67 public:
68
69   //! Sets tolerance values to -1.0
70   SelectMgr_ToleranceMap();
71
72   Standard_EXPORT ~SelectMgr_ToleranceMap();
73
74   //! Adds the value given to map, checks if the current tolerance value
75   //! should be replaced by theTolerance
76   Standard_EXPORT void Add (const Standard_Real& theTolerance);
77
78   //! Decrements a counter of the tolerance given, checks if the current tolerance value
79   //! should be recalculated
80   Standard_EXPORT void Decrement (const Standard_Real& theTolerance);
81
82   //! Returns a current tolerance that must be applied
83   Standard_EXPORT Standard_Real Tolerance();
84
85   //! Sets tolerance to the given one and disables adaptive checks
86   Standard_EXPORT void SetCustomTolerance (const Standard_Real theTolerance);
87
88   //! Unsets a custom tolerance and enables adaptive checks
89   Standard_EXPORT void ResetDefaults();
90
91 private:
92   NCollection_DataMap<Standard_Real, Standard_Integer> myTolerances;
93   Standard_Real                                        myLargestKey;
94   Standard_Real                                        myCustomTolerance;
95 };
96
97 //! A framework to define finding, sorting the sensitive
98 //! primitives in a view. Services are also provided to
99 //! define the return of the owners of those primitives
100 //! selected. The primitives are sorted by criteria such
101 //! as priority of the primitive or its depth in the view
102 //! relative to that of other primitives.
103 //! Note that in 3D, the inheriting framework
104 //! StdSelect_ViewerSelector3d   is only to be used
105 //! if you do not want to use the services provided by
106 //! AIS.
107 //! Two tools are available to find and select objects
108 //! found at a given position in the view. If you want to
109 //! select the owners of all the objects detected at
110 //! point x,y,z you use the Init - More - Next - Picked
111 //! loop. If, on the other hand, you want to select only
112 //! one object detected at that point, you use the Init -
113 //! More - OnePicked loop. In this iteration, More is
114 //! used to see if an object was picked and
115 //! OnePicked, to get the object closest to the pick position.
116 //! Viewer selectors are driven by
117 //! SelectMgr_SelectionManager, and manipulate
118 //! the SelectMgr_Selection objects given to them by
119 //! the selection manager.
120 //!
121 //! Tolerances are applied to the entities in the following way:
122 //! 1. tolerance value stored in mytolerance will be used to calculate initial
123 //!    selecting frustum, which will be applied for intersection testing during
124 //!    BVH traverse;
125 //! 2. if tolerance of sensitive entity is less than mytolerance, the frustum for
126 //!    intersection detection will be resized according to its sensitivity.
127 class SelectMgr_ViewerSelector : public MMgt_TShared
128 {
129 public:
130
131   //! Empties all the tables, removes all selections...
132   Standard_EXPORT void Clear();
133
134   //! returns the Sensitivity of picking
135   Standard_Real Sensitivity() const;
136
137   //! Sorts the detected entites by priority and distance.
138   //!          to be redefined if other criterion are used...
139   Standard_EXPORT void SortResult();
140
141   //! Begins an iteration scanning for the owners detected at a position in the view.
142   void Init();
143
144   //!  Continues the interation scanning for the owners
145   //!   detected at a position in the view, or
146   //! -   continues the iteration scanning for the owner
147   //!   closest to the position in the view.
148   Standard_EXPORT Standard_Boolean More();
149
150   //! Returns the next owner found in the iteration. This is
151   //! a scan for the owners detected at a position in the view.
152   void Next();
153
154   //! Returns the current selected entity detected by the selector;
155   Standard_EXPORT Handle_SelectMgr_EntityOwner Picked() const;
156
157   //! Returns the picked element with the highest priority,
158   //! and which is the closest to the last successful mouse position.
159   Standard_EXPORT Handle_SelectMgr_EntityOwner OnePicked();
160
161   //! Set preference of selecting one object for OnePicked() method:
162   //! - If True, objects with less depth (distance fron the view plane) are
163   //!   preferred regardless of priority (priority is used then to choose among
164   //!   objects with similar depth),
165   //! - If False, objects with higher priority are preferred regardless of the
166   //!   depth which is used to choose among objects of the same priority.
167   void SetPickClosest (const Standard_Boolean preferClosest);
168
169   //! Returns the number of owners found at a position in
170   //! the view by the Init - More - Next - Picked iteration.
171   Standard_EXPORT Standard_Integer NbPicked() const;
172
173   //! Returns the  entity which is at rank <aRank>
174   //!          in the list of stored ones.
175   Standard_EXPORT Handle_SelectMgr_EntityOwner Picked (const Standard_Integer aRank) const;
176
177   Standard_EXPORT Standard_Boolean Contains (const Handle(SelectMgr_SelectableObject)& theObject) const;
178
179   //! Returns the list of selection modes ModeList found in
180   //! this selector for the selectable object aSelectableObject.
181   //! Returns true if aSelectableObject is referenced inside
182   //! this selector; returns false if the object is not present
183   //! in this selector.
184   Standard_EXPORT Standard_Boolean Modes (const Handle(SelectMgr_SelectableObject)& theSelectableObject,
185                                           TColStd_ListOfInteger& theModeList,
186                                           const SelectMgr_StateOfSelection theWantedState = SelectMgr_SOS_Any) const;
187
188   //! Returns true if the selectable object
189   //! aSelectableObject having the selection mode aMode
190   //! is active in this selector.
191   Standard_EXPORT Standard_Boolean IsActive (const Handle(SelectMgr_SelectableObject)& theSelectableObject,
192                                              const Standard_Integer theMode) const;
193
194   //! Returns true if the selectable object
195   //! aSelectableObject having the selection mode aMode
196   //! is in this selector.
197   Standard_EXPORT Standard_Boolean IsInside (const Handle(SelectMgr_SelectableObject)& theSelectableObject,
198                                              const Standard_Integer theMode) const;
199
200   //! Returns the selection status Status of the selection aSelection.
201   Standard_EXPORT SelectMgr_StateOfSelection Status (const Handle(SelectMgr_Selection)& theSelection) const;
202
203   Standard_EXPORT TCollection_AsciiString Status (const Handle(SelectMgr_SelectableObject)& theSelectableObject) const;
204
205   //! Returns the list of active entity owners
206   Standard_EXPORT NCollection_List<Handle(SelectBasics_EntityOwner)> ActiveOwners() const;
207
208   //! Adds new object to the map of selectable objects
209   Standard_EXPORT void AddSelectableObject (const Handle(SelectMgr_SelectableObject)& theObject);
210
211   //! Adds new selection to the object and builds its BVH tree
212   Standard_EXPORT void AddSelectionToObject (const Handle(SelectMgr_SelectableObject)& theObject,
213                                              const Handle(SelectMgr_Selection)& theSelection);
214
215   //! Removes selectable object from map of selectable ones
216   Standard_EXPORT void RemoveSelectableObject (const Handle(SelectMgr_SelectableObject)& theObject);
217
218   //! Removes selection of the object and marks its BVH tree for rebuild
219   Standard_EXPORT void RemoveSelectionOfObject (const Handle(SelectMgr_SelectableObject)& theObject,
220                                                 const Handle(SelectMgr_Selection)& theSelection);
221
222   //! Marks BVH of selectable objects for rebuild. Parameter theIsForce set as true
223   //! guarantees that 1st level BVH for the viewer selector will be rebuilt during this call
224   Standard_EXPORT void RebuildObjectsTree (const Standard_Boolean theIsForce = Standard_False);
225
226   //! Marks BVH of sensitive entities of particular selectable object for rebuild. Parameter
227   //! theIsForce set as true guarantees that 2nd level BVH for the object given will be
228   //! rebuilt during this call
229   Standard_EXPORT void RebuildSensitivesTree (const Handle(SelectMgr_SelectableObject)& theObject,
230                                               const Standard_Boolean theIsForce = Standard_False);
231
232   //! Initializes internal iterator for stored detected sensitive entities
233   Standard_EXPORT void InitDetected();
234
235   //! Makes a step along the map of detected sensitive entities and their owners
236   Standard_EXPORT void NextDetected();
237
238   //! Returns true if iterator of map of detected sensitive entities has reached
239   //! its end
240   Standard_EXPORT Standard_Boolean MoreDetected();
241
242   //! Returns sensitive entity that was detected during the previous run of
243   //! selection algorithm
244   Standard_EXPORT const Handle(SelectBasics_SensitiveEntity)& DetectedEntity() const;
245
246   //! Returns instance of selecting volume manager of the viewer selector
247   Standard_EXPORT SelectMgr_SelectingVolumeManager& GetManager();
248
249   friend class SelectMgr_SelectionManager;
250
251   DEFINE_STANDARD_RTTI(SelectMgr_ViewerSelector)
252
253 protected:
254
255   Standard_EXPORT SelectMgr_ViewerSelector();
256
257   //! Traverses BVH containing all added selectable objects and
258   //! finds candidates for further search of overlap
259   Standard_EXPORT void TraverseSensitives();
260
261   //! Returns True if the owner provides clipping by depth
262   //! for its sensitives. Override this method to tell the selector
263   //! to use the DepthClipping method for the owner.
264   //! Default implementation returns False for every owner.
265   //! @param theOwner [in] the onwer to check.
266   //! @return True if owner provides depth limits for sensitive clipping.
267   Standard_EXPORT virtual Standard_Boolean HasDepthClipping (const Handle(SelectMgr_EntityOwner)& theOwner) const;
268
269   //! Internal function that checks if there is possible overlap
270   //! between some entity of selectable object theObject and
271   //! current selecting volume
272   void traverseObject (const Handle(SelectMgr_SelectableObject)& theObject);
273
274   //! Internal function that checks if a particular sensitive
275   //! entity theEntity overlaps current selecting volume precisely
276   void checkOverlap (const Handle(SelectBasics_SensitiveEntity)& theEntity,
277                      const Standard_Integer theEntityIdx,
278                      SelectMgr_SelectingVolumeManager& theMgr);
279
280   //! Marks all added sensitive entities of all objects as non-selectable
281   void resetSelectionActivationStatus();
282
283   //! Checks if the entity given requires to scale current selecting frustum
284   Standard_Boolean isToScaleFrustum (const Handle(SelectBasics_SensitiveEntity)& theEntity);
285
286   //! Applies given scale and transformation matrices to the default selecting volume manager
287   SelectMgr_SelectingVolumeManager scaleAndTransform (const Standard_Real theScale,
288                                                       const gp_Trsf& theTrsf);
289
290 private:
291
292   void Activate (const Handle(SelectMgr_Selection)& theSelection);
293
294   void Deactivate (const Handle(SelectMgr_Selection)& theSelection);
295
296   //! removes a Selection from the Selector
297   void Remove (const Handle(SelectMgr_Selection)& aSelection);
298
299 protected:
300
301   Standard_Boolean preferclosest;
302   Standard_Real mytolerance;
303   Standard_Boolean myToUpdateTolerance;
304   SelectMgr_IndexedDataMapOfOwnerCriterion mystored;
305   SelectMgr_SelectingVolumeManager mySelectingVolumeMgr;
306   mutable NCollection_Handle<SelectMgr_SelectableObjectSet> mySelectableObjects;
307   SelectMgr_ToleranceMap myTolerances;
308
309 private:
310
311   Handle_TColStd_HArray1OfInteger              myIndexes;
312   Standard_Integer                             myCurRank;
313   Standard_Boolean                             myIsLeftChildQueuedFirst;
314   Standard_Integer                             myEntityIdx;
315   SelectMgr_MapOfObjectSensitives              myMapOfObjectSensitives;
316   SelectMgr_MapOfOwnerDetectedEntities         myMapOfDetected;
317   SelectMgr_MapOfOwnerDetectedEntitiesIterator myDetectedIter;
318 };
319
320 DEFINE_STANDARD_HANDLE(SelectMgr_ViewerSelector, MMgt_TShared)
321
322 #include <SelectMgr_ViewerSelector.lxx>
323
324 #endif