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