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