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