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