0032506: Visualization - add AIS_InteractiveContext::ObjectIterator() for iterating...
[occt.git] / src / AIS / AIS_InteractiveContext.hxx
1 // Created on: 1996-12-18
2 // Created by: Robert COUBLANC
3 // Copyright (c) 1996-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 #ifndef _AIS_InteractiveContext_HeaderFile
18 #define _AIS_InteractiveContext_HeaderFile
19
20 #include <AIS_DataMapOfIOStatus.hxx>
21 #include <AIS_DisplayMode.hxx>
22 #include <AIS_DisplayStatus.hxx>
23 #include <AIS_ClearMode.hxx>
24 #include <AIS_KindOfInteractive.hxx>
25 #include <AIS_ListOfInteractive.hxx>
26 #include <AIS_Selection.hxx>
27 #include <AIS_SelectionModesConcurrency.hxx>
28 #include <AIS_SelectionScheme.hxx>
29 #include <AIS_StatusOfDetection.hxx>
30 #include <AIS_StatusOfPick.hxx>
31 #include <AIS_TypeOfIso.hxx>
32 #include <Aspect_TypeOfFacingModel.hxx>
33 #include <Graphic3d_Vec2.hxx>
34 #include <Prs3d_Drawer.hxx>
35 #include <Prs3d_TypeOfHighlight.hxx>
36 #include <PrsMgr_PresentationManager.hxx>
37 #include <SelectMgr_AndOrFilter.hxx>
38 #include <SelectMgr_IndexedMapOfOwner.hxx>
39 #include <SelectMgr_ListOfFilter.hxx>
40 #include <SelectMgr_PickingStrategy.hxx>
41 #include <StdSelect_ViewerSelector3d.hxx>
42 #include <TCollection_AsciiString.hxx>
43 #include <TColgp_Array1OfPnt2d.hxx>
44 #include <TColStd_ListOfInteger.hxx>
45 #include <TopAbs_ShapeEnum.hxx>
46 #include <Quantity_Color.hxx>
47
48 class SelectMgr_SelectionManager;
49 class V3d_Viewer;
50 class V3d_View;
51 class TopLoc_Location;
52 class TCollection_ExtendedString;
53 class Prs3d_LineAspect;
54 class Prs3d_BasicAspect;
55 class TopoDS_Shape;
56 class SelectMgr_EntityOwner;
57 class SelectMgr_Filter;
58
59 //! The Interactive Context allows you to manage graphic behavior and selection of Interactive Objects in one or more viewers.
60 //! Class methods make this highly transparent.
61 //! It is essential to remember that an Interactive Object which is already known by the Interactive Context must be modified using Context methods.
62 //! You can only directly call the methods available for an Interactive Object if it has not been loaded into an Interactive Context.
63 //!
64 //! Each selectable object must specify the selection mode that is
65 //! responsible for selection of object as a whole (global selection mode).
66 //! Interactive context itself supports decomposed object selection with selection filters support.
67 //! By default, global selection mode is equal to 0, but it might be redefined if needed.
68 class AIS_InteractiveContext : public Standard_Transient
69 {
70   DEFINE_STANDARD_RTTIEXT(AIS_InteractiveContext, Standard_Transient)
71 public: //! @name object display management
72
73   //! Constructs the interactive context object defined by the principal viewer MainViewer.
74   Standard_EXPORT AIS_InteractiveContext(const Handle(V3d_Viewer)& MainViewer);
75
76   //! Destructor.
77   Standard_EXPORT virtual ~AIS_InteractiveContext();
78
79   //! Returns the display status of the entity anIobj.
80   //! This will be one of the following:
81   //! - AIS_DS_Displayed displayed in main viewer
82   //! - AIS_DS_Erased    hidden in main viewer
83   //! - AIS_DS_Temporary temporarily displayed
84   //! - AIS_DS_None      nowhere displayed.
85   Standard_EXPORT PrsMgr_DisplayStatus DisplayStatus (const Handle(AIS_InteractiveObject)& anIobj) const;
86
87   //! Returns the status of the Interactive Context for the view of the Interactive Object.
88   Standard_EXPORT void Status (const Handle(AIS_InteractiveObject)& anObj, TCollection_ExtendedString& astatus) const;
89
90   //! Returns true if Object is displayed in the interactive context.
91   Standard_EXPORT Standard_Boolean IsDisplayed (const Handle(AIS_InteractiveObject)& anIobj) const;
92
93   Standard_EXPORT Standard_Boolean IsDisplayed (const Handle(AIS_InteractiveObject)& aniobj, const Standard_Integer aMode) const;
94
95   //! Enable or disable automatic activation of default selection mode while displaying the object.
96   void SetAutoActivateSelection (const Standard_Boolean theIsAuto) { myIsAutoActivateSelMode = theIsAuto; }
97
98   //! Manages displaying the new object should also automatically activate default selection mode; TRUE by default.
99   Standard_Boolean GetAutoActivateSelection() const { return myIsAutoActivateSelMode; }
100
101   //! Displays the object in this Context using default Display Mode.
102   //! This will be the object's default display mode, if there is one. Otherwise, it will be the context mode.
103   //! The Interactive Object's default selection mode is activated if GetAutoActivateSelection() is TRUE. In general, this is 0.
104   Standard_EXPORT void Display (const Handle(AIS_InteractiveObject)& theIObj,
105                                 const Standard_Boolean               theToUpdateViewer);
106
107   //! Sets status, display mode and selection mode for specified Object
108   //! If theSelectionMode equals -1, theIObj will not be activated: it will be displayed but will not be selectable.
109   Standard_EXPORT void Display (const Handle(AIS_InteractiveObject)& theIObj,
110                                 const Standard_Integer               theDispMode,
111                                 const Standard_Integer               theSelectionMode,
112                                 const Standard_Boolean               theToUpdateViewer,
113                                 const PrsMgr_DisplayStatus           theDispStatus = PrsMgr_DisplayStatus_None);
114
115   //! Allows you to load the Interactive Object with a given selection mode,
116   //! and/or with the desired decomposition option, whether the object is visualized or not.
117   //! The loaded objects will be selectable but displayable in highlighting only when detected by the Selector.
118   Standard_EXPORT void Load (const Handle(AIS_InteractiveObject)& theObj, const Standard_Integer theSelectionMode = -1);
119
120   //! Hides the object. The object's presentations are simply flagged as invisible and therefore excluded from redrawing.
121   //! To show hidden objects, use Display().
122   Standard_EXPORT void Erase (const Handle(AIS_InteractiveObject)& theIObj,
123                               const Standard_Boolean               theToUpdateViewer);
124   
125   //! Hides all objects. The object's presentations are simply flagged as invisible and therefore excluded from redrawing.
126   //! To show all hidden objects, use DisplayAll().
127   Standard_EXPORT void EraseAll (const Standard_Boolean theToUpdateViewer);
128   
129   //! Displays all hidden objects.
130   Standard_EXPORT void DisplayAll (const Standard_Boolean theToUpdateViewer);
131
132   //! Hides selected objects. The object's presentations are simply flagged as invisible and therefore excluded from redrawing.
133   //! To show hidden objects, use Display().
134   Standard_EXPORT void EraseSelected (const Standard_Boolean theToUpdateViewer);
135
136   //! Displays current objects.
137   Standard_EXPORT void DisplaySelected (const Standard_Boolean theToUpdateViewer);
138   
139   //! Empties the graphic presentation of the mode indexed by aMode.
140   //! Warning! Removes theIObj. theIObj is still active if it was previously activated.
141   void ClearPrs (const Handle(AIS_InteractiveObject)& theIObj,
142                  const Standard_Integer               theMode,
143                  const Standard_Boolean               theToUpdateViewer) { ClearGlobalPrs (theIObj, theMode, theToUpdateViewer); }
144
145   //! Removes Object from every viewer.
146   Standard_EXPORT void Remove (const Handle(AIS_InteractiveObject)& theIObj,
147                                const Standard_Boolean               theToUpdateViewer);
148
149   //! Removes all the objects from Context.
150   Standard_EXPORT void RemoveAll (const Standard_Boolean theToUpdateViewer);
151
152   //! Recomputes the seen parts presentation of the Object.
153   //! If theAllModes equals true, all presentations are present in the object even if unseen.
154   Standard_EXPORT void Redisplay (const Handle(AIS_InteractiveObject)& theIObj,
155                                   const Standard_Boolean               theToUpdateViewer,
156                                   const Standard_Boolean               theAllModes = Standard_False);
157
158   //! Recomputes the Prs/Selection of displayed objects of a given type and a given signature.
159   //! if signature = -1  doesn't take signature criterion.
160   Standard_EXPORT void Redisplay (const AIS_KindOfInteractive theTypeOfObject,
161                                   const Standard_Integer      theSignature,
162                                   const Standard_Boolean      theToUpdateViewer);
163
164   //! Recomputes the displayed presentations, flags the others.
165   //! Doesn't update presentations.
166   Standard_EXPORT void RecomputePrsOnly (const Handle(AIS_InteractiveObject)& theIObj,
167                                          const Standard_Boolean               theToUpdateViewer,
168                                          const Standard_Boolean               theAllModes = Standard_False);
169
170   //! Recomputes the active selections, flags the others.
171   //! Doesn't update presentations.
172   Standard_EXPORT void RecomputeSelectionOnly (const Handle(AIS_InteractiveObject)& anIObj);
173
174   //! Updates displayed interactive object by checking and recomputing its flagged as "to be recomputed" presentation and selection structures.
175   //! This method does not force any recomputation on its own.
176   //! The method recomputes selections even if they are loaded without activation in particular selector.
177   Standard_EXPORT void Update (const Handle(AIS_InteractiveObject)& theIObj,
178                                const Standard_Boolean               theUpdateViewer);
179
180 public: //! @name highlighting management
181
182   //! Returns default highlight style settings (could be overridden by PrsMgr_PresentableObject).
183   //!
184   //! Tip: although highlighting style is defined by Prs3d_Drawer,
185   //! only a small set of properties derived from it's base class Graphic3d_PresentationAttributes will be actually used in most cases.
186   //!
187   //! Default highlight style for all types is Aspect_TOHM_COLOR. Other defaults:
188   //!  - Prs3d_TypeOfHighlight_Dynamic
189   //!    * Color: Quantity_NOC_CYAN1;
190   //!    * Layer: Graphic3d_ZLayerId_Top,
191   //!             object highlighting is drawn on top of main scene within Immediate Layers,
192   //!             so that V3d_View::RedrawImmediate() will be enough to see update;
193   //!  - Prs3d_TypeOfHighlight_LocalDynamic
194   //!    * Color: Quantity_NOC_CYAN1;
195   //!    * Layer: Graphic3d_ZLayerId_Topmost,
196   //!             object parts highlighting is drawn on top of main scene within Immediate Layers
197   //!             with depth cleared (even overlapped geometry will be revealed);
198   //!  - Prs3d_TypeOfHighlight_Selected
199   //!    * Color: Quantity_NOC_GRAY80;
200   //!    * Layer: Graphic3d_ZLayerId_UNKNOWN,
201   //!             object highlighting is drawn on top of main scene within the same layer
202   //!             as object itself (e.g. Graphic3d_ZLayerId_Default by default) and increased priority.
203   //!
204   //! @param[in] theStyleType highlight style to modify
205   //! @return drawer associated to specified highlight type
206   //!
207   //! @sa MoveTo() using Prs3d_TypeOfHighlight_Dynamic and Prs3d_TypeOfHighlight_LocalDynamic types
208   //! @sa SelectDetected() using Prs3d_TypeOfHighlight_Selected and Prs3d_TypeOfHighlight_LocalSelected types
209   //! @sa PrsMgr_PresentableObject::DynamicHilightAttributes() overriding Prs3d_TypeOfHighlight_Dynamic and Prs3d_TypeOfHighlight_LocalDynamic defaults on object level
210   //! @sa PrsMgr_PresentableObject::HilightAttributes() overriding Prs3d_TypeOfHighlight_Selected and Prs3d_TypeOfHighlight_LocalSelected defaults on object level
211   const Handle(Prs3d_Drawer)& HighlightStyle (const Prs3d_TypeOfHighlight theStyleType) const { return myStyles[theStyleType]; }
212
213   //! Setup highlight style settings.
214   //! Tip: it is better modifying existing style returned by method HighlightStyle()
215   //! instead of creating a new Prs3d_Drawer to avoid unexpected results due misconfiguration.
216   //!
217   //! If a new highlight style is created, its presentation Zlayer should be checked,
218   //! otherwise highlighting might not work as expected.
219   void SetHighlightStyle (const Prs3d_TypeOfHighlight theStyleType,
220                           const Handle(Prs3d_Drawer)& theStyle) { myStyles[theStyleType] = theStyle; }
221
222   //! Returns current dynamic highlight style settings corresponding to Prs3d_TypeOfHighlight_Dynamic.
223   //! This is just a short-cut to HighlightStyle(Prs3d_TypeOfHighlight_Dynamic).
224   const Handle(Prs3d_Drawer)& HighlightStyle() const
225   {
226     return myStyles[Prs3d_TypeOfHighlight_Dynamic];
227   }
228
229   //! Setup the style of dynamic highlighting corrsponding to Prs3d_TypeOfHighlight_Selected.
230   //! This is just a short-cut to SetHighlightStyle(Prs3d_TypeOfHighlight_Dynamic,theStyle).
231   void SetHighlightStyle (const Handle(Prs3d_Drawer)& theStyle) { myStyles[Prs3d_TypeOfHighlight_Dynamic] = theStyle; }
232
233   //! Returns current selection style settings corrsponding to Prs3d_TypeOfHighlight_Selected.
234   //! This is just a short-cut to HighlightStyle(Prs3d_TypeOfHighlight_Selected).
235   const Handle(Prs3d_Drawer)& SelectionStyle() const
236   {
237     return myStyles[Prs3d_TypeOfHighlight_Selected];
238   }
239
240   //! Setup the style of selection highlighting.
241   //! This is just a short-cut to SetHighlightStyle(Prs3d_TypeOfHighlight_Selected,theStyle).
242   void SetSelectionStyle (const Handle(Prs3d_Drawer)& theStyle) { myStyles[Prs3d_TypeOfHighlight_Selected] = theStyle; }
243
244   //! Returns highlight style of the object if it is marked as highlighted via global status
245   //! @param theObj [in] the object to check
246   Standard_EXPORT Standard_Boolean HighlightStyle (const Handle(AIS_InteractiveObject)& theObj,
247                                                    Handle(Prs3d_Drawer)& theStyle) const;
248
249   //! Returns highlight style of the owner if it is selected
250   //! @param theOwner [in] the owner to check
251   Standard_EXPORT Standard_Boolean HighlightStyle (const Handle(SelectMgr_EntityOwner)& theOwner,
252                                                    Handle(Prs3d_Drawer)& theStyle) const;
253
254   //! Returns true if the object is marked as highlighted via its global status
255   //! @param theObj [in] the object to check
256   Standard_EXPORT Standard_Boolean IsHilighted (const Handle(AIS_InteractiveObject)& theObj) const;
257
258   //! Returns true if the owner is marked as selected
259   //! @param theOwner [in] the owner to check
260   Standard_EXPORT Standard_Boolean IsHilighted (const Handle(SelectMgr_EntityOwner)& theOwner) const;
261
262   //! Changes the color of all the lines of the object in view.
263   Standard_EXPORT void HilightWithColor (const Handle(AIS_InteractiveObject)& theObj,
264                                          const Handle(Prs3d_Drawer)&          theStyle,
265                                          const Standard_Boolean               theToUpdateViewer);
266
267   //! Removes hilighting from the Object.
268   Standard_EXPORT void Unhilight (const Handle(AIS_InteractiveObject)& theIObj,
269                                   const Standard_Boolean               theToUpdateViewer);
270
271 public: //! @name object presence management (View affinity, Layer, Priority)
272
273   //! Returns the display priority of the Object.
274   Standard_EXPORT Standard_Integer DisplayPriority (const Handle(AIS_InteractiveObject)& theIObj) const;
275
276   //! Sets the display priority of the seen parts presentation of the Object.
277   Standard_EXPORT void SetDisplayPriority (const Handle(AIS_InteractiveObject)& theIObj, const Standard_Integer thePriority);
278
279   //! Get Z layer id set for displayed interactive object.
280   Standard_EXPORT Graphic3d_ZLayerId GetZLayer (const Handle(AIS_InteractiveObject)& theIObj) const;
281
282   //! Set Z layer id for interactive object.
283   //! The Z layers can be used to display temporarily presentations of some object in front of the other objects in the scene.
284   //! The ids for Z layers are generated by V3d_Viewer.
285   Standard_EXPORT void SetZLayer (const Handle(AIS_InteractiveObject)& theIObj, const Graphic3d_ZLayerId theLayerId);
286
287   //! Setup object visibility in specified view.
288   //! Has no effect if object is not displayed in this context.
289   Standard_EXPORT void SetViewAffinity (const Handle(AIS_InteractiveObject)& theIObj, const Handle(V3d_View)& theView, const Standard_Boolean theIsVisible);
290
291 public: //! @name Display Mode management
292
293   //! Returns the Display Mode setting to be used by default.
294   Standard_Integer DisplayMode() const { return myDefaultDrawer->DisplayMode(); }
295
296   //! Sets the display mode of seen Interactive Objects (which have no overridden Display Mode).
297   Standard_EXPORT void SetDisplayMode (const Standard_Integer theMode,
298                                        const Standard_Boolean theToUpdateViewer);
299
300   //! Sets the display mode of seen Interactive Objects.
301   //! theMode provides the display mode index of the entity theIObj.
302   Standard_EXPORT void SetDisplayMode (const Handle(AIS_InteractiveObject)& theIObj,
303                                        const Standard_Integer               theMode,
304                                        const Standard_Boolean               theToUpdateViewer);
305
306   //! Unsets the display mode of seen Interactive Objects.
307   Standard_EXPORT void UnsetDisplayMode (const Handle(AIS_InteractiveObject)& theIObj,
308                                          const Standard_Boolean               theToUpdateViewer);
309
310 public: //! @name object local transformation management
311
312   //! Puts the location on the initial graphic representation and the selection for the Object.
313   Standard_EXPORT void SetLocation (const Handle(AIS_InteractiveObject)& theObject, const TopLoc_Location& theLocation);
314
315   //! Puts the Object back into its initial position.
316   Standard_EXPORT void ResetLocation (const Handle(AIS_InteractiveObject)& theObject);
317
318   //! Returns true if the Object has a location.
319   Standard_EXPORT Standard_Boolean HasLocation (const Handle(AIS_InteractiveObject)& theObject) const;
320
321   //! Returns the location of the Object.
322   Standard_EXPORT TopLoc_Location Location (const Handle(AIS_InteractiveObject)& theObject) const;
323
324   //! Sets transform persistence.
325   Standard_EXPORT void SetTransformPersistence (const Handle(AIS_InteractiveObject)& theObject,
326                                                 const Handle(Graphic3d_TransformPers)& theTrsfPers);
327
328 public: //! @name mouse picking logic (detection and dynamic highlighting of entities under cursor)
329
330   //! Setup pixel tolerance for MoveTo() operation.
331   //! @sa MoveTo().
332   Standard_EXPORT void SetPixelTolerance (const Standard_Integer thePrecision = 2);
333
334   //! Returns the pixel tolerance, default is 2.
335   //! Pixel Tolerance extends sensitivity within MoveTo() operation (picking by point)
336   //! and can be adjusted by application based on user input precision (e.g. screen pixel density, input device precision, etc.).
337   Standard_EXPORT Standard_Integer PixelTolerance() const;
338
339   //! Allows to manage sensitivity of a particular selection of interactive object theObject
340   //! and changes previous sensitivity value of all sensitive entities in selection with theMode
341   //! to the given theNewSensitivity.
342   Standard_EXPORT void SetSelectionSensitivity (const Handle(AIS_InteractiveObject)& theObject,
343                                                 const Standard_Integer theMode,
344                                                 const Standard_Integer theNewSensitivity);
345
346   //! Returns last active View (argument of MoveTo()/Select() methods).
347   Standard_EXPORT Handle(V3d_View) LastActiveView() const;
348
349   //! Relays mouse position in pixels theXPix and theYPix to the interactive context selectors.
350   //! This is done by the view theView passing this position to the main viewer and updating it.
351   //! If theToRedrawOnUpdate is set to false, callee should call RedrawImmediate() to highlight detected object.
352   //! @sa PickingStrategy()
353   //! @sa HighlightStyle() defining default dynamic highlight styles of detected owners
354   //!                      (Prs3d_TypeOfHighlight_Dynamic and Prs3d_TypeOfHighlight_LocalDynamic)
355   //! @sa PrsMgr_PresentableObject::DynamicHilightAttributes() defining per-object dynamic highlight style of detected owners (overrides defaults)
356   Standard_EXPORT AIS_StatusOfDetection MoveTo (const Standard_Integer  theXPix,
357                                                 const Standard_Integer  theYPix,
358                                                 const Handle(V3d_View)& theView,
359                                                 const Standard_Boolean  theToRedrawOnUpdate);
360
361   //! Relays axis theAxis to the interactive context selectors.
362   //! This is done by the view theView passing this axis to the main viewer and updating it.
363   //! If theToRedrawOnUpdate is set to false, callee should call RedrawImmediate() to highlight detected object.
364   //! @sa PickingStrategy()
365   Standard_EXPORT AIS_StatusOfDetection MoveTo (const gp_Ax1& theAxis,
366                                                 const Handle(V3d_View)& theView,
367                                                 const Standard_Boolean  theToRedrawOnUpdate);
368
369   //! Clears the list of entities detected by MoveTo() and resets dynamic highlighting.
370   //! @param theToRedrawImmediate if TRUE, the main Viewer will be redrawn on update
371   //! @return TRUE if viewer needs to be updated (e.g. there were actually dynamically highlighted entities)
372   Standard_EXPORT Standard_Boolean ClearDetected (Standard_Boolean theToRedrawImmediate = Standard_False);
373
374   //! Returns true if there is a mouse-detected entity in context.
375   //! @sa DetectedOwner(), HasNextDetected(), HilightPreviousDetected(), HilightNextDetected().
376   Standard_Boolean HasDetected() const { return !myLastPicked.IsNull(); }
377
378   //! Returns the owner of the detected sensitive primitive which is currently dynamically highlighted.
379   //! WARNING! This method is irrelevant to InitDetected()/MoreDetected()/NextDetected().
380   //! @sa HasDetected(), HasNextDetected(), HilightPreviousDetected(), HilightNextDetected().
381   const Handle(SelectMgr_EntityOwner)& DetectedOwner() const { return myLastPicked; }
382
383   //! Returns the interactive objects last detected in context.
384   //! In general this is just a wrapper for Handle(AIS_InteractiveObject)::DownCast(DetectedOwner()->Selectable()).
385   //! @sa DetectedOwner()
386   Handle(AIS_InteractiveObject) DetectedInteractive() const { return Handle(AIS_InteractiveObject)::DownCast (myLastPicked->Selectable()); }
387
388   //! Returns true if there is a detected shape in local context.
389   //! @sa HasDetected(), DetectedShape()
390   Standard_DEPRECATED ("Local Context is deprecated - local selection should be used without Local Context")
391   Standard_EXPORT Standard_Boolean HasDetectedShape() const;
392
393   //! Returns the shape detected in local context.
394   //! @sa DetectedOwner()
395   Standard_DEPRECATED ("Local Context is deprecated - local selection should be used without Local Context")
396   Standard_EXPORT const TopoDS_Shape& DetectedShape() const;
397   
398   //! returns True if other entities were detected in the last mouse detection
399   //! @sa HilightPreviousDetected(), HilightNextDetected().
400   Standard_Boolean HasNextDetected() const { return !myDetectedSeq.IsEmpty() && myCurHighlighted <= myDetectedSeq.Upper(); }
401
402   //! If more than 1 object is detected by the selector, only the "best" owner is hilighted at the mouse position.
403   //! This Method allows the user to hilight one after another the other detected entities.
404   //! If The method select is called, the selected entity will be the hilighted one!
405   //! WARNING: Loop Method. When all the detected entities have been hilighted, the next call will hilight the first one again.
406   //! @return the Rank of hilighted entity
407   //! @sa HasNextDetected(), HilightPreviousDetected().
408   Standard_EXPORT Standard_Integer HilightNextDetected (const Handle(V3d_View)& theView, const Standard_Boolean theToRedrawImmediate = Standard_True);
409
410   //! Same as previous methods in reverse direction.
411   //! @sa HasNextDetected(), HilightNextDetected().
412   Standard_EXPORT Standard_Integer HilightPreviousDetected (const Handle(V3d_View)& theView, const Standard_Boolean theToRedrawImmediate = Standard_True);
413
414 public: //! @name iteration through detected entities
415
416   //! Initialization for iteration through mouse-detected objects in
417   //! interactive context or in local context if it is opened.
418   //! @sa DetectedCurrentOwner(), MoreDetected(), NextDetected().
419   void InitDetected()
420   {
421     if (!myDetectedSeq.IsEmpty())
422     {
423       myCurDetected = myDetectedSeq.Lower();
424     }
425   }
426
427   //! Return TRUE if there is more mouse-detected objects after the current one
428   //! during iteration through mouse-detected interactive objects.
429   //! @sa DetectedCurrentOwner(), InitDetected(), NextDetected().
430   Standard_Boolean MoreDetected() const { return myCurDetected >= myDetectedSeq.Lower() && myCurDetected <= myDetectedSeq.Upper(); }
431
432   //! Gets next current object during iteration through mouse-detected interactive objects.
433   //! @sa DetectedCurrentOwner(), InitDetected(), MoreDetected().
434   void NextDetected() { ++myCurDetected; }
435
436   //! Returns the owner from detected list pointed by current iterator position.
437   //! WARNING! This method is irrelevant to DetectedOwner() which returns last picked Owner regardless of iterator position!
438   //! @sa InitDetected(), MoreDetected(), NextDetected().
439   Standard_EXPORT Handle(SelectMgr_EntityOwner) DetectedCurrentOwner() const;
440
441 public: //! @name Selection management
442
443   //! Adds object in the selection.
444   Standard_EXPORT AIS_StatusOfPick AddSelect (const Handle(SelectMgr_EntityOwner)& theObject);
445
446   //! Adds object in the selection.
447   AIS_StatusOfPick AddSelect (const Handle(AIS_InteractiveObject)& theObject)
448   {
449     return AddSelect (theObject->GlobalSelOwner());
450   }
451
452   //! Selects objects within the bounding rectangle.
453   //! Viewer should be explicitly redrawn after selection.
454   //! @param thePntMin [in] rectangle lower point (in pixels)
455   //! @param thePntMax [in] rectangle upper point (in pixels)
456   //! @param theView   [in] active view where rectangle is defined
457   //! @param theSelScheme [in] selection scheme
458   //! @return picking status
459   //! @sa StdSelect_ViewerSelector3d::AllowOverlapDetection()
460   Standard_EXPORT AIS_StatusOfPick SelectRectangle (const Graphic3d_Vec2i&    thePntMin,
461                                                     const Graphic3d_Vec2i&    thePntMax,
462                                                     const Handle(V3d_View)&   theView,
463                                                     const AIS_SelectionScheme theSelScheme = AIS_SelectionScheme_Replace);
464
465   //! Select everything found in the polygon defined by bounding polyline.
466   //! Viewer should be explicitly redrawn after selection.
467   //! @param thePolyline  [in] polyline defining polygon bounds (in pixels)
468   //! @param theView      [in] active view where polyline is defined
469   //! @param theSelScheme [in] selection scheme
470   //! @return picking status
471   Standard_EXPORT AIS_StatusOfPick SelectPolygon (const TColgp_Array1OfPnt2d& thePolyline,
472                                                   const Handle(V3d_View)&     theView,
473                                                   const AIS_SelectionScheme   theSelScheme = AIS_SelectionScheme_Replace);
474
475   //! Selects the topmost object picked by the point in the view,
476   //! Viewer should be explicitly redrawn after selection.
477   //! @param thePnt  [in] point pixel coordinates within the view
478   //! @param theView [in] active view where point is defined
479   //! @param theSelScheme [in] selection scheme
480   //! @return picking status
481   Standard_EXPORT AIS_StatusOfPick SelectPoint (const Graphic3d_Vec2i&    thePnt,
482                                                 const Handle(V3d_View)&   theView,
483                                                 const AIS_SelectionScheme theSelScheme = AIS_SelectionScheme_Replace);
484
485   //! Select and hilights the previous detected via AIS_InteractiveContext::MoveTo() method;
486   //! unhilights the previous picked.
487   //! Viewer should be explicitly redrawn after selection.
488   //! @param theSelScheme [in] selection scheme
489   //! @return picking status
490   //!
491   //! @sa HighlightStyle() defining default highlight styles of selected owners (Prs3d_TypeOfHighlight_Selected and Prs3d_TypeOfHighlight_LocalSelected)
492   //! @sa PrsMgr_PresentableObject::HilightAttributes() defining per-object highlight style of selected owners (overrides defaults)
493   Standard_EXPORT AIS_StatusOfPick SelectDetected (const AIS_SelectionScheme theSelScheme = AIS_SelectionScheme_Replace);
494
495   //! Returns bounding box of selected objects.
496   Standard_EXPORT Bnd_Box BoundingBoxOfSelection() const;
497
498   //! Sets list of owner selected/deselected using specified selection scheme.
499   //! @param theOwners owners to change selection state
500   //! @param theSelScheme selection scheme
501   //! @return picking status
502   Standard_EXPORT AIS_StatusOfPick Select (const AIS_NArray1OfEntityOwner& theOwners,
503                                            const AIS_SelectionScheme theSelScheme);
504
505   //! Fits the view correspondingly to the bounds of selected objects.
506   //! Infinite objects are ignored if infinite state of AIS_InteractiveObject is set to true.
507   Standard_EXPORT void FitSelected (const Handle(V3d_View)& theView,
508                                     const Standard_Real     theMargin,
509                                     const Standard_Boolean  theToUpdate);
510
511   //! Fits the view correspondingly to the bounds of selected objects.
512   //! Infinite objects are ignored if infinite state of AIS_InteractiveObject is set to true.
513   Standard_EXPORT void FitSelected (const Handle(V3d_View)& theView);
514
515   //! Return value specified whether selected object must be hilighted when mouse cursor is moved above it
516   //! @sa MoveTo()
517   Standard_Boolean ToHilightSelected() const { return myToHilightSelected; }
518
519   //! Specify whether selected object must be hilighted when mouse cursor is moved above it (in MoveTo method).
520   //! By default this value is false and selected object is not hilighted in this case.
521   //! @sa MoveTo()
522   void SetToHilightSelected (const Standard_Boolean toHilight) { myToHilightSelected = toHilight; }
523
524   //! Returns true if the automatic highlight mode is active; TRUE by default.
525   //! @sa MoveTo(), Select(), HilightWithColor(), Unhilight()
526   Standard_Boolean AutomaticHilight() const { return myAutoHilight; }
527
528   //! Sets the highlighting status of detected and selected entities.
529   //! This function allows you to disconnect the automatic mode.
530   //!
531   //! MoveTo() will fill the list of detected entities
532   //! and Select() will set selected state to detected objects regardless of this flag,
533   //! but with disabled AutomaticHiligh() their highlighting state will be left unaffected,
534   //! so that application will be able performing custom highlighting in a different way, if needed.
535   //!
536   //! This API should be distinguished from SelectMgr_SelectableObject::SetAutoHilight()
537   //! that is used to implement custom highlighting logic for a specific interactive object class.
538   //!
539   //! @sa MoveTo(), Select(), HilightWithColor(), Unhilight()
540   void SetAutomaticHilight (Standard_Boolean theStatus) { myAutoHilight = theStatus; }
541
542   //! Unhighlights previously selected owners and marks them as not selected.
543   //! Marks owner given as selected and highlights it.
544   //! Performs selection filters check.
545   Standard_EXPORT void SetSelected (const Handle(SelectMgr_EntityOwner)& theOwners,
546                                     const Standard_Boolean               theToUpdateViewer);
547
548   //! Puts the interactive object aniObj in the list of selected objects.
549   //! Performs selection filters check.
550   Standard_EXPORT void SetSelected (const Handle(AIS_InteractiveObject)& theObject,
551                                     const Standard_Boolean               theToUpdateViewer);
552
553   //! Allows to highlight or unhighlight the owner given depending on its selection status
554   Standard_EXPORT void AddOrRemoveSelected (const Handle(AIS_InteractiveObject)& theObject,
555                                             const Standard_Boolean               theToUpdateViewer);
556
557   //! Updates Selected state of specified owner without calling HilightSelected().
558   //! Has no effect if Selected state is not changed, and redirects to AddOrRemoveSelected() otherwise.
559   //! @param theOwner owner object to set selected state
560   //! @param theIsSelected new selected state
561   //! @return TRUE if Selected state has been changed
562   Standard_EXPORT Standard_Boolean SetSelectedState (const Handle(SelectMgr_EntityOwner)& theOwner,
563                                                      const Standard_Boolean               theIsSelected);
564
565   //! Highlights selected objects.
566   Standard_EXPORT void HilightSelected (const Standard_Boolean theToUpdateViewer);
567
568   //! Removes highlighting from selected objects.
569   Standard_EXPORT void UnhilightSelected (const Standard_Boolean theToUpdateViewer);
570
571   //! Updates the list of selected objects:
572   //! i.e. highlights the newly selected ones and unhighlights previously selected objects.
573   //! @sa HilightSelected().
574   void UpdateSelected (Standard_Boolean theToUpdateViewer) { HilightSelected (theToUpdateViewer); }
575
576   //! Empties previous selected objects in order to get the selected objects detected by the selector using UpdateSelected.
577   Standard_EXPORT void ClearSelected (const Standard_Boolean theToUpdateViewer);
578
579   //! Allows to highlight or unhighlight the owner given depending on its selection status
580   Standard_EXPORT void AddOrRemoveSelected (const Handle(SelectMgr_EntityOwner)& theOwner,
581                                             const Standard_Boolean               theToUpdateViewer);
582
583   //! Returns true is the owner given is selected
584   Standard_Boolean IsSelected (const Handle(SelectMgr_EntityOwner)& theOwner) const { return !theOwner.IsNull() && theOwner->IsSelected(); }
585
586   //! Returns true is the object given is selected
587   Standard_EXPORT Standard_Boolean IsSelected (const Handle(AIS_InteractiveObject)& theObj) const;
588
589   //! Returns the first selected object in the list of current selected.
590   Standard_EXPORT Handle(AIS_InteractiveObject) FirstSelectedObject() const;
591
592   //! Count a number of selected entities using InitSelected()+MoreSelected()+NextSelected() iterator.
593   //! @sa SelectedOwner(), InitSelected(), MoreSelected(), NextSelected().
594   Standard_Integer NbSelected() { return mySelection->Extent(); }
595
596   //! Initializes a scan of the selected objects.
597   //! @sa SelectedOwner(), MoreSelected(), NextSelected().
598   void InitSelected() { mySelection->Init(); }
599
600   //! Returns true if there is another object found by the scan of the list of selected objects.
601   //! @sa SelectedOwner(), InitSelected(), NextSelected().
602   Standard_Boolean MoreSelected() const { return mySelection->More(); }
603
604   //! Continues the scan to the next object in the list of selected objects.
605   //! @sa SelectedOwner(), InitSelected(), MoreSelected().
606   void NextSelected() { mySelection->Next(); }
607
608   //! Returns the owner of the selected entity.
609   //! @sa InitSelected(), MoreSelected(), NextSelected().
610   Handle(SelectMgr_EntityOwner) SelectedOwner() const
611   {
612     return !mySelection->More()
613           ? Handle(SelectMgr_EntityOwner)()
614           : mySelection->Value();
615   }
616
617   //! Return Handle(AIS_InteractiveObject)::DownCast (SelectedOwner()->Selectable()).
618   //! @sa SelectedOwner().
619   Handle(AIS_InteractiveObject) SelectedInteractive() const
620   {
621     return !mySelection->More()
622          ? Handle(AIS_InteractiveObject)()
623          : Handle(AIS_InteractiveObject)::DownCast (mySelection->Value()->Selectable());
624   }
625
626   //! Returns TRUE if the interactive context has a shape selected.
627   //! @sa SelectedShape().
628   Standard_EXPORT Standard_Boolean HasSelectedShape() const;
629
630   //! Returns the selected shape.
631   //! Basically it is just a shape returned stored by StdSelect_BRepOwner with graphic transformation being applied:
632   //! @code
633   //!   const Handle(StdSelect_BRepOwner) aBRepOwner = Handle(StdSelect_BRepOwner)::DownCast (SelectedOwner());
634   //!   TopoDS_Shape aSelShape     = aBRepOwner->Shape();
635   //!   TopoDS_Shape aLocatedShape = aSelShape.Located (aBRepOwner->Location() * aSelShape.Location());
636   //! @endcode
637   //! @sa SelectedOwner(), HasSelectedShape().
638   Standard_EXPORT TopoDS_Shape SelectedShape() const;
639
640   //! Returns SelectedInteractive()->HasOwner().
641   //! @sa SelectedOwner().
642   Standard_Boolean HasApplicative() const { return SelectedInteractive()->HasOwner(); }
643
644   //! Returns SelectedInteractive()->GetOwner().
645   //! @sa SelectedOwner().
646   Handle(Standard_Transient) Applicative() const { return SelectedInteractive()->GetOwner(); }
647
648 public: //! @name immediate mode rendering
649
650   //! initializes the list of presentations to be displayed
651   //! returns False if no local context is opened.
652   Standard_EXPORT Standard_Boolean BeginImmediateDraw();
653   
654   //! returns True if <anIObj> has been stored in the list.
655   Standard_EXPORT Standard_Boolean ImmediateAdd (const Handle(AIS_InteractiveObject)& theObj, const Standard_Integer theMode = 0);
656   
657   //! returns True if the immediate display has been done.
658   Standard_EXPORT Standard_Boolean EndImmediateDraw (const Handle(V3d_View)& theView);
659
660   //! Uses the First Active View of Main Viewer!
661   //! returns True if the immediate display has been done.
662   Standard_EXPORT Standard_Boolean EndImmediateDraw();
663
664   Standard_EXPORT Standard_Boolean IsImmediateModeOn() const;
665
666   //! Redraws immediate structures in all views of the viewer given taking into account its visibility.
667   void RedrawImmediate (const Handle(V3d_Viewer)& theViewer) { myMainPM->RedrawImmediate (theViewer); }
668
669 public: //! @name management of active Selection Modes
670
671   //! Activates or deactivates the selection mode for specified object.
672   //! Has no effect if selection mode was already active/deactivated.
673   //! @param theObj         object to activate/deactivate selection mode
674   //! @param theMode        selection mode to activate/deactivate;
675   //!                       deactivation of -1 selection mode will effectively deactivate all selection modes;
676   //!                       activation of -1 selection mode with AIS_SelectionModesConcurrency_Single
677   //!                       will deactivate all selection modes, and will has no effect otherwise
678   //! @param theToActivate  activation/deactivation flag
679   //! @param theConcurrency specifies how to handle already activated selection modes;
680   //!                       default value (AIS_SelectionModesConcurrency_Multiple) means active selection modes should be left as is,
681   //!                       AIS_SelectionModesConcurrency_Single can be used if only one selection mode is expected to be active
682   //!                       and AIS_SelectionModesConcurrency_GlobalOrLocal can be used if either AIS_InteractiveObject::GlobalSelectionMode()
683   //!                       or any combination of Local selection modes is acceptable;
684   //!                       this value is considered only if theToActivate set to TRUE
685   //! @param theIsForce     when set to TRUE, the display status will be ignored while activating selection mode
686   Standard_EXPORT void SetSelectionModeActive (const Handle(AIS_InteractiveObject)& theObj,
687                                                const Standard_Integer theMode,
688                                                const Standard_Boolean theToActivate,
689                                                const AIS_SelectionModesConcurrency theConcurrency = AIS_SelectionModesConcurrency_Multiple,
690                                                const Standard_Boolean theIsForce = Standard_False);
691
692   //! Activates the selection mode aMode whose index is given, for the given interactive entity anIobj.
693   void Activate (const Handle(AIS_InteractiveObject)& theObj, const Standard_Integer theMode = 0, const Standard_Boolean theIsForce = Standard_False)
694   {
695     SetSelectionModeActive (theObj, theMode, Standard_True, AIS_SelectionModesConcurrency_GlobalOrLocal, theIsForce);
696   }
697
698   //! Activates the given selection mode for the all displayed objects.
699   Standard_EXPORT void Activate (const Standard_Integer theMode,
700                                  const Standard_Boolean theIsForce = Standard_False);
701   
702   //! Deactivates all the activated selection modes of an object.
703   void Deactivate (const Handle(AIS_InteractiveObject)& theObj)
704   {
705     SetSelectionModeActive (theObj, -1, Standard_False, AIS_SelectionModesConcurrency_Single);
706   }
707
708   //! Deactivates all the activated selection modes of the interactive object anIobj with a given selection mode aMode.
709   void Deactivate (const Handle(AIS_InteractiveObject)& theObj, const Standard_Integer theMode)
710   {
711     SetSelectionModeActive (theObj, theMode, Standard_False);
712   }
713
714   //! Deactivates the given selection mode for all displayed objects.
715   Standard_EXPORT void Deactivate (const Standard_Integer theMode);
716
717   //! Deactivates all the activated selection mode at all displayed objects.
718   Standard_EXPORT void Deactivate();
719
720   //! Returns the list of activated selection modes.
721   Standard_EXPORT void ActivatedModes (const Handle(AIS_InteractiveObject)& anIobj, TColStd_ListOfInteger& theList) const;
722
723   //! Returns a collection containing all entity owners created for the interactive object in specified selection mode (in all active modes if the Mode == -1)
724   Standard_EXPORT void EntityOwners (Handle(SelectMgr_IndexedMapOfOwner)& theOwners,
725                                      const Handle(AIS_InteractiveObject)& theIObj,
726                                      const Standard_Integer theMode = -1) const;
727
728 public: //! @name Selection Filters management
729
730   //! @return the context selection filter type.
731   SelectMgr_FilterType FilterType() const { return myFilters->FilterType(); }
732
733   //! Sets the context selection filter type.
734   //! SelectMgr_TypeFilter_OR selection filter is used by default.
735   //! @param theFilterType the filter type.
736   void SetFilterType (const SelectMgr_FilterType theFilterType)
737   { myFilters->SetFilterType (theFilterType); }
738
739   //! Returns the list of filters active in a local context.
740   const SelectMgr_ListOfFilter& Filters() const { return myFilters->StoredFilters(); }
741
742   //! @return the context selection global context filter.
743   const Handle(SelectMgr_AndOrFilter)& GlobalFilter() const { return myFilters; }
744
745   //! Allows you to add the filter.
746   void AddFilter (const Handle(SelectMgr_Filter)& theFilter) { myFilters->Add (theFilter); }
747
748   //! Removes a filter from context.
749   void RemoveFilter (const Handle(SelectMgr_Filter)& theFilter) { myFilters->Remove (theFilter); }
750
751   //! Remove all filters from context.
752   void RemoveFilters() { myFilters->Clear(); }
753
754   //! Return picking strategy; SelectMgr_PickingStrategy_FirstAcceptable by default.
755   //! @sa MoveTo(), Filters()
756   SelectMgr_PickingStrategy PickingStrategy() const { return myPickingStrategy; }
757
758   //! Setup picking strategy - which entities detected by picking line will be accepted, considering Selection Filters.
759   //! By default (SelectMgr_PickingStrategy_FirstAcceptable), Selection Filters reduce the list of entities
760   //! so that the context accepts topmost in remaining.
761   //!
762   //! This means that entities behind non-selectable (by filters) parts can be picked by user.
763   //! If this behavior is undesirable, and user wants that non-selectable (by filters) parts
764   //! should remain an obstacle for picking, SelectMgr_PickingStrategy_OnlyTopmost can be set instead.
765   //!
766   //! Notice, that since Selection Manager operates only objects registered in it,
767   //! SelectMgr_PickingStrategy_OnlyTopmost will NOT prevent picking entities behind
768   //! visible by unregistered in Selection Manager presentations (e.g. deactivated).
769   //! Hence, SelectMgr_PickingStrategy_OnlyTopmost changes behavior only with Selection Filters enabled.
770   void SetPickingStrategy (const SelectMgr_PickingStrategy theStrategy)
771   {
772     myPickingStrategy = theStrategy;
773   }
774
775 public: //! @name common properties
776
777   //! Returns the default attribute manager.
778   //! This contains all the color and line attributes which can be used by interactive objects which do not have their own attributes.
779   const Handle(Prs3d_Drawer)& DefaultDrawer() const { return myDefaultDrawer; }
780
781   //! Returns the current viewer.
782   const Handle(V3d_Viewer)& CurrentViewer() const { return myMainVwr; }
783
784   const Handle(SelectMgr_SelectionManager)& SelectionManager() const { return mgrSelector; }
785
786   const Handle(PrsMgr_PresentationManager)& MainPrsMgr() const { return myMainPM; }
787
788   const Handle(StdSelect_ViewerSelector3d)& MainSelector() const { return myMainSel; }
789
790   //! Updates the current viewer.
791   Standard_EXPORT void UpdateCurrentViewer();
792
793   //! Returns the list of displayed objects of a particular Type WhichKind and Signature WhichSignature.
794   //! By Default, WhichSignature equals -1. This means that there is a check on type only.
795   Standard_EXPORT void DisplayedObjects (AIS_ListOfInteractive& aListOfIO) const;
796
797   //! gives the list of displayed objects of a particular Type and signature.
798   //! by Default, <WhichSignature> = -1 means control only on <WhichKind>.
799   Standard_EXPORT void DisplayedObjects (const AIS_KindOfInteractive theWhichKind, const Standard_Integer theWhichSignature, AIS_ListOfInteractive& theListOfIO) const;
800
801   //! Returns the list theListOfIO of erased objects (hidden objects) particular Type WhichKind and Signature WhichSignature.
802   //! By Default, WhichSignature equals 1. This means that there is a check on type only.
803   Standard_EXPORT void ErasedObjects (AIS_ListOfInteractive& theListOfIO) const;
804
805   //! gives the list of erased objects (hidden objects)
806   //! Type and signature by Default, <WhichSignature> = -1 means control only on <WhichKind>.
807   Standard_EXPORT void ErasedObjects (const AIS_KindOfInteractive theWhichKind, const Standard_Integer theWhichSignature, AIS_ListOfInteractive& theListOfIO) const;
808
809   //! Returns the list theListOfIO of objects with indicated display status particular Type WhichKind and Signature WhichSignature.
810   //! By Default, WhichSignature equals 1. This means that there is a check on type only.
811   Standard_EXPORT void ObjectsByDisplayStatus (const PrsMgr_DisplayStatus theStatus, AIS_ListOfInteractive& theListOfIO) const;
812
813   //! gives the list of objects with indicated display status
814   //! Type and signature by Default, <WhichSignature> = -1 means control only on <WhichKind>.
815   Standard_EXPORT void ObjectsByDisplayStatus (const AIS_KindOfInteractive WhichKind,
816                                                const Standard_Integer WhichSignature,
817                                                const PrsMgr_DisplayStatus theStatus,
818                                                AIS_ListOfInteractive& theListOfIO) const;
819   
820   //! fills <aListOfIO> with objects of a particular Type and Signature with no consideration of display status.
821   //! by Default, <WhichSignature> = -1 means control only on <WhichKind>.
822   //! if <WhichKind> = AIS_KindOfInteractive_None and <WhichSignature> = -1, all the objects are put into the list.
823   Standard_EXPORT void ObjectsInside (AIS_ListOfInteractive& aListOfIO,
824                                       const AIS_KindOfInteractive WhichKind = AIS_KindOfInteractive_None,
825                                       const Standard_Integer WhichSignature = -1) const;
826
827   //! Create iterator through all objects registered in context.
828   AIS_DataMapIteratorOfDataMapOfIOStatus ObjectIterator() const
829   {
830     return AIS_DataMapIteratorOfDataMapOfIOStatus (myObjects);
831   }
832
833   //! Rebuilds 1st level of BVH selection forcibly
834   Standard_EXPORT void RebuildSelectionStructs();
835
836   //! Disconnects theObjToDisconnect from theAssembly and removes dependent selection structures
837   Standard_EXPORT void Disconnect (const Handle(AIS_InteractiveObject)& theAssembly, const Handle(AIS_InteractiveObject)& theObjToDisconnect = NULL);
838
839   //! Query objects visible or hidden in specified view due to affinity mask.
840   Standard_EXPORT void ObjectsForView (AIS_ListOfInteractive& theListOfIO,
841                                        const Handle(V3d_View)& theView,
842                                        const Standard_Boolean theIsVisibleInView,
843                                        const PrsMgr_DisplayStatus theStatus = PrsMgr_DisplayStatus_None) const;
844
845   //! Return rotation gravity point.
846   Standard_EXPORT virtual gp_Pnt GravityPoint (const Handle(V3d_View)& theView) const;
847
848 public: //! @name debug visualization
849
850   //! Visualization of sensitives - for debugging purposes!
851   Standard_EXPORT void DisplayActiveSensitive (const Handle(V3d_View)& aView);
852
853   //! Clear visualization of sensitives.
854   Standard_EXPORT void ClearActiveSensitive (const Handle(V3d_View)& aView);
855
856   //! Visualization of sensitives - for debugging purposes!
857   Standard_EXPORT void DisplayActiveSensitive (const Handle(AIS_InteractiveObject)& anObject, const Handle(V3d_View)& aView);
858
859 public: //! @name common object display attributes
860
861   //! Sets the graphic attributes of the interactive object, such as visualization mode, color, and material.
862   Standard_EXPORT void SetLocalAttributes (const Handle(AIS_InteractiveObject)& theIObj,
863                                            const Handle(Prs3d_Drawer)&          theDrawer,
864                                            const Standard_Boolean               theToUpdateViewer);
865
866   //! Removes the settings for local attributes of the Object and returns to defaults.
867   Standard_EXPORT void UnsetLocalAttributes (const Handle(AIS_InteractiveObject)& theIObj,
868                                              const Standard_Boolean               theToUpdateViewer);
869
870   //! change the current facing model apply on polygons for SetColor(), SetTransparency(), SetMaterial() methods default facing model is Aspect_TOFM_TWO_SIDE.
871   //! This mean that attributes is applying both on the front and back face.
872   Standard_EXPORT void SetCurrentFacingModel (const Handle(AIS_InteractiveObject)& aniobj, const Aspect_TypeOfFacingModel aModel = Aspect_TOFM_BOTH_SIDE);
873
874   //! Returns true if a view of the Interactive Object has color.
875   Standard_EXPORT Standard_Boolean HasColor (const Handle(AIS_InteractiveObject)& aniobj) const;
876
877   //! Returns the color of the Object in the interactive context.
878   Standard_EXPORT void Color (const Handle(AIS_InteractiveObject)& aniobj, Quantity_Color& acolor) const;
879
880   //! Sets the color of the selected entity.
881   Standard_EXPORT void SetColor (const Handle(AIS_InteractiveObject)& theIObj,
882                                  const Quantity_Color&                theColor,
883                                  const Standard_Boolean               theToUpdateViewer);
884
885   //! Removes the color selection for the selected entity.
886   Standard_EXPORT void UnsetColor (const Handle(AIS_InteractiveObject)& theIObj,
887                                    const Standard_Boolean               theToUpdateViewer);
888
889   //! Returns the width of the Interactive Object in the interactive context.
890   Standard_EXPORT virtual Standard_Real Width (const Handle(AIS_InteractiveObject)& aniobj) const;
891
892   //! Sets the width of the Object.
893   Standard_EXPORT virtual void SetWidth (const Handle(AIS_InteractiveObject)& theIObj,
894                                          const Standard_Real                  theValue,
895                                          const Standard_Boolean               theToUpdateViewer);
896
897   //! Removes the width setting of the Object.
898   Standard_EXPORT virtual void UnsetWidth (const Handle(AIS_InteractiveObject)& theIObj,
899                                            const Standard_Boolean               theToUpdateViewer);
900
901   //! Provides the type of material setting for the view of the Object.
902   Standard_EXPORT void SetMaterial (const Handle(AIS_InteractiveObject)& theIObj,
903                                     const Graphic3d_MaterialAspect&      theMaterial,
904                                     const Standard_Boolean               theToUpdateViewer);
905
906   //! Removes the type of material setting for viewing the Object.
907   Standard_EXPORT void UnsetMaterial (const Handle(AIS_InteractiveObject)& theIObj,
908                                       const Standard_Boolean               theToUpdateViewer);
909   
910   //! Provides the transparency settings for viewing the Object.
911   //! The transparency value aValue may be between 0.0, opaque, and 1.0, fully transparent.
912   Standard_EXPORT void SetTransparency (const Handle(AIS_InteractiveObject)& theIObj,
913                                         const Standard_Real                  theValue,
914                                         const Standard_Boolean               theToUpdateViewer);
915
916   //! Removes the transparency settings for viewing the Object.
917   Standard_EXPORT void UnsetTransparency (const Handle(AIS_InteractiveObject)& theIObj,
918                                           const Standard_Boolean               theToUpdateViewer);
919
920   //! Sets up polygon offsets for the given AIS_InteractiveObject.
921   //! It simply calls AIS_InteractiveObject::SetPolygonOffsets().
922   Standard_EXPORT void SetPolygonOffsets (const Handle(AIS_InteractiveObject)& theIObj,
923                                           const Standard_Integer               theMode,
924                                           const Standard_ShortReal             theFactor,
925                                           const Standard_ShortReal             theUnits,
926                                           const Standard_Boolean               theToUpdateViewer);
927   
928   //! Simply calls AIS_InteractiveObject::HasPolygonOffsets().
929   Standard_EXPORT Standard_Boolean HasPolygonOffsets (const Handle(AIS_InteractiveObject)& anObj) const;
930
931   //! Retrieves current polygon offsets settings for Object.
932   Standard_EXPORT void PolygonOffsets (const Handle(AIS_InteractiveObject)& anObj, Standard_Integer& aMode, Standard_ShortReal& aFactor, Standard_ShortReal& aUnits) const;
933
934 public: //! @name trihedron display attributes
935
936   //! Sets the size aSize of the trihedron.
937   //! Is used to change the default value 100 mm for display of trihedra.
938   //! Use of this function in one of your own interactive objects requires a call to the Compute function of the new class.
939   //! This will recalculate the presentation for every trihedron displayed.
940   Standard_EXPORT void SetTrihedronSize (const Standard_Real    theSize,
941                                          const Standard_Boolean theToUpdateViewer);
942
943   //! returns the current value of trihedron size.
944   Standard_EXPORT Standard_Real TrihedronSize() const;
945
946 public: //! @name plane display attributes
947
948   //! Sets the plane size defined by the length in the X direction XSize and that in the Y direction YSize.
949   Standard_EXPORT void SetPlaneSize (const Standard_Real    theSizeX,
950                                      const Standard_Real    theSizeY,
951                                      const Standard_Boolean theToUpdateViewer);
952
953   //! Sets the plane size aSize.
954   Standard_EXPORT void SetPlaneSize (const Standard_Real    theSize,
955                                      const Standard_Boolean theToUpdateViewer);
956
957   //! Returns true if the length in the X direction XSize is the same as that in the Y direction YSize.
958   Standard_EXPORT Standard_Boolean PlaneSize (Standard_Real& XSize, Standard_Real& YSize) const;
959
960 public: //! @name tessellation deviation properties for automatic triangulation
961
962   //! Sets the deviation coefficient theCoefficient.
963   //! Drawings of curves or patches are made with respect to a maximal chordal deviation.
964   //! A Deviation coefficient is used in the shading display mode.
965   //! The shape is seen decomposed into triangles.
966   //! These are used to calculate reflection of light from the surface of the object.
967   //! The triangles are formed from chords of the curves in the shape.
968   //! The deviation coefficient theCoefficient gives the highest value of the angle with which a chord can deviate from a tangent to a curve.
969   //! If this limit is reached, a new triangle is begun.
970   //! This deviation is absolute and is set through the method: SetMaximalChordialDeviation.
971   //! The default value is 0.001.
972   //! In drawing shapes, however, you are allowed to ask for a relative deviation.
973   //! This deviation will be: SizeOfObject * DeviationCoefficient.
974   Standard_EXPORT void SetDeviationCoefficient (const Handle(AIS_InteractiveObject)& theIObj,
975                                                 const Standard_Real                  theCoefficient,
976                                                 const Standard_Boolean               theToUpdateViewer);
977
978   Standard_EXPORT void SetDeviationAngle (const Handle(AIS_InteractiveObject)& theIObj,
979                                           const Standard_Real                  theAngle,
980                                           const Standard_Boolean               theToUpdateViewer);
981   
982   //! Calls the AIS_Shape SetAngleAndDeviation to set both Angle and Deviation coefficients
983   Standard_EXPORT void SetAngleAndDeviation (const Handle(AIS_InteractiveObject)& theIObj,
984                                              const Standard_Real                  theAngle,
985                                              const Standard_Boolean               theToUpdateViewer);
986
987   //! Sets the deviation coefficient theCoefficient.
988   //! Drawings of curves or patches are made with respect to a maximal chordal deviation.
989   //! A Deviation coefficient is used in the shading display mode.
990   //! The shape is seen decomposed into triangles.
991   //! These are used to calculate reflection of light from the surface of the object.
992   //! The triangles are formed from chords of the curves in the shape.
993   //! The deviation coefficient theCoefficient gives the highest value of the angle with which a chord can deviate from a tangent to a curve.
994   //! If this limit is reached, a new triangle is begun.
995   //! This deviation is absolute and is set through the method: SetMaximalChordialDeviation.
996   //! The default value is 0.001.
997   //! In drawing shapes, however, you are allowed to ask for a relative deviation.
998   //! This deviation will be: SizeOfObject * DeviationCoefficient.
999   Standard_EXPORT void SetDeviationCoefficient (const Standard_Real theCoefficient);
1000   
1001   //! Returns the deviation coefficient.
1002   //! Drawings of curves or patches are made with respect to a maximal chordal deviation.
1003   //! A Deviation coefficient is used in the shading display mode.
1004   //! The shape is seen decomposed into triangles.
1005   //! These are used to calculate reflection of light from the surface of the object.
1006   //! The triangles are formed from chords of the curves in the shape.
1007   //! The deviation coefficient gives the highest value of the angle with which a chord can deviate from a tangent to a curve.
1008   //! If this limit is reached, a new triangle is begun.
1009   //! This deviation is absolute and is set through Prs3d_Drawer::SetMaximalChordialDeviation.
1010   //! The default value is 0.001.
1011   //! In drawing shapes, however, you are allowed to ask for a relative deviation.
1012   //! This deviation will be: SizeOfObject * DeviationCoefficient.
1013   Standard_EXPORT Standard_Real DeviationCoefficient() const;
1014
1015   //! default 20 degrees
1016   Standard_EXPORT void SetDeviationAngle (const Standard_Real anAngle);
1017
1018   Standard_EXPORT Standard_Real DeviationAngle() const;
1019
1020 public: //! @name HLR (Hidden Line Removal) display attributes
1021
1022   //! Initializes hidden line aspect in the default drawing tool, or Drawer.
1023   //! The default values are:
1024   //! Color: Quantity_NOC_YELLOW
1025   //! Type of line: Aspect_TOL_DASH
1026   //! Width: 1.
1027   Standard_EXPORT Handle(Prs3d_LineAspect) HiddenLineAspect() const;
1028
1029   //! Sets the hidden line aspect anAspect.
1030   //! Aspect defines display attributes for hidden lines in HLR projections.
1031   Standard_EXPORT void SetHiddenLineAspect (const Handle(Prs3d_LineAspect)& anAspect) const;
1032
1033   //! returns Standard_True if the hidden lines are to be drawn.
1034   //! By default the hidden lines are not drawn.
1035   Standard_EXPORT Standard_Boolean DrawHiddenLine() const;
1036
1037   Standard_EXPORT void EnableDrawHiddenLine() const;
1038
1039   Standard_EXPORT void DisableDrawHiddenLine() const;
1040
1041 public: //! @name iso-line display attributes
1042
1043   //! Sets the number of U and V isoparameters displayed.
1044   Standard_EXPORT void SetIsoNumber (const Standard_Integer NbIsos, const AIS_TypeOfIso WhichIsos = AIS_TOI_Both);
1045   
1046   //! Returns the number of U and V isoparameters displayed.
1047   Standard_EXPORT Standard_Integer IsoNumber (const AIS_TypeOfIso WhichIsos = AIS_TOI_Both);
1048   
1049   //! Returns True if drawing isoparameters on planes is enabled.
1050   Standard_EXPORT void IsoOnPlane (const Standard_Boolean SwitchOn);
1051   
1052   //! Returns True if drawing isoparameters on planes is enabled.
1053   //! if <forUIsos> = False,
1054   Standard_EXPORT Standard_Boolean IsoOnPlane() const;
1055
1056   //! Enables or disables on-triangulation build for isolines for a particular object.
1057   //! In case if on-triangulation builder is disabled, default on-plane builder will compute isolines for the object given.
1058   Standard_EXPORT void IsoOnTriangulation (const Standard_Boolean theIsEnabled,
1059                                            const Handle(AIS_InteractiveObject)& theObject);
1060
1061   //! Enables or disables on-triangulation build for isolines for default drawer.
1062   //! In case if on-triangulation builder is disabled, default on-plane builder will compute isolines for the object given.
1063   Standard_EXPORT void IsoOnTriangulation (const Standard_Boolean theToSwitchOn);
1064
1065   //! Returns true if drawing isolines on triangulation algorithm is enabled.
1066   Standard_EXPORT Standard_Boolean IsoOnTriangulation() const;
1067
1068 //! @name obsolete methods
1069 public:
1070
1071   Standard_DEPRECATED("Deprecated method Display() with obsolete argument theToAllowDecomposition")
1072   void Display (const Handle(AIS_InteractiveObject)& theIObj,
1073                 const Standard_Integer               theDispMode,
1074                 const Standard_Integer               theSelectionMode,
1075                 const Standard_Boolean               theToUpdateViewer,
1076                 const Standard_Boolean               theToAllowDecomposition,
1077                 const PrsMgr_DisplayStatus           theDispStatus = PrsMgr_DisplayStatus_None)
1078   {
1079     (void )theToAllowDecomposition;
1080     Display (theIObj, theDispMode, theSelectionMode, theToUpdateViewer, theDispStatus);
1081   }
1082
1083   Standard_DEPRECATED("Deprecated method Load() with obsolete last argument theToAllowDecomposition")
1084   void Load (const Handle(AIS_InteractiveObject)& theObj, Standard_Integer theSelectionMode, Standard_Boolean ) { Load (theObj, theSelectionMode); }
1085
1086   //! Updates the display in the viewer to take dynamic detection into account.
1087   //! On dynamic detection by the mouse cursor, sensitive primitives are highlighted.
1088   //! The highlight color of entities detected by mouse movement is white by default.
1089   Standard_DEPRECATED("Deprecated method Hilight()")
1090   void Hilight (const Handle(AIS_InteractiveObject)& theObj,
1091                 const Standard_Boolean               theIsToUpdateViewer)
1092   {
1093     return HilightWithColor (theObj, myStyles[Prs3d_TypeOfHighlight_Dynamic], theIsToUpdateViewer);
1094   }
1095
1096   //! Sets the graphic basic aspect to the current presentation of ALL selected objects.
1097   Standard_DEPRECATED ("Deprecated method - presentation attributes should be assigned directly to object")
1098   Standard_EXPORT void SetSelectedAspect (const Handle(Prs3d_BasicAspect)& theAspect,
1099                                           const Standard_Boolean           theToUpdateViewer);
1100
1101   //! Selects everything found in the bounding rectangle defined by the pixel minima and maxima, XPMin, YPMin, XPMax, and YPMax in the view.
1102   //! The objects detected are passed to the main viewer, which is then updated.
1103   Standard_DEPRECATED("This method is deprecated - SelectRectangle() taking AIS_SelectionScheme_Replace should be called instead")
1104   Standard_EXPORT AIS_StatusOfPick Select (const Standard_Integer  theXPMin,
1105                                            const Standard_Integer  theYPMin,
1106                                            const Standard_Integer  theXPMax,
1107                                            const Standard_Integer  theYPMax,
1108                                            const Handle(V3d_View)& theView,
1109                                            const Standard_Boolean  theToUpdateViewer);
1110
1111   //! polyline selection; clears the previous picked list
1112   Standard_DEPRECATED("This method is deprecated - SelectPolygon() taking AIS_SelectionScheme_Replace should be called instead")
1113   Standard_EXPORT AIS_StatusOfPick Select (const TColgp_Array1OfPnt2d& thePolyline,
1114                                            const Handle(V3d_View)&     theView,
1115                                            const Standard_Boolean      theToUpdateViewer);
1116
1117   //! Stores and hilights the previous detected; Unhilights the previous picked.
1118   //! @sa MoveTo().
1119   Standard_DEPRECATED("This method is deprecated - SelectDetected() taking AIS_SelectionScheme_Replace should be called instead")
1120   Standard_EXPORT AIS_StatusOfPick Select (const Standard_Boolean theToUpdateViewer);
1121
1122   //! Adds the last detected to the list of previous picked.
1123   //! If the last detected was already declared as picked, removes it from the Picked List.
1124   //! @sa MoveTo().
1125   Standard_DEPRECATED("This method is deprecated - SelectDetected() taking AIS_SelectionScheme_XOR should be called instead")
1126   Standard_EXPORT AIS_StatusOfPick ShiftSelect (const Standard_Boolean theToUpdateViewer);
1127
1128   //! Adds the last detected to the list of previous picked.
1129   //! If the last detected was already declared as picked, removes it from the Picked List.
1130   Standard_DEPRECATED("This method is deprecated - SelectPolygon() taking AIS_SelectionScheme_XOR should be called instead")
1131   Standard_EXPORT AIS_StatusOfPick ShiftSelect (const TColgp_Array1OfPnt2d& thePolyline,
1132                                                 const Handle(V3d_View)&     theView,
1133                                                 const Standard_Boolean      theToUpdateViewer);
1134
1135   //! Rectangle of selection; adds new detected entities into the picked list,
1136   //! removes the detected entities that were already stored.
1137   Standard_DEPRECATED("This method is deprecated - SelectRectangle() taking AIS_SelectionScheme_XOR should be called instead")
1138   Standard_EXPORT AIS_StatusOfPick ShiftSelect (const Standard_Integer  theXPMin,
1139                                                 const Standard_Integer  theYPMin,
1140                                                 const Standard_Integer  theXPMax,
1141                                                 const Standard_Integer  theYPMax,
1142                                                 const Handle(V3d_View)& theView,
1143                                                 const Standard_Boolean  theToUpdateViewer);
1144
1145 public:
1146
1147   //! Updates the view of the current object in open context.
1148   //! Objects selected when there is no open local context are called current objects; those selected in open local context, selected objects.
1149   Standard_DEPRECATED ("Local Context is deprecated - local selection should be used without Local Context")
1150   void SetCurrentObject (const Handle(AIS_InteractiveObject)& theIObj,
1151                          const Standard_Boolean               theToUpdateViewer) { SetSelected (theIObj, theToUpdateViewer); }
1152
1153   //! Allows to add or remove the object given to the list of current and highlight/unhighlight it correspondingly.
1154   //! Is valid for global context only; for local context use method AddOrRemoveSelected.
1155   //! Since this method makes sense only for neutral point selection of a whole object,
1156   //! if 0 selection of the object is empty this method simply does nothing.
1157   Standard_DEPRECATED ("Local Context is deprecated - local selection should be used without Local Context")
1158   void AddOrRemoveCurrentObject (const Handle(AIS_InteractiveObject)& theObj,
1159                                  const Standard_Boolean               theIsToUpdateViewer) { AddOrRemoveSelected (theObj, theIsToUpdateViewer); }
1160
1161   //! Updates the list of current objects, i.e. hilights new current objects, removes hilighting from former current objects.
1162   //! Objects selected when there is no open local context are called current objects; those selected in open local context, selected objects.
1163   Standard_DEPRECATED ("Local Context is deprecated - local selection should be used without Local Context")
1164   void UpdateCurrent() { UpdateSelected (Standard_True); }
1165
1166   //! Returns true if there is a non-null interactive object in Neutral Point.
1167   //! Objects selected when there is no open local context are called current objects;
1168   //! those selected in open local context, selected objects.
1169   Standard_DEPRECATED ("Local Context is deprecated - local selection should be used without Local Context")
1170   Standard_Boolean IsCurrent (const Handle(AIS_InteractiveObject)& theObject) const { return IsSelected (theObject); }
1171
1172   //! Initializes a scan of the current selected objects in Neutral Point.
1173   //! Objects selected when there is no open local context are called current objects; those selected in open local context, selected objects.
1174   Standard_DEPRECATED ("Local Context is deprecated - local selection should be used without Local Context")
1175   void InitCurrent() { InitSelected(); }
1176
1177   //! Returns true if there is another object found by the scan of the list of current objects.
1178   //! Objects selected when there is no open local context are called current objects; those selected in open local context, selected objects.
1179   Standard_DEPRECATED ("Local Context is deprecated - local selection should be used without Local Context")
1180   Standard_Boolean MoreCurrent() const { return MoreSelected(); }
1181   
1182   //! Continues the scan to the next object in the list of current objects.
1183   //! Objects selected when there is no open local context are called current objects; those selected in open local context, selected objects.
1184   Standard_DEPRECATED ("Local Context is deprecated - local selection should be used without Local Context")
1185   void NextCurrent() { NextSelected(); }
1186
1187   //! Returns the current interactive object.
1188   //! Objects selected when there is no open local context are called current objects; those selected in open local context, selected objects.
1189   Standard_DEPRECATED ("Local Context is deprecated - local selection should be used without Local Context")
1190   Handle(AIS_InteractiveObject) Current() const { return SelectedInteractive(); }
1191
1192   Standard_DEPRECATED ("Local Context is deprecated - local selection should be used without Local Context")
1193   Standard_Integer NbCurrents() { return NbSelected(); }
1194
1195   //! Highlights current objects.
1196   //! Objects selected when there is no open local context are called current objects; those selected in open local context, selected objects.
1197   Standard_DEPRECATED ("Local Context is deprecated - local selection should be used without Local Context")
1198   void HilightCurrents (const Standard_Boolean theToUpdateViewer) { HilightSelected (theToUpdateViewer); }
1199
1200   //! Removes highlighting from current objects.
1201   //! Objects selected when there is no open local context are called current objects; those selected in open local context, selected objects.
1202   Standard_DEPRECATED ("Local Context is deprecated - local selection should be used without Local Context")
1203   void UnhilightCurrents (const Standard_Boolean theToUpdateViewer) { UnhilightSelected (theToUpdateViewer); }
1204
1205   //! Empties previous current objects in order to get the current objects detected by the selector using UpdateCurrent.
1206   //! Objects selected when there is no open local context are called current objects; those selected in open local context, selected objects.
1207   Standard_DEPRECATED ("Local Context is deprecated - local selection should be used without Local Context")
1208   void ClearCurrents (const Standard_Boolean theToUpdateViewer) { ClearSelected (theToUpdateViewer); }
1209
1210   //! @return current mouse-detected shape or empty (null) shape, if current interactive object
1211   //! is not a shape (AIS_Shape) or there is no current mouse-detected interactive object at all.
1212   //! @sa DetectedCurrentOwner(), InitDetected(), MoreDetected(), NextDetected().
1213   Standard_DEPRECATED ("Local Context is deprecated - ::DetectedCurrentOwner() should be called instead")
1214   Standard_EXPORT const TopoDS_Shape& DetectedCurrentShape() const;
1215   
1216   //! @return current mouse-detected interactive object or null object, if there is no currently detected interactives
1217   //! @sa DetectedCurrentOwner(), InitDetected(), MoreDetected(), NextDetected().
1218   Standard_DEPRECATED ("Local Context is deprecated - ::DetectedCurrentOwner() should be called instead")
1219   Standard_EXPORT Handle(AIS_InteractiveObject) DetectedCurrentObject() const;
1220
1221 public: //! @name sub-intensity management (deprecated)
1222
1223   //! Sub-intensity allows temporary highlighting of particular objects with specified color in a manner of selection highlight,
1224   //! but without actual selection (e.g., global status and owner's selection state will not be updated).
1225   //! The method returns the color of such highlighting.
1226   //! By default, it is Quantity_NOC_GRAY40.
1227   const Quantity_Color& SubIntensityColor() const
1228   {
1229     return myStyles[Prs3d_TypeOfHighlight_SubIntensity]->Color();
1230   }
1231
1232   //! Sub-intensity allows temporary highlighting of particular objects with specified color in a manner of selection highlight,
1233   //! but without actual selection (e.g., global status and owner's selection state will not be updated).
1234   //! The method sets up the color for such highlighting.
1235   //! By default, this is Quantity_NOC_GRAY40.
1236   void SetSubIntensityColor (const Quantity_Color& theColor)
1237   {
1238     myStyles[Prs3d_TypeOfHighlight_SubIntensity]->SetColor (theColor);
1239   }
1240
1241   //! Highlights, and removes highlights from, the displayed object which is displayed at Neutral Point with subintensity color.
1242   //! Available only for active local context.
1243   //! There is no effect if there is no local context.
1244   //! If a local context is open, the presentation of the Interactive Object activates the selection mode.
1245   Standard_EXPORT void SubIntensityOn (const Handle(AIS_InteractiveObject)& theIObj,
1246                                        const Standard_Boolean               theToUpdateViewer);
1247
1248   //! Removes the subintensity option for the entity.
1249   //! If a local context is open, the presentation of the Interactive Object activates the selection mode.
1250   Standard_EXPORT void SubIntensityOff (const Handle(AIS_InteractiveObject)& theIObj,
1251                                         const Standard_Boolean               theToUpdateViewer);
1252
1253   //! Returns selection instance
1254   const Handle(AIS_Selection)& Selection() const { return mySelection; }
1255
1256   //! Sets selection instance to manipulate a container of selected owners
1257   //! @param theSelection an instance of the selection
1258   void SetSelection (const Handle(AIS_Selection)& theSelection) { mySelection = theSelection; }
1259
1260   //! Dumps the content of me into the stream
1261   Standard_EXPORT virtual void DumpJson (Standard_OStream& theOStream, Standard_Integer theDepth = -1) const;
1262
1263 protected: //! @name internal methods
1264
1265   Standard_EXPORT void GetDefModes (const Handle(AIS_InteractiveObject)& anIobj, Standard_Integer& Dmode, Standard_Integer& HiMod, Standard_Integer& SelMode) const;
1266   
1267   Standard_EXPORT void EraseGlobal (const Handle(AIS_InteractiveObject)& theIObj,
1268                                     const Standard_Boolean               theToUpdateViewer);
1269   
1270   Standard_EXPORT void ClearGlobal (const Handle(AIS_InteractiveObject)& theIObj,
1271                                     const Standard_Boolean               theToUpdateViewer);
1272   
1273   Standard_EXPORT void ClearGlobalPrs (const Handle(AIS_InteractiveObject)& theObj,
1274                                        const Standard_Integer               theMode,
1275                                        const Standard_Boolean               theToUpdateViewer);
1276   
1277   Standard_EXPORT void InitAttributes();
1278
1279   //! Highlights detected objects.
1280   //! If theToRedrawOnUpdate is set to false, callee should call RedrawImmediate() to update view.
1281   Standard_EXPORT AIS_StatusOfDetection moveTo (const Handle(V3d_View)& theView,
1282                                                 const Standard_Boolean  theToRedrawOnUpdate);
1283
1284   //! Helper function to unhighlight all entity owners currently highlighted with seleciton color.
1285   Standard_EXPORT void unselectOwners (const Handle(AIS_InteractiveObject)& theObject);
1286
1287   //! Helper function that highlights the owner given with <theStyle> without
1288   //! performing AutoHighlight checks, e.g. is used for dynamic highlight.
1289   Standard_EXPORT void highlightWithColor (const Handle(SelectMgr_EntityOwner)& theOwner,
1290                                            const Handle(V3d_Viewer)& theViewer = NULL);
1291
1292   //! Helper function that highlights the owner given with <theStyle> with check
1293   //! for AutoHighlight, e.g. is used for selection.
1294   Standard_EXPORT void highlightSelected (const Handle(SelectMgr_EntityOwner)& theOwner);
1295
1296   //! Helper function that highlights the owners with check for AutoHighlight, e.g. is used for selection.
1297   //! @param theOwners [in] list of owners to highlight
1298   //! @param theStyle  [in] highlight style to apply or NULL to apply selection style
1299   Standard_EXPORT void highlightOwners (const AIS_NListOfEntityOwner& theOwners,
1300                                         const Handle(Prs3d_Drawer)& theStyle);
1301
1302   //! Helper function that highlights global owner of the object given with <theStyle> with check
1303   //! for AutoHighlight, e.g. is used for selection.
1304   //! If global owner is null, it simply highlights the whole object
1305   Standard_EXPORT void highlightGlobal (const Handle(AIS_InteractiveObject)& theObj,
1306                                         const Handle(Prs3d_Drawer)& theStyle,
1307                                         const Standard_Integer theDispMode);
1308
1309   //! Helper function that unhighlights all owners that are stored in current AIS_Selection.
1310   //! The function updates global status and selection state of owner and interactive object.
1311   //! If the parameter <theIsToHilightSubIntensity> is set to true, interactive objects with sub-intensity
1312   //! switched on in AIS_GlobalStatus will be highlighted with context's sub-intensity color.
1313   Standard_EXPORT void unhighlightSelected (const Standard_Boolean theIsToHilightSubIntensity = Standard_False);
1314
1315   //! Helper function that unhighlights the owners with check
1316   //! for AutoHighlight, e.g. is used for selection.
1317   Standard_EXPORT void unhighlightOwners (const AIS_NListOfEntityOwner& theOwners,
1318                                           const Standard_Boolean theIsToHilightSubIntensity = Standard_False);
1319
1320   //! Helper function that unhighlights global selection owner of given interactive.
1321   //! The function does not perform any updates of global or owner status
1322   Standard_EXPORT void unhighlightGlobal (const Handle(AIS_InteractiveObject)& theObj);
1323
1324   //! Helper function that turns on sub-intensity in global status and highlights
1325   //! given objects with sub-intensity color
1326   //! @param theObject [in] the object. If NULL is given, than sub-intensity will be turned on for
1327   //! all inveractive objects of the context
1328   //! @param theDispMode [in] display mode. If -1 is given, sub-intensity will be turned on for
1329   //! all display modes in global status's list of modes
1330   //! @param theIsDisplayedOnly [in] is true if sub-intensity should be applied only to objects with
1331   //! status AIS_DS_Displayed
1332   Standard_EXPORT void turnOnSubintensity (const Handle(AIS_InteractiveObject)& theObject = NULL,
1333                                            const Standard_Integer theDispMode = -1,
1334                                            const Standard_Boolean theIsDisplayedOnly = Standard_True) const;
1335
1336   //! Helper function that highlights the object with sub-intensity color without any checks
1337   //! @param theObject [in] the object that will be highlighted
1338   //! @param theMode [in] display mode
1339   Standard_EXPORT void highlightWithSubintensity (const Handle(AIS_InteractiveObject)& theObject,
1340                                                   const Standard_Integer theMode) const;
1341
1342   //! Helper function that highlights the owner with sub-intensity color without any checks
1343   //! @param theOwner [in] the owner that will be highlighted
1344   //! @param theMode [in] display mode
1345   Standard_EXPORT void highlightWithSubintensity (const Handle(SelectMgr_EntityOwner)& theOwner,
1346                                                   const Standard_Integer theMode) const;
1347
1348   //! Helper function that returns correct dynamic highlight style for the object:
1349   //! if custom style is defined via object's highlight drawer, it will be used. Otherwise,
1350   //! dynamic highlight style of interactive context will be returned.
1351   //! @param theObj [in] the object to check
1352   const Handle(Prs3d_Drawer)& getHiStyle (const Handle(AIS_InteractiveObject)& theObj,
1353                                           const Handle(SelectMgr_EntityOwner)& theOwner) const
1354   {
1355     const Handle(Prs3d_Drawer)& aHiDrawer = theObj->DynamicHilightAttributes();
1356     if (!aHiDrawer.IsNull())
1357     {
1358       return aHiDrawer;
1359     }
1360
1361     return myStyles[!theOwner.IsNull() && theOwner->ComesFromDecomposition() ? Prs3d_TypeOfHighlight_LocalDynamic : Prs3d_TypeOfHighlight_Dynamic];
1362   }
1363
1364   //! Return TRUE if highlight style of owner requires full viewer redraw.
1365   Standard_EXPORT Standard_Boolean isSlowHiStyle (const Handle(SelectMgr_EntityOwner)& theOwner,
1366                                                   const Handle(V3d_Viewer)& theViewer) const;
1367
1368   //! Helper function that returns correct selection style for the object:
1369   //! if custom style is defined via object's highlight drawer, it will be used. Otherwise,
1370   //! selection style of interactive context will be returned.
1371   //! @param theObj [in] the object to check
1372   const Handle(Prs3d_Drawer)& getSelStyle (const Handle(AIS_InteractiveObject)& theObj,
1373                                            const Handle(SelectMgr_EntityOwner)& theOwner) const
1374   {
1375     const Handle(Prs3d_Drawer)& aHiDrawer = theObj->HilightAttributes();
1376     if (!aHiDrawer.IsNull())
1377     {
1378       return aHiDrawer;
1379     }
1380
1381     return myStyles[!theOwner.IsNull() && theOwner->ComesFromDecomposition() ? Prs3d_TypeOfHighlight_LocalSelected : Prs3d_TypeOfHighlight_Selected];
1382   }
1383
1384   //! Assign the context to the object or throw exception if object was already assigned to another context.
1385   void setContextToObject (const Handle(AIS_InteractiveObject)& theObj)
1386   {
1387     if (theObj->HasInteractiveContext())
1388     {
1389       if (theObj->myCTXPtr != this)
1390       {
1391         throw Standard_ProgramError("AIS_InteractiveContext - object has been already displayed in another context!");
1392       }
1393     }
1394     else
1395     {
1396       theObj->SetContext (this);
1397     }
1398   }
1399
1400   //! Return display mode for highlighting.
1401   Standard_Integer getHilightMode (const Handle(AIS_InteractiveObject)& theObj,
1402                                    const Handle(Prs3d_Drawer)& theStyle,
1403                                    const Standard_Integer theDispMode) const
1404   {
1405     if (!theStyle.IsNull()
1406      &&  theStyle->DisplayMode() != -1
1407      &&  theObj->AcceptDisplayMode (theStyle->DisplayMode()))
1408     {
1409       return theStyle->DisplayMode();
1410     }
1411     else if (theDispMode != -1)
1412     {
1413       return theDispMode;
1414     }
1415     else if (theObj->HasDisplayMode())
1416     {
1417       return theObj->DisplayMode();
1418     }
1419     return myDefaultDrawer->DisplayMode();
1420   }
1421
1422   //! Removes dynamic highlight draw
1423   void clearDynamicHighlight() const
1424   {
1425     if (myLastPicked.IsNull())
1426       return;
1427
1428     myLastPicked->Selectable()->ClearDynamicHighlight (myMainPM);
1429   }
1430
1431   //! Bind/Unbind status to object and its children
1432   //! @param theObj [in] the object to change status
1433   //! @param theStatus status, if NULL, unbind object
1434   Standard_EXPORT void setObjectStatus (const Handle(AIS_InteractiveObject)& theIObj,
1435                                         const PrsMgr_DisplayStatus theStatus,
1436                                         const Standard_Integer theDispyMode,
1437                                         const Standard_Integer theSelectionMode);
1438
1439 protected: //! @name internal fields
1440
1441   AIS_DataMapOfIOStatus myObjects;
1442   Handle(SelectMgr_SelectionManager) mgrSelector;
1443   Handle(PrsMgr_PresentationManager) myMainPM;
1444   Handle(V3d_Viewer) myMainVwr;
1445   Handle(StdSelect_ViewerSelector3d) myMainSel;
1446   V3d_View* myLastActiveView;
1447   Handle(SelectMgr_EntityOwner) myLastPicked;
1448   Standard_Boolean myToHilightSelected;
1449   Handle(AIS_Selection) mySelection;
1450   Handle(SelectMgr_AndOrFilter) myFilters; //!< context filter (the content active filters
1451                                            //!  can be applied with AND or OR operation)
1452   Handle(Prs3d_Drawer) myDefaultDrawer;
1453   Handle(Prs3d_Drawer) myStyles[Prs3d_TypeOfHighlight_NB];
1454   TColStd_SequenceOfInteger myDetectedSeq;
1455   Standard_Integer myCurDetected;
1456   Standard_Integer myCurHighlighted;
1457   SelectMgr_PickingStrategy myPickingStrategy; //!< picking strategy to be applied within MoveTo()
1458   Standard_Boolean myAutoHilight;
1459   Standard_Boolean myIsAutoActivateSelMode;
1460
1461 };
1462
1463 DEFINE_STANDARD_HANDLE(AIS_InteractiveContext, Standard_Transient)
1464
1465 #endif // _AIS_InteractiveContext_HeaderFile