7840794ddd31d3eaaf97d0db1c9c68f13f1a33ed
[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 <Standard.hxx>
21 #include <Standard_Type.hxx>
22
23 #include <AIS_DataMapOfIOStatus.hxx>
24 #include <PrsMgr_PresentationManager3d.hxx>
25 #include <StdSelect_ViewerSelector3d.hxx>
26 #include <TCollection_AsciiString.hxx>
27 #include <Standard_Boolean.hxx>
28 #include <Prs3d_Drawer.hxx>
29 #include <Quantity_NameOfColor.hxx>
30 #include <Standard_Integer.hxx>
31 #include <AIS_DataMapOfILC.hxx>
32 #include <AIS_SequenceOfInteractive.hxx>
33 #include <MMgt_TShared.hxx>
34 #include <AIS_DisplayStatus.hxx>
35 #include <AIS_KindOfInteractive.hxx>
36 #include <Standard_Real.hxx>
37 #include <Aspect_TypeOfFacingModel.hxx>
38 #include <Graphic3d_NameOfMaterial.hxx>
39 #include <Standard_ShortReal.hxx>
40 #include <TColStd_ListOfInteger.hxx>
41 #include <AIS_DisplayMode.hxx>
42 #include <AIS_TypeOfIso.hxx>
43 #include <AIS_StatusOfDetection.hxx>
44 #include <AIS_StatusOfPick.hxx>
45 #include <TColgp_Array1OfPnt2d.hxx>
46 #include <SelectMgr_IndexedMapOfOwner.hxx>
47 #include <AIS_ClearMode.hxx>
48 #include <TopAbs_ShapeEnum.hxx>
49 #include <SelectMgr_ListOfFilter.hxx>
50 #include <AIS_ListOfInteractive.hxx>
51 #include <Standard_CString.hxx>
52 #include <AIS_Selection.hxx>
53 class SelectMgr_SelectionManager;
54 class V3d_Viewer;
55 class AIS_InteractiveObject;
56 class SelectMgr_OrFilter;
57 class V3d_View;
58 class AIS_LocalContext;
59 class TopLoc_Location;
60 class Quantity_Color;
61 class TCollection_ExtendedString;
62 class Prs3d_LineAspect;
63 class Prs3d_BasicAspect;
64 class SelectMgr_EntityOwner;
65 class Standard_Transient;
66 class SelectMgr_Filter;
67 class TCollection_AsciiString;
68
69
70 class AIS_InteractiveContext;
71 DEFINE_STANDARD_HANDLE(AIS_InteractiveContext, MMgt_TShared)
72
73 //! The Interactive Context allows you to manage
74 //! graphic behavior and selection of Interactive Objects
75 //! in one or more viewers. Class methods make this
76 //! highly transparent.
77 //! It is essential to remember that an Interactive Object
78 //! which is already known by the Interactive Context
79 //! must be modified using Context methods. You can
80 //! only directly call the methods available for an
81 //! Interactive Object if it has not been loaded into an
82 //! Interactive Context.
83 //! You must distinguish two states in the Interactive Context:
84 //! -   No Open Local Context, also known as the Neutral Point.
85 //! -   One or several open local contexts, each
86 //! representing a temporary state of selection and presentation.
87 //! Some methods can only be used in open Local
88 //! Context; others in closed Local Context; others do
89 //! not have the same behavior in one state as in the other.
90 //! The possiblities of use for local contexts are
91 //! numerous depending on the type of operation that
92 //! you want to perform, for example:
93 //! -   working on all visualized interactive objects,
94 //! -   working on only a few objects,
95 //! -   working on a single object.
96 //! 1. When you want ot work on one type of entity, you
97 //! may open a local context with the option
98 //! UseDisplayedObjects set to false. DisplayedObjects
99 //! allows you to recover the visualized Interactive
100 //! Objects which have a given Type and
101 //! Signature   from Neutral Point.
102 //! 2. You must keep in mind the fact that when you open
103 //! a Local Context with default options:
104 //! -   The Interactive Objects visualized at Neutral Point
105 //! are activated with their default selection mode. You
106 //! must deactivate those which you do not want ot use.
107 //! -   The Shape type Interactive Objects are
108 //! automatically decomposed into sub-shapes when
109 //! standard activation modes are launched.
110 //! -   The "temporary" Interactive Objects present in the
111 //! Local Contexts are not automatically taken into
112 //! account. You have to load them manually if you
113 //! want to use them.
114 //! -   The stages could be the following:
115 //! -   Open a Local Context with the right options;
116 //! -   Load/Visualize the required complementary
117 //! objects with the desired activation modes.
118 //! -   Activate Standard modes if necessary
119 //! - Create its filters and add them to the Local Context
120 //! -   Detect/Select/recover the desired entities
121 //! -   Close the Local Context with the adequate index.
122 //! -   It is useful to create an interactive editor, to which
123 //! you pass the Interactive Context. This will take care
124 //! of setting up the different contexts of
125 //! selection/presentation according to the operation
126 //! which you want to perform.
127
128 //! Selection of parts of the objects can also be done without opening a local context.
129 //! Interactive context itself supports decomposed object selection with selection filters
130 //! support. Note that each selectable object must specify the selection mode that is
131 //! responsible for selection of object as a whole (global selection mode). By default, global
132 //! selection mode is equal to 0, but it might be redefined if needed. Sub-part selection
133 //! of the objects without using local context provides a possibility to activate part
134 //! selection modes along with global selection mode.
135 class AIS_InteractiveContext : public MMgt_TShared
136 {
137
138 public:
139
140   
141
142   //! Constructs the interactive context object defined by
143   //! the principal viewer MainViewer.
144   Standard_EXPORT AIS_InteractiveContext(const Handle(V3d_Viewer)& MainViewer);
145   
146   Standard_EXPORT virtual void Delete() const Standard_OVERRIDE;
147   
148   Standard_EXPORT void SetAutoActivateSelection (const Standard_Boolean Auto);
149   
150   Standard_EXPORT Standard_Boolean GetAutoActivateSelection() const;
151   
152   //! Controls the choice between the using the display
153   //! and selection modes of open local context which you
154   //! have defined and activating those available by default.
155   //! If a local context is open and if updateviewer equals
156   //! Standard_False, the Interactive Object anIobj is
157   //! displayed in the default active mode. This will be the
158   //! object's default display mode, if there is one.
159   //! Otherwise, it will be the context mode. The Interactive
160   //! Object's default selection mode is activated. In
161   //! general, this is 0.
162   //! This syntax has the same behavior as local context,
163   //! open or closed. If you want to view the object in open
164   //! local context without selection, use the syntax below,
165   //! setting aSelectionMode to -1.
166   Standard_EXPORT void Display (const Handle(AIS_InteractiveObject)& anIobj, const Standard_Boolean updateviewer = Standard_True);
167   
168   //! Controls the choice between the using the display
169   //! and selection modes of open local context which you
170   //! have defined and activating those available by default.
171   //! If no Local Context is opened. and the Interactive
172   //! Object theIObj has no display mode of its own, the
173   //! default display mode, 0, is used. Likewise, if theIObj
174   //! has no selection mode of its own, the default one, 0, is used.
175   //! If a local context is open and if theToUpdateViewer equals
176   //! Standard_False, the presentation of the Interactive
177   //! Object activates the selection mode; the object is
178   //! displayed but no viewer will be updated.
179   //! If theSelectionMode equals -1, theIObj will not be
180   //! activated: it will be displayed but will not be selectable.
181   //! Use this if you want to view the object in open local
182   //! context without selection. Note: This option is only
183   //! available in Local Context.
184   //! If theToAllowDecomposition equals true, theIObj can have
185   //! subshapes detected by selection mechanisms. theIObj
186   //! must be able to give a shape selection modes which
187   //! fit the AIS_Shape selection modes:
188   //! -   vertices: 1
189   //! -   edges: 2
190   //! -   wires: 3.
191   Standard_EXPORT void Display (const Handle(AIS_InteractiveObject)& theIObj, const Standard_Integer theDispMode, const Standard_Integer theSelectionMode, const Standard_Boolean theToUpdateViewer = Standard_True, const Standard_Boolean theToAllowDecomposition = Standard_True, const AIS_DisplayStatus theDispStatus = AIS_DS_None);
192   
193   //! Allows you to load the Interactive Object aniobj
194   //! with a given selection mode SelectionMode, and/or
195   //! with the desired decomposition option, whether the
196   //! object is visualized or not. If AllowDecomp =
197   //! Standard_True and, if the interactive object is of
198   //! the "Shape" type, these "standard" selection
199   //! modes will be automatically activated as a function
200   //! of the modes present in the Local Context.
201   //! The loaded objects will be selectable but
202   //! displayable in highlighting only when detected by the Selector.
203   //! This method is available only when Local Contexts are open.
204   Standard_EXPORT void Load (const Handle(AIS_InteractiveObject)& aniobj, const Standard_Integer SelectionMode = -1, const Standard_Boolean AllowDecomp = Standard_False);
205   
206   //! Hides the object. The object's presentations are simply
207   //! flagged as invisible and therefore excluded from redrawing.
208   //! To show hidden objects, use Display().
209   Standard_EXPORT void Erase (const Handle(AIS_InteractiveObject)& aniobj, const Standard_Boolean updateviewer = Standard_True);
210   
211   //! Hides all objects. The object's presentations are simply
212   //! flagged as invisible and therefore excluded from redrawing.
213   //! To show all hidden objects, use DisplayAll().
214   Standard_EXPORT void EraseAll (const Standard_Boolean updateviewer = Standard_True);
215   
216   //! Displays all hidden objects.
217   Standard_EXPORT void DisplayAll (const Standard_Boolean updateviewer = Standard_True);
218   
219
220   //! Hides selected objects. The object's presentations are simply
221   //! flagged as invisible and therefore excluded from redrawing.
222   //! To show hidden objects, use Display().
223   Standard_EXPORT void EraseSelected (const Standard_Boolean updateviewer = Standard_True);
224   
225   //! Displays selected objects if a local context is open.
226   //! Displays current objects if there is no active local context.
227   //! Objects selected when there is no open local context
228   //! are called current objects; those selected in open
229   //! local context, selected objects.
230   //! If a local context is open and if updateviewer equals
231   //! Standard_False, the presentation   of the Interactive
232   //! Object activates   the   selection   mode; the   object is
233   //! displayed but no viewer will be updated.
234   Standard_EXPORT void DisplaySelected (const Standard_Boolean updateviewer = Standard_True);
235   
236   //! Changes the status of a temporary object. It will be
237   //! kept at the neutral point, i.e. put in the list of
238   //! displayed   objects along withwith   its temporary
239   //! attributes. These include display mode and
240   //! selection   mode, for example.
241   //! Returns true if done.
242   //! inWhichLocal gives the local context in which anIObj
243   //! is displayed. By default, the index -1 refers to the last
244   //! Local Context opened.
245   Standard_EXPORT Standard_Boolean KeepTemporary (const Handle(AIS_InteractiveObject)& anIObj, const Standard_Integer InWhichLocal = -1);
246   
247   //! Empties the graphic presentation of the mode
248   //! indexed by aMode.
249   //! If a local context is open and if updateviewer equals
250   //! Standard_False, the presentation of the Interactive
251   //! Object activates the selection mode; the object is
252   //! displayed but no viewer will be updated.
253   //! Warning
254   //! Removes anIobj. anIobj is still active if it was
255   //! previously activated.
256   Standard_EXPORT void ClearPrs (const Handle(AIS_InteractiveObject)& aniobj, const Standard_Integer aMode = 0, const Standard_Boolean updateviewer = Standard_True);
257   
258   //! Removes aniobj from every viewer. aniobj is no
259   //! longer referenced in the Context.
260   //! If a local context is open and if updateviewer equals
261   //! Standard_False, the presentation   of the Interactive
262   //! Object activates the selection mode; the object is
263   //! displayed but no viewer will be updated.
264   Standard_EXPORT void Remove (const Handle(AIS_InteractiveObject)& aniobj, const Standard_Boolean updateviewer = Standard_True);
265   
266   //! Removes all the objects from all opened Local Contexts
267   //! and from the Neutral Point
268   Standard_EXPORT void RemoveAll (const Standard_Boolean updateviewer = Standard_True);
269   
270
271   //! Updates the display in the viewer to take dynamic
272   //! detection into account. On dynamic detection by the
273   //! mouse cursor, sensitive primitives are highlighted.
274   //! The highlight color of entities detected by mouse
275   //! movement is white by default.
276   //! If a local context is open and if updateviewer equals
277   //! Standard_False, the presentation of the Interactive
278   //! Object activates the selection mode; the object is
279   //! displayed but no viewer will be updated.
280   Standard_EXPORT void Hilight (const Handle(AIS_InteractiveObject)& aniobj, const Standard_Boolean updateviewer = Standard_True);
281   
282
283   //! Changes the color of all the lines of the object in view,
284   //! aniobj. It paints these lines the color passed as the
285   //! argument, aCol.
286   //! If a local context is open and if updateviewer equals
287   //! Standard_False, the presentation of the Interactive
288   //! Object activates the selection mode; the object is
289   //! displayed but no viewer will be updated.
290   Standard_EXPORT void HilightWithColor (const Handle(AIS_InteractiveObject)& aniobj, const Quantity_NameOfColor aCol, const Standard_Boolean updateviewer = Standard_True);
291   
292
293   //! Removes hilighting from the entity aniobj. Updates the viewer.
294   //! If a local context is open and if updateviewer equals
295   //! Standard_False, the presentation of the Interactive
296   //! Object activates the selection mode; the object is
297   //! displayed but no viewer will be updated.
298   Standard_EXPORT void Unhilight (const Handle(AIS_InteractiveObject)& aniobj, const Standard_Boolean updateviewer = Standard_True);
299   
300   //! Sets the display priority aPriority of the seen parts
301   //! presentation of the entity anIobj.
302   Standard_EXPORT void SetDisplayPriority (const Handle(AIS_InteractiveObject)& anIobj, const Standard_Integer aPriority);
303   
304   //! Set Z layer id for interactive object.
305   //! The Z layers can be used to display temporarily presentations of some object in front of the other objects in the scene.
306   //! The ids for Z layers are generated by V3d_Viewer.
307   Standard_EXPORT void SetZLayer (const Handle(AIS_InteractiveObject)& theIObj, const Standard_Integer theLayerId);
308   
309   //! Get Z layer id set for displayed interactive object.
310   Standard_EXPORT Standard_Integer GetZLayer (const Handle(AIS_InteractiveObject)& theIObj) const;
311   
312   //! Recomputes the seen parts presentation of the entity
313   //! aniobj. If allmodes equals true, all presentations are
314   //! present in the object even if unseen.
315   //! If a local context is open and if updateviewer equals
316   //! Standard_False, the presentation of the Interactive
317   //! Object activates the selection mode; the object is
318   //! displayed but no viewer will be updated.
319   Standard_EXPORT void Redisplay (const Handle(AIS_InteractiveObject)& aniobj, const Standard_Boolean updateviewer = Standard_True, const Standard_Boolean allmodes = Standard_False);
320   
321   //! Recomputes the Prs/Selection of displayed objects of
322   //! a given type and a given signature.
323   //! if signature = -1  doesnt take signature criterion.
324   Standard_EXPORT void Redisplay (const AIS_KindOfInteractive aTypeOfObject, const Standard_Integer Signature = -1, const Standard_Boolean updateviewer = Standard_True);
325   
326   //! Recomputes the displayed presentations, flags the others
327   //! Doesn't update presentations
328   Standard_EXPORT void RecomputePrsOnly (const Handle(AIS_InteractiveObject)& anIobj, const Standard_Boolean updateviewer = Standard_True, const Standard_Boolean allmodes = Standard_False);
329   
330   //! Recomputes the active selections, flags the others
331   //! Doesn't update presentations
332   Standard_EXPORT void RecomputeSelectionOnly (const Handle(AIS_InteractiveObject)& anIObj);
333   
334   //! Updates displayed interactive object by checking and
335   //! recomputing its flagged as "to be recomputed" presentation
336   //! and selection structures. This method does not force any
337   //! recomputation on its own. The method recomputes selections
338   //! even if they are loaded without activation in particular selector.
339   Standard_EXPORT void Update (const Handle(AIS_InteractiveObject)& theIObj, const Standard_Boolean theUpdateViewer = Standard_True);
340   
341
342   //! Sets the display mode of seen Interactive Objects.
343   //! aMode provides the display mode index of the entity aniobj.
344   //! If updateviewer equals Standard_True, the
345   //! predominant mode aMode will overule the context mode.
346   //! If a local context is open and if updateviewer equals
347   //! Standard_False, the presentation of the Interactive
348   //! Object returns to the default selection mode; the
349   //! object is displayed but no viewer will be updated.
350   //! Note that display mode 3 is only used if you have an
351   //! AIS_Textured Shape.
352   Standard_EXPORT void SetDisplayMode (const Handle(AIS_InteractiveObject)& aniobj, const Standard_Integer aMode, const Standard_Boolean updateviewer = Standard_True);
353   
354
355   //! Unsets the display mode of seen Interactive Objects.
356   //! aMode provides the display mode index of the entity aniobj.
357   //! If updateviewer equals Standard_True, the
358   //! predominant mode aMode will overule the context mode.
359   //! If a local context is open and if updateviewer equals
360   //! Standard_False, the presentation of the Interactive
361   //! Object returns to the default selection mode; the
362   //! object is displayed but no viewer will be updated.
363   Standard_EXPORT void UnsetDisplayMode (const Handle(AIS_InteractiveObject)& aniobj, const Standard_Boolean updateviewer = Standard_True);
364
365   //! Disables the mechanism of adaptive tolerance calculation in SelectMgr_ViewerSelector and
366   //! sets the given tolerance for ALL sensitive entities activated. For more information, see
367   //! SelectMgr_ViewerSelector documentation
368   //! Warning: When a local context is open the sensitivity is apply on it
369   //! instead on the main context.
370   Standard_EXPORT void SetPixelTolerance (const Standard_Integer aPrecision = 2);
371   
372   //! Returns the pixel tolerance.
373   Standard_EXPORT Standard_Integer PixelTolerance() const;
374
375   //! Allows to manage sensitivity of a particular selection of interactive object theObject
376   //! and changes previous sensitivity value of all sensitive entities in selection with theMode
377   //! to the given theNewSensitivity.
378   Standard_EXPORT void SetSelectionSensitivity (const Handle(AIS_InteractiveObject)& theObject,
379                                                 const Standard_Integer theMode,
380                                                 const Standard_Integer theNewSensitivity);
381   
382   //! Puts the location aLocation on the initial graphic
383   //! representation and the selection for the entity aniobj.
384   //! In other words, aniobj is visible and selectable at a
385   //! position other than initial position.
386   //! Graphic and selection primitives are not recomputed.
387   //! To clean the view correctly, you must reset the previous location.
388   Standard_EXPORT void SetLocation (const Handle(AIS_InteractiveObject)& aniobj, const TopLoc_Location& aLocation);
389   
390   //! Puts the entity aniobj back into its initial position.
391   Standard_EXPORT void ResetLocation (const Handle(AIS_InteractiveObject)& aniobj);
392   
393
394   //! Returns true if the entity aniobj has a location.
395   Standard_EXPORT Standard_Boolean HasLocation (const Handle(AIS_InteractiveObject)& aniobj) const;
396   
397
398   //! Returns the location of the entity aniobj.
399   Standard_EXPORT TopLoc_Location Location (const Handle(AIS_InteractiveObject)& aniobj) const;
400   
401   //! change the current facing model apply on polygons for
402   //! SetColor(), SetTransparency(), SetMaterial() methods
403   //! default facing model is Aspect_TOFM_TWO_SIDE. This mean that attributes is
404   //! applying both on the front and back face.
405   Standard_EXPORT void SetCurrentFacingModel (const Handle(AIS_InteractiveObject)& aniobj, const Aspect_TypeOfFacingModel aModel = Aspect_TOFM_BOTH_SIDE);
406   
407   Standard_EXPORT void SetColor (const Handle(AIS_InteractiveObject)& aniobj, const Quantity_NameOfColor aColor, const Standard_Boolean updateviewer = Standard_True);
408   
409
410   //! Sets the color of the selected entity.
411   //! If a local context is open and if updateviewer equals
412   //! Standard_False, the presentation   of the Interactive
413   //! Object activates the selection mode; the object is
414   //! displayed but no viewer will be updated.
415   Standard_EXPORT void SetColor (const Handle(AIS_InteractiveObject)& aniobj, const Quantity_Color& aColor, const Standard_Boolean updateviewer = Standard_True);
416   
417   //! Removes the color selection for the selected entity.
418   //! If a local context is open and if updateviewer equals
419   //! Standard_False, the presentation of the Interactive
420   //! Object activates the selection mode; the object is
421   //! displayed but no viewer will be updated.
422   Standard_EXPORT void UnsetColor (const Handle(AIS_InteractiveObject)& aniobj, const Standard_Boolean updateviewer = Standard_True);
423   
424
425   //! Sets the width of the entity aniobj.
426   //! If a local context is open and if updateviewer equals
427   //! Standard_False, the presentation of the Interactive
428   //! Object activates the selection mode; the object is
429   //! displayed but no viewer will be updated.
430   Standard_EXPORT virtual void SetWidth (const Handle(AIS_InteractiveObject)& aniobj, const Standard_Real aValue, const Standard_Boolean updateviewer = Standard_True);
431   
432
433   //! Removes the width setting of the entity aniobj.
434   //! If a local context is open and if updateviewer equals
435   //! Standard_False, the presentation of the Interactive
436   //! Object activates the selection mode; the object is
437   //! displayed but no viewer will be updated.
438   Standard_EXPORT virtual void UnsetWidth (const Handle(AIS_InteractiveObject)& aniobj, const Standard_Boolean updateviewer = Standard_True);
439   
440
441   //! Provides the type of material setting for the view of
442   //! the entity aniobj.
443   //! The range of settings includes: BRASS, BRONZE,
444   //! GOLD, PEWTER, SILVER, STONE.
445   //! If a local context is open and if updateviewer equals
446   //! Standard_False, the presentation of the Interactive
447   //! Object activates the selection mode; the object is
448   //! displayed but no viewer will be updated.
449   Standard_EXPORT void SetMaterial (const Handle(AIS_InteractiveObject)& aniobj, const Graphic3d_NameOfMaterial aName, const Standard_Boolean updateviewer = Standard_True);
450   
451
452   //! Removes the type of material setting for viewing the
453   //! entity aniobj.
454   //! If a local context is open and if updateviewer equals
455   //! Standard_False, the presentation of the Interactive
456   //! Object activates the selection mode; the object is
457   //! displayed but no viewer will be updated.
458   Standard_EXPORT void UnsetMaterial (const Handle(AIS_InteractiveObject)& anObj, const Standard_Boolean updateviewer = Standard_True);
459   
460   //! Provides the transparency settings for viewing the
461   //! entity aniobj. The transparency value aValue may be
462   //! between 0.0, opaque, and 1.0, fully transparent.
463   //! If a local context is open and if updateviewer equals
464   //! Standard_False, the presentation of the Interactive
465   //! Object activates the selection mode; the object is
466   //! displayed but no viewer will be updated.
467   Standard_EXPORT void SetTransparency (const Handle(AIS_InteractiveObject)& aniobj, const Standard_Real aValue = 0.6, const Standard_Boolean updateviewer = Standard_True);
468   
469
470   //! Removes   the transparency settings for viewing the
471   //! entity aniobj. The transparency value aValue may be
472   //! between 0.0, opaque, and 1.0, fully transparent.
473   //! If a local context is open and if updateviewer equals
474   //! Standard_False, the presentation of the Interactive
475   //! Object activates the selection mode; the object is
476   //! displayed but no viewer will be updated.
477   Standard_EXPORT void UnsetTransparency (const Handle(AIS_InteractiveObject)& aniobj, const Standard_Boolean updateviewer = Standard_True);
478   
479
480   //! Sets the attributes of the interactive object aniobj by
481   //! plugging the attribute manager aDrawer into the local
482   //! context. The graphic attributes of aDrawer such as
483   //! visualization mode, color, and material, are then used
484   //! to display aniobj.
485   //! If a local context is open and if updateviewer equals
486   //! Standard_False, the presentation of the Interactive
487   //! Object activates the selection mode; the object is
488   //! displayed but no viewer will be updated.
489   Standard_EXPORT void SetLocalAttributes (const Handle(AIS_InteractiveObject)& aniobj, const Handle(Prs3d_Drawer)& aDrawer, const Standard_Boolean updateviewer = Standard_True);
490   
491
492   //! Removes the settings for local attributes of the entity
493   //! anObj   and returns to the Neutral Point attributes or
494   //! those of the previous local context.
495   //! If a local context is open and if updateviewer equals
496   //! Standard_False, the presentation of the Interactive
497   //! Object activates the selection mode; the object is
498   //! displayed but no viewer will be updated.
499   Standard_EXPORT void UnsetLocalAttributes (const Handle(AIS_InteractiveObject)& anObj, const Standard_Boolean updateviewer = Standard_True);
500   
501   //! Sets up polygon offsets for the given AIS_InteractiveObject.
502   //! It simply calls anObj->SetPolygonOffsets()
503   Standard_EXPORT void SetPolygonOffsets (const Handle(AIS_InteractiveObject)& anObj, const Standard_Integer aMode, const Standard_ShortReal aFactor = 1.0, const Standard_ShortReal aUnits = 0.0, const Standard_Boolean updateviewer = Standard_True);
504   
505   //! simply calls anObj->HasPolygonOffsets()
506   Standard_EXPORT Standard_Boolean HasPolygonOffsets (const Handle(AIS_InteractiveObject)& anObj) const;
507   
508   //! Retrieves current polygon offsets settings for <anObj>.
509   Standard_EXPORT void PolygonOffsets (const Handle(AIS_InteractiveObject)& anObj, Standard_Integer& aMode, Standard_ShortReal& aFactor, Standard_ShortReal& aUnits) const;
510   
511   //! Sets the size aSize of the trihedron.
512   //! Is used to change the default value 100 mm for
513   //! display of trihedra.
514   //! Use of this function in one of your own interactive
515   //! objects requires a call to the Compute function of the
516   //! new class. This will recalculate the presentation for
517   //! every trihedron displayed.
518   //! If a local context is open and if updateviewer equals
519   //! Standard_False, the presentation of the Interactive
520   //! Object activates the selection mode; the object is
521   //! displayed but no viewer will be updated.
522   Standard_EXPORT void SetTrihedronSize (const Standard_Real aSize, const Standard_Boolean updateviewer = Standard_True);
523   
524   //! returns the current value of trihedron size.
525   Standard_EXPORT Standard_Real TrihedronSize() const;
526   
527
528   //! Sets the plane size defined by the length in the X
529   //! direction XSize and that in the Y direction YSize.
530   //! If a local context is open and if updateviewer equals
531   //! Standard_False, the presentation of the Interactive
532   //! Object activates the selection mode; the object is
533   //! displayed but no viewer will be updated.
534   Standard_EXPORT void SetPlaneSize (const Standard_Real aSizeX, const Standard_Real aSizeY, const Standard_Boolean updateviewer = Standard_True);
535   
536
537   //! Sets the plane size aSize.
538   //! If a local context is open and if updateviewer equals
539   //! Standard_False, the presentation of the Interactive
540   //! Object activates the selection mode; the object is
541   //! displayed but no viewer will be updated.
542   //! May be used if PlaneSize returns true.
543   Standard_EXPORT void SetPlaneSize (const Standard_Real aSize, const Standard_Boolean updateviewer = Standard_True);
544   
545   //! Returns true if the length in the X direction XSize is
546   //! the same as that in the Y direction YSize.
547   Standard_EXPORT Standard_Boolean PlaneSize (Standard_Real& XSize, Standard_Real& YSize) const;
548   
549   //! Returns the display status of the entity anIobj.
550   //! This will be one of the following:
551   //! -   DS_Displayed   displayed in main viewer
552   //! -   DS_Erased   hidden in main viewer
553   //! -   DS_Temporary   temporarily displayed
554   //! -   DS_None   nowhere displayed.
555   Standard_EXPORT AIS_DisplayStatus DisplayStatus (const Handle(AIS_InteractiveObject)& anIobj) const;
556   
557
558   //! Returns true if anIobj is displayed in the interactive context.
559   Standard_EXPORT Standard_Boolean IsDisplayed (const Handle(AIS_InteractiveObject)& anIobj) const;
560   
561   Standard_EXPORT Standard_Boolean IsDisplayed (const Handle(AIS_InteractiveObject)& aniobj, const Standard_Integer aMode) const;
562   
563   Standard_EXPORT Standard_Boolean IsHilighted (const Handle(AIS_InteractiveObject)& aniobj) const;
564   
565   //! if <anIObj> is hilighted with a specific color
566   //! <WithColor> will be returned TRUE
567   //! <theHiCol> gives the name of the hilightcolor
568   Standard_EXPORT Standard_Boolean IsHilighted (const Handle(AIS_InteractiveObject)& anIobj, Standard_Boolean& WithColor, Quantity_NameOfColor& theHiCol) const;
569
570   //! if <theOwner> is hilighted with a specific color, than <theIsCustomColor> will be set
571   //! to true and <theCustomColorName> will have the name of the color stored
572   Standard_EXPORT Standard_Boolean IsHilighted (const Handle(SelectMgr_EntityOwner)& theOwner,
573                                                 Standard_Boolean& theIsCustomColor,
574                                                 Quantity_NameOfColor& theCustomColorName) const;
575
576   //! Returns the display priority of the entity anIobj. This
577   //! will be display   mode of anIobj if it is in the main
578   //! viewer.
579   Standard_EXPORT Standard_Integer DisplayPriority (const Handle(AIS_InteractiveObject)& anIobj) const;
580   
581
582   //! Returns true if a view of the Interactive Object aniobj has color.
583   Standard_EXPORT Standard_Boolean HasColor (const Handle(AIS_InteractiveObject)& aniobj) const;
584   
585   Standard_EXPORT Quantity_NameOfColor Color (const Handle(AIS_InteractiveObject)& aniobj) const;
586   
587
588   //! Returns the color Color of the entity aniobj in the interactive context.
589   Standard_EXPORT void Color (const Handle(AIS_InteractiveObject)& aniobj, Quantity_Color& acolor) const;
590   
591
592   //! Returns the width of the Interactive Object aniobj in
593   //! the interactive context.
594   Standard_EXPORT virtual Standard_Real Width (const Handle(AIS_InteractiveObject)& aniobj) const;
595   
596
597   //! Returns the status astatus of the Interactive Context
598   //! for the view of the Interactive Object anObj.
599   Standard_EXPORT void Status (const Handle(AIS_InteractiveObject)& anObj, TCollection_ExtendedString& astatus) const;
600   
601   //! Sets transform persistence.
602   Standard_EXPORT void SetTransformPersistence (const Handle(AIS_InteractiveObject)& theObject,
603                                                 const Handle(Graphic3d_TransformPers)& theTrsfPers);
604
605   Standard_DEPRECATED("This method is deprecated - SetTransformPersistence() taking Graphic3d_TransformPers should be called instead")
606   void SetTransformPersistence (const Handle(AIS_InteractiveObject)& theObj,
607                                 const Graphic3d_TransModeFlags&      theFlag,
608                                 const gp_Pnt&                        thePoint = gp_Pnt (0.0, 0.0, 0.0))
609   {
610     SetTransformPersistence (theObj, Graphic3d_TransformPers::FromDeprecatedParams (theFlag, thePoint));
611   }
612
613   //! Updates the current viewer, the viewer in Neutral Point.
614   //! Objects selected when there is no open local context
615   //! are called current objects; those selected in open
616   //! local context, selected objects.
617   Standard_EXPORT void UpdateCurrentViewer();
618   
619   //! Returns the display mode setting.
620   //! Note that mode 3 is only used.
621     Standard_Integer DisplayMode() const;
622   
623
624   //! Returns the name of the color used to show
625   //! highlighted entities, that is, entities picked out by the mouse.
626     Quantity_NameOfColor HilightColor() const;
627   
628
629   //! Returns the name of the color used to show selected entities.
630   //! By default, this is Quantity_NOC_GRAY80.
631     Quantity_NameOfColor SelectionColor() const;
632   
633   //! Returns the name of the color used to show preselection.
634   //! By default, this is Quantity_NOC_GREEN.
635     Quantity_NameOfColor PreSelectionColor() const;
636   
637
638   //! Returns the name of the color used by default.
639   //! By default, this is Quantity_NOC_GOLDENROD.
640     Quantity_NameOfColor DefaultColor() const;
641   
642
643   //! Returns the name of the color used to show that an
644   //! object is not currently selected.
645   //! By default, this is Quantity_NOC_GRAY40.
646     Quantity_NameOfColor SubIntensityColor() const;
647   
648
649   //! Sets the color used to show highlighted entities, that
650   //! is, entities picked by the mouse.
651   //! By default, this is Quantity_NOC_CYAN1.
652     void SetHilightColor (const Quantity_NameOfColor aHiCol);
653   
654
655   //! Sets the color used to show selected entities.
656   //! By default, this is Quantity_NOC_GRAY80.
657     void SelectionColor (const Quantity_NameOfColor aCol);
658   
659
660   //! Allows you to set the color used to show preselection.
661   //! By default, this is Quantity_NOC_GREEN.
662   //! A preselected entity is one which has been selected
663   //! as the domain of application of a function such as a fillet.
664     void SetPreselectionColor (const Quantity_NameOfColor aCol);
665   
666
667   //! Sets the color used to show that an object is not currently selected.
668   //! By default, this is Quantity_NOC_GRAY40.
669     void SetSubIntensityColor (const Quantity_NameOfColor aCol);
670   
671
672   //! Sets the display mode of seen Interactive Objects.
673   //! aMode provides the display mode index of the entity aniobj.
674   //! If updateviewer equals Standard_True, the
675   //! predominant mode aMode will overule the context mode.
676   //! If a local context is open and if updateviewer equals
677   //! Standard_False, the presentation of the Interactive
678   //! Object returns to the default selection mode; the
679   //! object is displayed but no viewer will be updated.
680   //! Note that display mode 3 is only used if you have an
681   //! AIS_Textured Shape.
682   Standard_EXPORT void SetDisplayMode (const Standard_Integer AMode, const Standard_Boolean updateviewer = Standard_True);
683   
684
685   //! Sets the deviation coefficient aCoefficient.
686   //! Drawings of curves or patches are made with respect
687   //! to a maximal chordal deviation. A Deviation coefficient
688   //! is used in the shading display mode. The shape is
689   //! seen decomposed into triangles. These are used to
690   //! calculate reflection of light from the surface of the
691   //! object. The triangles are formed from chords of the
692   //! curves in the shape. The deviation coefficient
693   //! aCoefficient gives the highest value of the angle with
694   //! which a chord can deviate from a tangent to a   curve.
695   //! If this limit is reached, a new triangle is begun.
696   //! This deviation is absolute and is set through the
697   //! method: SetMaximalChordialDeviation. The default
698   //! value is 0.001.
699   //! In drawing shapes, however, you are allowed to ask
700   //! for a relative deviation. This deviation will be:
701   //! SizeOfObject * DeviationCoefficient.
702   //! default 0.001
703   Standard_EXPORT void SetDeviationCoefficient (const Handle(AIS_InteractiveObject)& aniobj, const Standard_Real aCoefficient, const Standard_Boolean updateviewer = Standard_True);
704   
705   Standard_EXPORT void SetDeviationAngle (const Handle(AIS_InteractiveObject)& aniobj, const Standard_Real anAngle, const Standard_Boolean updateviewer = Standard_True);
706   
707   //! Calls the AIS_Shape SetAngleAndDeviation to set
708   //! both Angle and Deviation coefficients
709   Standard_EXPORT void SetAngleAndDeviation (const Handle(AIS_InteractiveObject)& aniobj, const Standard_Real anAngle, const Standard_Boolean updateviewer = Standard_True);
710   
711
712   //! Sets the deviation coefficient aCoefficient for
713   //! removal of hidden lines created by different
714   //! viewpoints in different presentations. The Default value is 0.02.
715   Standard_EXPORT void SetHLRDeviationCoefficient (const Handle(AIS_InteractiveObject)& aniobj, const Standard_Real aCoefficient, const Standard_Boolean updateviewer = Standard_True);
716   
717   Standard_EXPORT void SetHLRDeviationAngle (const Handle(AIS_InteractiveObject)& aniobj, const Standard_Real anAngle, const Standard_Boolean updateviewer = Standard_True);
718   
719   //! Computes a HLRAngle and a
720   //! HLRDeviationCoefficient by means of the angle
721   //! anAngle and sets the corresponding methods in the
722   //! default drawing tool with these values.
723   Standard_EXPORT void SetHLRAngleAndDeviation (const Handle(AIS_InteractiveObject)& aniobj, const Standard_Real anAngle, const Standard_Boolean updateviewer = Standard_True);
724   
725   //! Sets the deviation coefficient aCoefficient.
726   //! Drawings of curves or patches are made with respect
727   //! to a maximal chordal deviation. A Deviation coefficient
728   //! is used in the shading display mode. The shape is
729   //! seen decomposed into triangles. These are used to
730   //! calculate reflection of light from the surface of the
731   //! object. The triangles are formed from chords of the
732   //! curves in the shape. The deviation coefficient
733   //! aCoefficient gives the highest value of the angle with
734   //! which a chord can deviate from a tangent to a   curve.
735   //! If this limit is reached, a new triangle is begun.
736   //! This deviation is absolute and is set through the
737   //! method: SetMaximalChordialDeviation. The default
738   //! value is 0.001.
739   //! In drawing shapes, however, you are allowed to ask
740   //! for a relative deviation. This deviation will be:
741   //! SizeOfObject * DeviationCoefficient.
742   //! default 0.001
743   Standard_EXPORT void SetDeviationCoefficient (const Standard_Real aCoefficient);
744   
745   //! Returns the deviation coefficient.
746   //! Drawings of curves or patches are made with respect
747   //! to a maximal chordal deviation. A Deviation coefficient
748   //! is used in the shading display mode. The shape is
749   //! seen decomposed into triangles. These are used to
750   //! calculate reflection of light from the surface of the
751   //! object. The triangles are formed from chords of the
752   //! curves in the shape. The deviation coefficient gives
753   //! the highest value of the angle with which a chord can
754   //! deviate from a tangent to a   curve. If this limit is
755   //! reached, a new triangle is begun.
756   //! This deviation is absolute and is set through
757   //! Prs3d_Drawer::SetMaximalChordialDeviation. The
758   //! default value is 0.001.
759   //! In drawing shapes, however, you are allowed to ask
760   //! for a relative deviation. This deviation will be:
761   //! SizeOfObject * DeviationCoefficient.
762   Standard_EXPORT Standard_Real DeviationCoefficient() const;
763   
764   //! default 12 degrees
765   Standard_EXPORT void SetDeviationAngle (const Standard_Real anAngle);
766   
767   Standard_EXPORT Standard_Real DeviationAngle() const;
768   
769   //! Sets the deviation coefficient aCoefficient for
770   //! removal of hidden lines created by different
771   //! viewpoints in different presentations. The Default value is 0.02.
772   Standard_EXPORT void SetHLRDeviationCoefficient (const Standard_Real aCoefficient);
773   
774
775   //! Returns the real number value of the hidden line
776   //! removal deviation coefficient.
777   //! A Deviation coefficient is used in the shading display
778   //! mode. The shape is seen decomposed into triangles.
779   //! These are used to calculate reflection of light from the
780   //! surface of the object.
781   //! The triangles are formed from chords of the curves in
782   //! the shape. The deviation coefficient give the highest
783   //! value of the angle with which a chord can deviate
784   //! from a tangent to a curve. If this limit is reached, a
785   //! new triangle is begun.
786   //! To find the hidden lines, hidden line display mode
787   //! entails recalculation of the view at each different
788   //! projector perspective.
789   //! Because hidden lines entail calculations of more than
790   //! usual complexity to decompose them into these
791   //! triangles, a deviation coefficient allowing greater
792   //! tolerance is used. This increases efficiency in calculation.
793   //! The Default value is 0.02.
794   Standard_EXPORT Standard_Real HLRDeviationCoefficient() const;
795   
796   //! Sets the HLR angle anAngle.
797   Standard_EXPORT void SetHLRAngle (const Standard_Real anAngle);
798   
799
800   //! Returns the real number value of the deviation angle
801   //! in hidden line removal views in this interactive context.
802   //! The default value is 20*PI/180.
803   Standard_EXPORT Standard_Real HLRAngle() const;
804   
805   //! compute with anangle a HLRAngle and a HLRDeviationCoefficient
806   //! and set them in myHLRAngle and in myHLRDeviationCoefficient
807   //! of myDefaultDrawer ;
808   //! anAngle is in radian ; ( 1 deg < angle in deg < 20 deg)
809   Standard_EXPORT void SetHLRAngleAndDeviation (const Standard_Real anAngle);
810   
811   //! Initializes hidden line aspect in the default drawing tool, or Drawer.
812   //! The default values are:
813   //! Color: Quantity_NOC_YELLOW
814   //! Type of line: Aspect_TOL_DASH
815   //! Width: 1.
816   Standard_EXPORT Handle(Prs3d_LineAspect) HiddenLineAspect() const;
817   
818
819   //! Sets the hidden line aspect anAspect.
820   //! anAspect defines display attributes for hidden lines in
821   //! HLR projections.
822   Standard_EXPORT void SetHiddenLineAspect (const Handle(Prs3d_LineAspect)& anAspect) const;
823   
824   //! returns Standard_True if the hidden lines are to be drawn.
825   //! By default the hidden lines are not drawn.
826   Standard_EXPORT Standard_Boolean DrawHiddenLine() const;
827   
828   Standard_EXPORT void EnableDrawHiddenLine() const;
829   
830   Standard_EXPORT void DisableDrawHiddenLine() const;
831   
832   //! Sets the number of U and V isoparameters displayed.
833   Standard_EXPORT void SetIsoNumber (const Standard_Integer NbIsos, const AIS_TypeOfIso WhichIsos = AIS_TOI_Both);
834   
835   //! Returns the number of U and V isoparameters displayed.
836   Standard_EXPORT Standard_Integer IsoNumber (const AIS_TypeOfIso WhichIsos = AIS_TOI_Both);
837   
838   //! Returns True if drawing isoparameters on planes is enabled.
839   Standard_EXPORT void IsoOnPlane (const Standard_Boolean SwitchOn);
840   
841   //! Returns True if drawing isoparameters on planes is enabled.
842   //! if <forUIsos> = False,
843   Standard_EXPORT Standard_Boolean IsoOnPlane() const;
844
845   //! Enables or disables on-triangulation build for isolines for a particular object.
846   //! In case if on-triangulation builder is disabled, default on-plane
847   //! builder will compute isolines for the object given.
848   Standard_EXPORT void IsoOnTriangulation (const Standard_Boolean theIsEnabled,
849                                            const Handle(AIS_InteractiveObject)& theObject);
850
851   //! Enables or disables on-triangulation build for isolines for default drawer.
852   //! In case if on-triangulation builder is disabled, default on-plane
853   //! builder will compute isolines for the object given.
854   Standard_EXPORT void IsoOnTriangulation (const Standard_Boolean theToSwitchOn);
855
856   //! Returns true if drawing isolines on triangulation algorithm is enabled.
857   Standard_EXPORT Standard_Boolean IsoOnTriangulation() const;
858
859   //! Sets the graphic basic aspect to the current presentation of
860   //! ALL selected objects.
861   //! Flag globalChange has no effect (left to simplify porting).
862   //! Updates the viewer when <updateViewer> is TRUE
863   Standard_EXPORT void SetSelectedAspect (const Handle(Prs3d_BasicAspect)& anAspect, const Standard_Boolean globalChange = Standard_True, const Standard_Boolean updateViewer = Standard_True);
864   
865   //! Relays mouse position in pixels theXPix and theYPix to the interactive context selectors.
866   //! This is done by the view theView passing this position to the main viewer and updating it.
867   //! Functions in both Neutral Point and local contexts.
868   //! If theToRedrawOnUpdate is set to false, callee should call RedrawImmediate() to highlight detected object.
869   Standard_EXPORT AIS_StatusOfDetection MoveTo (const Standard_Integer theXPix, const Standard_Integer theYPix, const Handle(V3d_View)& theView, const Standard_Boolean theToRedrawOnUpdate = Standard_True);
870   
871   //! returns True  if other entities  were detected  in the
872   //! last mouse detection
873   Standard_EXPORT Standard_Boolean HasNextDetected() const;
874   
875   //! if more than 1 object is detected by the selector,
876   //! only the "best" owner is hilighted at the mouse position.
877   //! This Method allows the user to hilight one after another
878   //! the other detected entities.
879   //! if The method select is called, the selected entity
880   //! will be the hilighted one!
881   //! returns the Rank of hilighted entity
882   //! WARNING : Loop Method. When all the detected entities
883   //! have been hilighted , the next call will hilight
884   //! the first one again
885   Standard_EXPORT Standard_Integer HilightNextDetected (const Handle(V3d_View)& theView, const Standard_Boolean theToRedrawImmediate = Standard_True);
886   
887   //! Same as previous methods in reverse direction...
888   Standard_EXPORT Standard_Integer HilightPreviousDetected (const Handle(V3d_View)& theView, const Standard_Boolean theToRedrawImmediate = Standard_True);
889   
890   //! Adds object in the selection.
891   Standard_EXPORT AIS_StatusOfPick AddSelect (const Handle(SelectMgr_EntityOwner)& theObject);
892
893   //! Adds object in the selection.
894   AIS_StatusOfPick AddSelect (const Handle(AIS_InteractiveObject)& theObject)
895   {
896     return AddSelect (theObject->GlobalSelOwner());
897   }
898
899   //! Selects everything found in the bounding rectangle
900   //! defined by the pixel minima and maxima, XPMin,
901   //! YPMin, XPMax, and YPMax in the view, aView
902   //! The objects detected are passed to the main viewer,
903   //! which is then updated.
904   Standard_EXPORT AIS_StatusOfPick Select (const Standard_Integer XPMin, const Standard_Integer YPMin, const Standard_Integer XPMax, const Standard_Integer YPMax, const Handle(V3d_View)& aView, const Standard_Boolean updateviewer = Standard_True);
905   
906   //! polyline selection; clears the previous picked list
907   Standard_EXPORT AIS_StatusOfPick Select (const TColgp_Array1OfPnt2d& Polyline, const Handle(V3d_View)& aView, const Standard_Boolean updateviewer = Standard_True);
908   
909   //! Stores  and hilights the previous detected; Unhilights
910   //! the previous picked.
911   Standard_EXPORT AIS_StatusOfPick Select (const Standard_Boolean updateviewer = Standard_True);
912   
913   //! adds the last detected to the list of previous picked.
914   //! if the last detected was already declared as picked,
915   //! removes it from the Picked List.
916   Standard_EXPORT AIS_StatusOfPick ShiftSelect (const Standard_Boolean updateviewer = Standard_True);
917   
918   //! adds the last detected to the list of previous picked.
919   //! if the last detected was already declared as picked,
920   //! removes it from the Picked List.
921   Standard_EXPORT AIS_StatusOfPick ShiftSelect (const TColgp_Array1OfPnt2d& Polyline, const Handle(V3d_View)& aView, const Standard_Boolean updateviewer = Standard_True);
922   
923   //! rectangle  of selection  ; adds new detected entities into the
924   //! picked list, removes the detected entities that were already stored...
925   Standard_EXPORT AIS_StatusOfPick ShiftSelect (const Standard_Integer XPMin, const Standard_Integer YPMin, const Standard_Integer XPMax, const Standard_Integer YPMax, const Handle(V3d_View)& aView, const Standard_Boolean updateviewer = Standard_True);
926   
927   //! Specify whether selected object must be hilighted when mouse cursor
928   //! is moved above it (in MoveTo method). By default this value is false and
929   //! selected object is not hilighted in this case.
930     void SetToHilightSelected (const Standard_Boolean toHilight);
931   
932   //! Return value specified whether selected object must be hilighted
933   //! when mouse cursor is moved above it
934     Standard_Boolean ToHilightSelected() const;
935
936
937   //! @name OBSOLETE METHODS THAT ARE VALID FOR LOCAL CONTEXT ONLY
938
939   //! Updates the view of the current object in open context.
940   //! Objects selected when there is no open local context
941   //! are called current objects; those selected in open
942   //! local context, selected objects.
943   //! If a local context is open and if updateviewer equals
944   //! Standard_False, the presentation of the Interactive
945   //! Object activates the selection mode; the object is
946   //! displayed but no viewer will be updated.
947   Standard_EXPORT void SetCurrentObject (const Handle(AIS_InteractiveObject)& aniobj, const Standard_Boolean updateviewer = Standard_True);
948   
949
950   //! Allows to add or remove the object given to the list of current and highlight/unhighlight it
951   //! correspondingly. Is valid for global context only; for local context use method AddOrRemoveSelected.
952   //! Since this method makes sence only for neutral point selection of a whole object, if 0 selection
953   //! of the object is empty this method simply does nothing.
954   Standard_EXPORT void AddOrRemoveCurrentObject (const Handle(AIS_InteractiveObject)& theObj,
955                                                  const Standard_Boolean theIsToUpdateViewer = Standard_True);
956   
957   //! Updates the list of current objects, i.e. hilights new
958   //! current objects, removes hilighting from former current objects.
959   //! Objects selected when there is no open local context
960   //! are called current objects; those selected in open
961   //! local context, selected objects.
962   Standard_EXPORT void UpdateCurrent();
963   
964
965   //! Returns the current selection touched by the cursor.
966   //! Objects selected when there is no open local context
967   //! are called current objects; those selected in open
968   //! local context, selected objects.
969     Standard_Boolean WasCurrentTouched() const;
970   
971     void SetOkCurrent();
972   
973
974   //! Returns true if there is a non-null interactive object in Neutral Point.
975   //! Objects selected when there is no open local context are called current objects;
976   //! those selected in open local context, selected objects.
977   Standard_EXPORT Standard_Boolean IsCurrent (const Handle(AIS_InteractiveObject)& theObject) const;
978   
979
980   //! Initializes a scan of the current selected objects in
981   //! Neutral Point.
982   //! Objects selected when there is no open local context
983   //! are called current objects; those selected in open
984   //! local context, selected objects.
985   Standard_EXPORT void InitCurrent();
986   
987
988   //! Returns true if there is another object found by the
989   //! scan of the list of current objects.
990   //! Objects selected when there is no open local context
991   //! are called current objects; those selected in open
992   //! local context, selected objects.
993   Standard_EXPORT Standard_Boolean MoreCurrent() const;
994   
995
996   //! Continues the scan to the next object in the list of
997   //! current objects.
998   //! Objects selected when there is no open local context
999   //! are called current objects; those selected in open
1000   //! local context, selected objects.
1001   Standard_EXPORT void NextCurrent();
1002   
1003
1004   //! Returns the current interactive object.
1005   //! Objects selected when there is no open local context
1006   //! are called current objects; those selected in open
1007   //! local context, selected objects.
1008   Standard_EXPORT Handle(AIS_InteractiveObject) Current() const;
1009   
1010   Standard_EXPORT Standard_Integer NbCurrents();
1011
1012   //! Highlights current objects.
1013   //! Objects selected when there is no open local context
1014   //! are called current objects; those selected in open
1015   //! local context, selected objects.
1016   //! If a local context is open and if updateviewer equals
1017   //! Standard_False, the presentation of the Interactive
1018   //! Object activates the selection mode; the object is
1019   //! displayed but no viewer will be updated.
1020   Standard_EXPORT void HilightCurrents (const Standard_Boolean theToUpdateViewer = Standard_True);
1021
1022   //! Removes highlighting from current objects.
1023   //! Objects selected when there is no open local context
1024   //! are called current objects; those selected in open
1025   //! local context, selected objects.
1026   //! If a local context is open and if updateviewer equals
1027   //! Standard_False, the presentation of the Interactive
1028   //! Object activates the selection mode; the object is
1029   //! displayed but no viewer will be updated.
1030   Standard_EXPORT void UnhilightCurrents (const Standard_Boolean updateviewer = Standard_True);
1031
1032   //! Empties previous current objects in order to get the
1033   //! current objects detected by the selector using
1034   //! UpdateCurrent.
1035   //! Objects selected when there is no open local context
1036   //! are called current objects; those selected in open
1037   //! local context, selected objects.
1038   //! If a local context is open and if updateviewer equals
1039   //! Standard_False, the presentation of the Interactive
1040   //! Object activates the selection mode; the object is
1041   //! displayed but no viewer will be updated.
1042   Standard_EXPORT void ClearCurrents (const Standard_Boolean theToUpdateViewer = Standard_True);
1043
1044   //! @return current mouse-detected shape or empty (null) shape, if current interactive object
1045   //! is not a shape (AIS_Shape) or there is no current mouse-detected interactive object at all.
1046   Standard_EXPORT const TopoDS_Shape& DetectedCurrentShape() const;
1047   
1048   //! @return current mouse-detected interactive object or null object, if there is no
1049   //! currently detected interactives
1050   Standard_EXPORT Handle(AIS_InteractiveObject) DetectedCurrentObject() const;
1051
1052   //! @name COMMON SELECTION METHODS VALID FOR BOTH GLOBAL AND LOCAL CONTEXT
1053
1054   //! Unhighlights previously selected owners and marks them as not selected.
1055   //! Marks owner given as selected and highlights it.
1056   //! Performs selection filters check.
1057   Standard_EXPORT void SetSelected (const Handle(SelectMgr_EntityOwner)& theOwners,
1058                                     const Standard_Boolean theToUpdateViewer = Standard_True);
1059
1060   //! Puts the interactive object aniObj in the list of
1061   //! selected objects.
1062   //! If a local context is open and if updateviewer equals
1063   //! Standard_False, the presentation of the Interactive
1064   //! Object activates the selection mode; the object is
1065   //! displayed but no viewer will be updated.
1066   //! Performs selection filters check.
1067   Standard_EXPORT void SetSelected (const Handle(AIS_InteractiveObject)& theObject,
1068                                     const Standard_Boolean theToUpdateViewer = Standard_True);
1069
1070   //! Updates the list of selected objects:
1071   //! i.e. highlights the newely selected ones and unhighlights previously selected objects.
1072   Standard_EXPORT void UpdateSelected (const Standard_Boolean theToUpdateViewer = Standard_True);
1073   
1074   //! Allows to highlight or unhighlight the owner given depending on its selection status
1075   Standard_EXPORT void AddOrRemoveSelected (const Handle(AIS_InteractiveObject)& theObject,
1076                                             const Standard_Boolean theToUpdateViewer = Standard_True);
1077
1078   //! Highlights selected objects.
1079   //! If a local context is open and if updateviewer equals
1080   //! Standard_False, the presentation of the Interactive
1081   //! Object activates the selection mode; the object is
1082   //! displayed but no viewer will be updated.
1083   Standard_EXPORT void HilightSelected (const Standard_Boolean theToUpdateViewer = Standard_True);
1084
1085   //! Removes highlighting from selected objects.
1086   //! If a local context is open and if updateviewer equals
1087   //! Standard_False, the presentation of the Interactive
1088   //! Object activates the selection mode; the object is
1089   //! displayed but no viewer will be updated.
1090   Standard_EXPORT void UnhilightSelected (const Standard_Boolean theToUpdateViewer = Standard_True);
1091
1092   //! Empties previous selected objects in order to get the
1093   //! selected objects detected by the selector using
1094   //! UpdateSelected.
1095   //! If a local context is open and if updateviewer equals
1096   //! Standard_False, the presentation of the Interactive
1097   //! Object activates the selection mode; the object is
1098   //! displayed but no viewer will be updated.
1099   Standard_EXPORT void ClearSelected (const Standard_Boolean theToUpdateViewer = Standard_True);
1100   
1101   //! No right to Add a selected Shape (Internal Management
1102   //! of shape Selection).
1103   //! A Previous selected shape may only be removed.
1104   Standard_EXPORT void AddOrRemoveSelected (const TopoDS_Shape& aShape, const Standard_Boolean updateviewer = Standard_True);
1105
1106   //! Allows to highlight or unhighlight the owner given depending on its selection status
1107   Standard_EXPORT void AddOrRemoveSelected (const Handle(SelectMgr_EntityOwner)& theOwner,
1108                                             const Standard_Boolean theToUpdateViewer = Standard_True);
1109
1110   //! Returns true is the owner given is selected
1111   Standard_EXPORT Standard_Boolean IsSelected (const Handle(SelectMgr_EntityOwner)& theOwner) const;
1112
1113   //! Returns true is the object given is selected
1114   Standard_EXPORT Standard_Boolean IsSelected (const Handle(AIS_InteractiveObject)& theObj) const;
1115
1116   //! Returns the first selected object in the list of current selected.
1117   Standard_EXPORT Handle(AIS_InteractiveObject) FirstSelectedObject();
1118
1119   //! Initializes a scan of the selected objects.
1120   Standard_EXPORT void InitSelected();
1121
1122   //! Returns true if there is another object found by the
1123   //! scan of the list of selected objects.
1124   Standard_EXPORT Standard_Boolean MoreSelected() const;
1125
1126   //! Continues the scan to the next object in the list of
1127   //! selected objects.
1128   Standard_EXPORT void NextSelected();
1129
1130   Standard_EXPORT Standard_Integer NbSelected();
1131
1132   //! Returns true if the interactive context has a shape
1133   //! selected in it which results from the decomposition of
1134   //! another entity.
1135   //! If HasSelectedShape returns true, SelectedShape
1136   //! returns the shape which has been shown to be
1137   //! selected. Interactive returns the Interactive Object
1138   //! from which the shape has been selected.
1139   //! If HasSelectedShape returns false, Interactive
1140   //! returns the interactive entity selected by the click of the mouse.
1141   Standard_EXPORT Standard_Boolean HasSelectedShape() const;
1142
1143   //! Returns the selected shape.
1144   Standard_EXPORT TopoDS_Shape SelectedShape() const;
1145
1146   //! Returns the owner of the selected entity resulting
1147   //! from the decomposition of another entity.
1148   Standard_EXPORT Handle(SelectMgr_EntityOwner) SelectedOwner() const;
1149
1150   //! Returns a collection containing all entity owners
1151   //! created for the interactive object <theIObj> in
1152   //! the selection mode theMode (in all active modes
1153   //! if the Mode == -1)
1154   Standard_EXPORT void EntityOwners (Handle(SelectMgr_IndexedMapOfOwner)& theOwners,
1155                                      const Handle(AIS_InteractiveObject)& theIObj,
1156                                      const Standard_Integer theMode = -1) const;
1157
1158   Standard_EXPORT Handle(AIS_InteractiveObject) SelectedInteractive() const;
1159
1160   //! Returns true if the applicative object has an owner
1161   //! from Interactive attributed to it.
1162   Standard_EXPORT Standard_Boolean HasApplicative() const;
1163   
1164
1165   //! Returns the owner of the applicative entity detected
1166   //! in interactive context. The owner can be a shape for
1167   //! a set of sub-shapes or a sub-shape for sub-shapes
1168   //! which it is composed of.
1169   Standard_EXPORT Handle(Standard_Transient) Applicative() const;
1170   
1171
1172   //! Returns true if there is a mouse-detected entity in local context.
1173   //! If there is no open local context, the objects selected
1174   //! are called current objects; selected objects if there is
1175   //! one. Iterators allow entities to be recovered in either
1176   //! case. This method is one of a set which allows you to
1177   //! manipulate the objects which have been placed in these two lists.
1178   Standard_EXPORT Standard_Boolean HasDetected() const;
1179   
1180
1181   //! Returns true if there is a detected shape in local context.
1182   //! If there is no open local context, the objects selected
1183   //! are called current objects; selected objects if there is
1184   //! one. Iterators allow entities to be recovered in either
1185   //! case. This method is one of a set which allows you to
1186   //! manipulate the objects which have been placed in these two lists.
1187   Standard_EXPORT Standard_Boolean HasDetectedShape() const;
1188   
1189
1190   //! Returns the shape detected in local context.
1191   //! If there is no open local context, the objects selected
1192   //! are called current objects; selected objects if there is
1193   //! one. Iterators allow entities to be recovered in either
1194   //! case. This method is one of a set which allows you to
1195   //! manipulate the objects which have been placed in these two lists.
1196   Standard_EXPORT const TopoDS_Shape& DetectedShape() const;
1197   
1198
1199   //! Returns the interactive objects last detected in open context.
1200   //! If there is no open local context, the objects selected
1201   //! are called current objects; selected objects if there is
1202   //! one. Iterators allow entities to be recovered in either
1203   //! case. This method is one of a set which allows you to
1204   //! manipulate the objects which have been placed in these two lists.
1205   Standard_EXPORT Handle(AIS_InteractiveObject) DetectedInteractive() const;
1206   
1207   //! returns the owner of the detected sensitive primitive.
1208   Standard_EXPORT Handle(SelectMgr_EntityOwner) DetectedOwner() const;
1209   
1210
1211   //! Initialization for iteration through mouse-detected objects in
1212   //! interactive context or in local context if it is opened.
1213   Standard_EXPORT void InitDetected();
1214   
1215
1216   //! @return true if there is more mouse-detected objects after the current one
1217   //! during iteration through mouse-detected interactive objects.
1218   Standard_EXPORT Standard_Boolean MoreDetected() const;
1219   
1220
1221   //! Gets next current object during iteration through mouse-detected
1222   //! interactive objects.
1223   Standard_EXPORT void NextDetected();
1224
1225   //! Opens local contexts and specifies how this is to be
1226   //! done. The options listed above function in the following manner:
1227   //! -   UseDisplayedObjects -allows you to load or not
1228   //! load the interactive objects visualized at Neutral
1229   //! Point in the local context which you open. If false,
1230   //! the local context is empty after being opened. If
1231   //! true, the objects at Neutral Point are loaded by their
1232   //! default selection mode.
1233   //! -   AllowShapeDecomposition -AIS_Shape allows or
1234   //! prevents decomposition in standard shape location
1235   //! mode of objects at Neutral Point which are
1236   //! type-"privileged". This Flag is only taken into
1237   //! account when UseDisplayedObjects is true.
1238   //! -   AcceptEraseOfObjects -authorises other local
1239   //! contexts to erase the interactive objects present in
1240   //! this context. This option is rarely used.
1241   //! -   BothViewers - Has no use currently defined.
1242   //! This method returns the index of the created local
1243   //! context. It should be kept and used to close the context.
1244   //! Opening a local context allows you to prepare an
1245   //! environment for temporary presentations and
1246   //! selections which will disappear once the local context is closed.
1247   //! You can open several local contexts, but only the last
1248   //! one will be active.
1249   Standard_EXPORT Standard_Integer OpenLocalContext (const Standard_Boolean UseDisplayedObjects = Standard_True, const Standard_Boolean AllowShapeDecomposition = Standard_True, const Standard_Boolean AcceptEraseOfObjects = Standard_False, const Standard_Boolean BothViewers = Standard_False);
1250   
1251   //! Allows you to close local contexts. For greater
1252   //! security, you should close the context with the
1253   //! index Index given on opening.
1254   //! When you close a local context, the one before,
1255   //! which is still on the stack,   reactivates. If none is
1256   //! left, you return to Neutral Point.
1257   //! If a local context is open and if updateviewer
1258   //! equals Standard_False, the presentation of the
1259   //! Interactive Object activates the selection mode; the
1260   //! object is displayed but no viewer will be updated.
1261   //! Warning
1262   //! When the index isn't specified, the current context
1263   //! is closed. This option can be dangerous, as other
1264   //! Interactive Functions can open local contexts
1265   //! without necessarily warning the user.
1266   Standard_EXPORT void CloseLocalContext (const Standard_Integer Index = -1, const Standard_Boolean updateviewer = Standard_True);
1267   
1268   //! returns -1 if no opened local context.
1269   Standard_EXPORT Standard_Integer IndexOfCurrentLocal() const;
1270   
1271
1272   //! Allows you to close all local contexts at one go and
1273   //! return to Neutral Point.
1274   //! If a local context is open and if updateviewer equals
1275   //! Standard_False, the presentation of the Interactive
1276   //! Object activates the selection mode; the object is
1277   //! displayed but no viewer will be updated.
1278   Standard_EXPORT void CloseAllContexts (const Standard_Boolean updateviewer = Standard_True);
1279   
1280   //! to   be  used only with no  opened
1281   //! local context..  displays and activates objects in their
1282   //! original state before local contexts were opened...
1283   Standard_EXPORT void ResetOriginalState (const Standard_Boolean updateviewer = Standard_True);
1284   
1285   //! clears Objects/Filters/Activated Modes list in the current opened
1286   //! local context.
1287   Standard_EXPORT void ClearLocalContext (const AIS_ClearMode TheMode = AIS_CM_All);
1288   
1289   Standard_EXPORT void UseDisplayedObjects();
1290   
1291   //! when a local Context is opened, one is able to
1292   //! use/not use the displayed objects at neutral point
1293   //! at anytime.
1294   Standard_EXPORT void NotUseDisplayedObjects();
1295   
1296   //! initializes the list of presentations to be displayed
1297   //! returns False if no local context is opened.
1298   Standard_EXPORT Standard_Boolean BeginImmediateDraw();
1299   
1300   //! returns True if <anIObj> has been stored in the list.
1301   Standard_EXPORT Standard_Boolean ImmediateAdd (const Handle(AIS_InteractiveObject)& theObj, const Standard_Integer theMode = 0);
1302   
1303   //! returns True if the immediate display has been done.
1304   Standard_EXPORT Standard_Boolean EndImmediateDraw (const Handle(V3d_View)& theView);
1305   
1306   //! Uses the First Active View of Main Viewer!
1307   //! returns True if the immediate display has been done.
1308   Standard_EXPORT Standard_Boolean EndImmediateDraw();
1309   
1310   Standard_EXPORT Standard_Boolean IsImmediateModeOn() const;
1311   
1312
1313   //! Sets the highlighting status aStatus of detected and
1314   //! selected entities.
1315   //! Whether you are in Neutral Point or local context, this
1316   //! is automatically managed by the Interactive Context.
1317   //! This function allows you to disconnect the automatic mode.
1318   Standard_EXPORT void SetAutomaticHilight (const Standard_Boolean aStatus);
1319   
1320
1321   //! Returns true if the automatic highlight mode is active
1322   //! in an open context.
1323   Standard_EXPORT Standard_Boolean AutomaticHilight() const;
1324   
1325   //! Enables/Disables the Z detection.
1326   //! If TRUE the detection echo can be partially hidden by the
1327   //! detected object.
1328   Standard_EXPORT void SetZDetection (const Standard_Boolean aStatus = Standard_False);
1329   
1330   //! Retrieves the Z detection state.
1331   Standard_EXPORT Standard_Boolean ZDetection() const;
1332   
1333   //! Activates the selection mode aMode whose index is
1334   //! given, for the given interactive entity anIobj.
1335   Standard_EXPORT void Activate (const Handle(AIS_InteractiveObject)& anIobj, const Standard_Integer aMode = 0, const Standard_Boolean theIsForce = Standard_False);
1336   
1337   //! Deactivates all the activated selection modes
1338   //! of an object.
1339   Standard_EXPORT void Deactivate (const Handle(AIS_InteractiveObject)& anIObj);
1340   
1341
1342   //! Deactivates all the activated selection modes of the
1343   //! interactive object anIobj with a given selection mode aMode.
1344   Standard_EXPORT void Deactivate (const Handle(AIS_InteractiveObject)& anIobj, const Standard_Integer aMode);
1345   
1346
1347   //! Returns the list of activated selection modes in an open context.
1348   Standard_EXPORT void ActivatedModes (const Handle(AIS_InteractiveObject)& anIobj, TColStd_ListOfInteger& theList) const;
1349   
1350   //! to be Used only with opened local context and
1351   //! if <anIobj> is of type shape...
1352   //! if <aStatus> = True <anIobj> will be sensitive to
1353   //! shape selection modes activation.
1354   //! = False, <anIobj> will not be senstive
1355   //! any more.
1356   Standard_EXPORT void SetShapeDecomposition (const Handle(AIS_InteractiveObject)& anIobj, const Standard_Boolean aStatus);
1357   
1358
1359   //! Sets the temporary graphic attributes of the entity
1360   //! anObj. These are provided by the attribute manager
1361   //! aDrawer and are valid for a particular local context only.
1362   //! If a local context is open and if updateviewer equals
1363   //! Standard_False, the presentation of the Interactive
1364   //! Object activates the selection mode; the object is
1365   //! displayed but no viewer will be updated.
1366   Standard_EXPORT void SetTemporaryAttributes (const Handle(AIS_InteractiveObject)& anObj, const Handle(Prs3d_Drawer)& aDrawer, const Standard_Boolean updateviewer = Standard_True);
1367   
1368
1369   //! Highlights, and removes highlights from, the displayed
1370   //! object aniobj which is displayed at Neutral Point with
1371   //! subintensity color; available only for active local
1372   //! context. There is no effect if there is no local context.
1373   //! If a local context is open and if updateviewer equals
1374   //! Standard_False, the presentation of the Interactive
1375   //! Object activates the selection mode; the object is
1376   //! displayed but no viewer will be updated.
1377   Standard_EXPORT void SubIntensityOn (const Handle(AIS_InteractiveObject)& aniobj, const Standard_Boolean updateviewer = Standard_True);
1378   
1379
1380   //! Removes the subintensity option for the entity aniobj.
1381   //! If a local context is open and if updateviewer equals
1382   //! Standard_False, the presentation of the Interactive
1383   //! Object activates the selection mode; the object is
1384   //! displayed but no viewer will be updated.
1385   Standard_EXPORT void SubIntensityOff (const Handle(AIS_InteractiveObject)& aniobj, const Standard_Boolean updateviewer = Standard_True);
1386   
1387   //! hilights/unhilights displayed objects which are displayed at
1388   //! neutral state with subintensity color;
1389   //! available only for active local context.
1390   //! No effect if no local context.
1391   Standard_EXPORT void SubIntensityOn (const Standard_Boolean updateviewer = Standard_True);
1392   
1393   //! removes subintensity option for all objects.
1394   Standard_EXPORT void SubIntensityOff (const Standard_Boolean updateviewer = Standard_True);
1395   
1396   //! Allows you to add the filter aFilter to Neutral Point or
1397   //! to a local context if one or more selection modes have been activated.
1398   //! Only type filters may be active in Neutral Point.
1399   Standard_EXPORT void AddFilter (const Handle(SelectMgr_Filter)& aFilter);
1400   
1401
1402   //! Removes a filter from Neutral Point or a local context
1403   //! if one or more selection modes have been activated.
1404   //! Only type filters are activated in Neutral Point.
1405   Standard_EXPORT void RemoveFilter (const Handle(SelectMgr_Filter)& aFilter);
1406   
1407   //! Remove a filter to Neutral Point or a local context if
1408   //! one or more selection modes have been activated.
1409   //! Only type filters are active in Neutral Point.
1410   Standard_EXPORT void RemoveFilters();
1411   
1412   //! Provides an alternative to the Display methods when
1413   //! activating specific selection modes. This has the
1414   //! effect of activating the corresponding selection mode
1415   //! aStandardActivation for all objects in Local Context
1416   //! which accept decomposition into sub-shapes.
1417   //! Every new Object which has been loaded into the
1418   //! interactive context and which answers these
1419   //! decomposition criteria is automatically activated
1420   //! according to these modes.
1421   //! Warning
1422   //! If you have opened a local context by loading an
1423   //! object with the default options
1424   //! (<AllowShapeDecomposition >= Standard_True), all
1425   //! objects of the "Shape" type are also activated with
1426   //! the same modes. You can act on the state of these
1427   //! "Standard" objects by using SetShapeDecomposition(Status).
1428   Standard_EXPORT void ActivateStandardMode (const TopAbs_ShapeEnum aStandardActivation);
1429   
1430
1431   //! Provides an alternative to the Display methods when
1432   //! deactivating specific selection modes. This has the
1433   //! effect of deactivating the corresponding selection
1434   //! mode aStandardActivation for all objects in Local
1435   //! Context which accept decomposition into sub-shapes.
1436   Standard_EXPORT void DeactivateStandardMode (const TopAbs_ShapeEnum aStandardActivation);
1437   
1438
1439   //! Returns the list of activated standard selection modes
1440   //! available in a local context.
1441   Standard_EXPORT const TColStd_ListOfInteger& ActivatedStandardModes() const;
1442   
1443
1444   //! Returns the list of filters active in a local context.
1445   Standard_EXPORT const SelectMgr_ListOfFilter& Filters() const;
1446   
1447
1448   //! Returns the default attribute manager.
1449   //! This contains all the color and line attributes which
1450   //! can be used by interactive objects which do not have
1451   //! their own attributes.
1452     const Handle(Prs3d_Drawer)& DefaultDrawer() const;
1453   
1454   //! Returns the current viewer.
1455     const Handle(V3d_Viewer)& CurrentViewer() const;
1456   
1457   //! Returns the list of displayed objects of a particular
1458   //! Type WhichKind and Signature WhichSignature. By
1459   //! Default, WhichSignature equals -1. This means that
1460   //! there is a check on type only.
1461   Standard_EXPORT void DisplayedObjects (AIS_ListOfInteractive& aListOfIO, const Standard_Boolean OnlyFromNeutral = Standard_False) const;
1462   
1463   //! gives the list of displayed objects of a particular
1464   //! Type and signature.
1465   //! by Default, <WhichSignature> = -1 means
1466   //! control only on <WhichKind>.
1467   Standard_EXPORT void DisplayedObjects (const AIS_KindOfInteractive WhichKind, const Standard_Integer WhichSignature, AIS_ListOfInteractive& aListOfIO, const Standard_Boolean OnlyFromNeutral = Standard_False) const;
1468   
1469
1470   //! Returns the list theListOfIO of erased objects (hidden objects)
1471   //! particular Type WhichKind and Signature WhichSignature.
1472   //! By Default, WhichSignature equals 1. This means
1473   //! that there is a check on type only.
1474   Standard_EXPORT void ErasedObjects (AIS_ListOfInteractive& theListOfIO) const;
1475   
1476   //! gives the list of erased objects (hidden objects)
1477   //! Type and signature
1478   //! by Default, <WhichSignature> = -1 means
1479   //! control only on <WhichKind>.
1480   Standard_EXPORT void ErasedObjects (const AIS_KindOfInteractive WhichKind, const Standard_Integer WhichSignature, AIS_ListOfInteractive& theListOfIO) const;
1481   
1482
1483   //! Returns the list theListOfIO of objects with indicated display status
1484   //! particular Type WhichKind and Signature WhichSignature.
1485   //! By Default, WhichSignature equals 1. This means
1486   //! that there is a check on type only.
1487   Standard_EXPORT void ObjectsByDisplayStatus (const AIS_DisplayStatus theStatus, AIS_ListOfInteractive& theListOfIO) const;
1488   
1489   //! gives the list of objects with indicated display status
1490   //! Type and signature
1491   //! by Default, <WhichSignature> = -1 means
1492   //! control only on <WhichKind>.
1493   Standard_EXPORT void ObjectsByDisplayStatus (const AIS_KindOfInteractive WhichKind, const Standard_Integer WhichSignature, const AIS_DisplayStatus theStatus, AIS_ListOfInteractive& theListOfIO) const;
1494   
1495   //! fills <aListOfIO> with objects of a particular
1496   //! Type and Signature with no consideration of display status.
1497   //! by Default, <WhichSignature> = -1 means
1498   //! control only on <WhichKind>.
1499   //! if <WhichKind> = AIS_KOI_None and <WhichSignature> = -1,
1500   //! all the objects are put into the list.
1501   Standard_EXPORT void ObjectsInside (AIS_ListOfInteractive& aListOfIO, const AIS_KindOfInteractive WhichKind = AIS_KOI_None, const Standard_Integer WhichSignature = -1) const;
1502   
1503   //! Returns true if there is an open context.
1504     Standard_Boolean HasOpenedContext() const;
1505
1506   //! This method is only intended for advanced operation, particularly with
1507   //! the aim to improve performance when many objects have to be selected
1508   //! together. Otherwise, you should use other (non-internal) methods of
1509   //! class AIS_InteractiveContext without trying to obtain an instance of
1510   //! AIS_LocalContext.
1511     Handle(AIS_LocalContext) LocalContext() const;
1512   
1513     const Handle(SelectMgr_SelectionManager)& SelectionManager() const;
1514   
1515     const Handle(PrsMgr_PresentationManager3d)& MainPrsMgr() const;
1516   
1517     const Handle(StdSelect_ViewerSelector3d)& MainSelector() const;
1518   
1519   Standard_EXPORT Handle(StdSelect_ViewerSelector3d) LocalSelector() const;
1520   
1521   //! Clears all the structures which don't
1522   //! belong to objects displayed at neutral point
1523   //! only effective when no Local Context is opened...
1524   //! returns the number of removed  structures from the viewers.
1525   Standard_EXPORT Standard_Integer PurgeDisplay();
1526   
1527   Standard_EXPORT Standard_Integer HighestIndex() const;
1528   
1529   Standard_EXPORT void DisplayActiveSensitive (const Handle(V3d_View)& aView);
1530   
1531   Standard_EXPORT void ClearActiveSensitive (const Handle(V3d_View)& aView);
1532   
1533   //! Fits the view correspondingly to the bounds of selected objects.
1534   //! Infinite objects are ignored if infinite state of AIS_InteractiveObject
1535   //! is set to true.
1536   Standard_EXPORT void FitSelected (const Handle(V3d_View)& theView, const Standard_Real theMargin = 0.01, const Standard_Boolean theToUpdate = Standard_True);
1537   
1538   Standard_EXPORT void DisplayActiveSensitive (const Handle(AIS_InteractiveObject)& anObject, const Handle(V3d_View)& aView);
1539   
1540   //! returns if possible,
1541   //! the first local context where the object is seen
1542   Standard_EXPORT Standard_Boolean IsInLocal (const Handle(AIS_InteractiveObject)& anObject, Standard_Integer& TheIndex) const;
1543   
1544   //! Rebuilds 1st level of BVH selection forcibly
1545   Standard_EXPORT void RebuildSelectionStructs();
1546   
1547   //! setup object visibility in specified view,
1548   //! has no effect if object is not disaplyed in this context.
1549   Standard_EXPORT void SetViewAffinity (const Handle(AIS_InteractiveObject)& theIObj, const Handle(V3d_View)& theView, const Standard_Boolean theIsVisible);
1550   
1551   //! Disconnects theObjToDisconnect from theAssembly and removes dependent selection structures
1552   Standard_EXPORT void Disconnect (const Handle(AIS_InteractiveObject)& theAssembly, const Handle(AIS_InteractiveObject)& theObjToDisconnect = NULL);
1553   
1554   //! Query objects visible or hidden in specified view due to affinity mask.
1555   Standard_EXPORT void ObjectsForView (AIS_ListOfInteractive& theListOfIO, const Handle(V3d_View)& theView, const Standard_Boolean theIsVisibleInView, const AIS_DisplayStatus theStatus = AIS_DS_None) const;
1556
1557   //! Redraws immediate structures in all views of the viewer given taking into account its visibility.
1558   Standard_EXPORT void RedrawImmediate (const Handle(V3d_Viewer)& theViewer);
1559
1560
1561 friend class AIS_LocalContext;
1562
1563
1564   DEFINE_STANDARD_RTTIEXT(AIS_InteractiveContext,MMgt_TShared)
1565
1566 protected:
1567
1568   Standard_EXPORT void GetDefModes (const Handle(AIS_InteractiveObject)& anIobj, Standard_Integer& Dmode, Standard_Integer& HiMod, Standard_Integer& SelMode) const;
1569   
1570   Standard_EXPORT void EraseGlobal (const Handle(AIS_InteractiveObject)& anObj, const Standard_Boolean updateviewer = Standard_True);
1571   
1572   Standard_EXPORT void ClearGlobal (const Handle(AIS_InteractiveObject)& anObj, const Standard_Boolean updateviewer = Standard_True);
1573   
1574   Standard_EXPORT void ClearGlobalPrs (const Handle(AIS_InteractiveObject)& anObj, const Standard_Integer aMode, const Standard_Boolean updateviewer = Standard_True);
1575   
1576   Standard_EXPORT void InitAttributes();
1577   
1578   Standard_EXPORT Standard_Integer PurgeViewer (const Handle(V3d_Viewer)& Vwr);
1579   
1580   //! UNKNOWN
1581   Standard_EXPORT void redisplayPrsModes (const Handle(AIS_InteractiveObject)& theIObj, const Standard_Boolean theToUpdateViewer = Standard_True);
1582   
1583   //! UNKNOWN
1584   Standard_EXPORT void redisplayPrsRecModes (const Handle(AIS_InteractiveObject)& theIObj, const Standard_Boolean theToUpdateViewer = Standard_True);
1585
1586   //! Helper function to unhighlight all entity owners currently highlighted with seleciton color.
1587   Standard_EXPORT void unhighlightOwners (const Handle(AIS_InteractiveObject)& theObject);
1588
1589   //! Helper function that highlights the owner given with <theColor> without
1590   //! performing AutoHighlight checks, e.g. is used for dynamic highlight.
1591   //! If the parameter <theViewer> is set and <theIsImmediate> is true, highlight will be synchronized
1592   //! automatically in all views of the viewer.
1593   Standard_EXPORT void highlightWithColor (const Handle(SelectMgr_EntityOwner)& theOwner,
1594                                            const Quantity_NameOfColor theColor,
1595                                            const Handle(V3d_Viewer)& theViewer = NULL);
1596
1597   //! Helper function that highlights the owner given with <theColor> with check
1598   //! for AutoHighlight, e.g. is used for selection.
1599   //! If the parameter <theViewer> is set and <theIsImmediate> is true, selection color will be synchronized
1600   //! automatically in all views of the viewer.
1601   Standard_EXPORT void highlightSelected (const Handle(SelectMgr_EntityOwner)& theOwner,
1602                                           const Quantity_NameOfColor theSelColor);
1603
1604   //! Helper function that unhighlights all owners that are stored in current AIS_Selection.
1605   //! The function updates global status and selection state of owner and interactive object.
1606   //! If the parameter <theIsToHilightSubIntensity> is set to true, interactive objects with sub-intensity
1607   //! switched on in AIS_GlobalStatus will be highlighted with context's sub-intensity color.
1608   Standard_EXPORT void unhighlightSelected (const Standard_Boolean theIsToHilightSubIntensity = Standard_False);
1609
1610 protected:
1611
1612   AIS_DataMapOfIOStatus myObjects;
1613   Handle(SelectMgr_SelectionManager) mgrSelector;
1614   Handle(PrsMgr_PresentationManager3d) myMainPM;
1615   Handle(V3d_Viewer) myMainVwr;
1616   Handle(StdSelect_ViewerSelector3d) myMainSel;
1617   Handle(SelectMgr_EntityOwner) myLastPicked;
1618   Handle(SelectMgr_EntityOwner) myLastinMain;
1619   Standard_Boolean myWasLastMain;
1620   Standard_Boolean myCurrentTouched;
1621   Standard_Boolean mySelectedTouched;
1622   Standard_Boolean myToHilightSelected;
1623   Handle(SelectMgr_OrFilter) myFilters;
1624   Handle(Prs3d_Drawer) myDefaultDrawer;
1625   Handle(AIS_Selection) mySelection;
1626   Quantity_NameOfColor myDefaultColor;
1627   Quantity_NameOfColor myHilightColor;
1628   Quantity_NameOfColor mySelectionColor;
1629   Quantity_NameOfColor myPreselectionColor;
1630   Quantity_NameOfColor mySubIntensity;
1631   Standard_Integer myDisplayMode;
1632   AIS_DataMapOfILC myLocalContexts;
1633   Standard_Integer myCurLocalIndex;
1634   Handle(V3d_View) mylastmoveview;
1635   AIS_SequenceOfInteractive myAISDetectedSeq;
1636   Standard_Integer myAISCurDetected;
1637   Standard_Boolean myZDetectionFlag;
1638   Standard_Boolean myIsAutoActivateSelMode;
1639
1640
1641 };
1642
1643
1644 #include <AIS_InteractiveContext.lxx>
1645
1646
1647
1648
1649
1650 #endif // _AIS_InteractiveContext_HeaderFile