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