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