1 // Created on: 1996-09-04
2 // Created by: Robert COUBLANC
3 // Copyright (c) 1996-1999 Matra Datavision
4 // Copyright (c) 1999-2014 OPEN CASCADE SAS
6 // This file is part of Open CASCADE Technology software library.
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.
14 // Alternatively, this file may be used under the terms of Open CASCADE
15 // commercial license or contractual agreement.
17 #ifndef _AIS_LocalContext_HeaderFile
18 #define _AIS_LocalContext_HeaderFile
20 #include <Standard.hxx>
21 #include <Standard_Type.hxx>
23 #include <Standard_Boolean.hxx>
24 #include <StdSelect_ViewerSelector3d.hxx>
25 #include <PrsMgr_PresentationManager3d.hxx>
26 #include <TCollection_AsciiString.hxx>
27 #include <AIS_DataMapOfSelStat.hxx>
28 #include <TColStd_ListOfInteger.hxx>
29 #include <SelectMgr_IndexedMapOfOwner.hxx>
30 #include <Standard_Integer.hxx>
31 #include <TColStd_SequenceOfInteger.hxx>
32 #include <AIS_SequenceOfInteractive.hxx>
33 #include <Standard_Transient.hxx>
34 #include <AIS_ClearMode.hxx>
35 #include <TopAbs_ShapeEnum.hxx>
36 #include <SelectMgr_ListOfFilter.hxx>
37 #include <AIS_StatusOfDetection.hxx>
38 #include <AIS_StatusOfPick.hxx>
39 #include <TColgp_Array1OfPnt2d.hxx>
40 #include <TColStd_MapOfTransient.hxx>
41 #include <Quantity_NameOfColor.hxx>
42 #include <Standard_Real.hxx>
43 #include <AIS_Selection.hxx>
44 class AIS_InteractiveContext;
45 class SelectMgr_SelectionManager;
46 class SelectMgr_OrFilter;
47 class SelectMgr_Filter;
48 class TCollection_AsciiString;
49 class AIS_InteractiveObject;
53 class SelectMgr_EntityOwner;
54 class Standard_Transient;
55 class AIS_LocalStatus;
56 class SelectMgr_SelectableObject;
59 class AIS_LocalContext;
60 DEFINE_STANDARD_HANDLE(AIS_LocalContext, Standard_Transient)
62 //! Defines a specific context for selection.
63 //! It becomes possible to:
64 //! + Load InteractiveObjects with a mode to be
65 //! activated + associate InteractiveObjects with a
66 //! set of temporary selectable Objects.... + +
67 //! activate StandardMode of selection for Entities
68 //! inheriting BasicShape from AIS (Selection Of
69 //! vertices, edges, wires,faces... + Add Filters
70 //! acting on detected owners of sensitive primitives
72 //! - automatically highlight shapes and
73 //! InteractiveObjects (highlight of detected shape +
74 //! highlight of detected selectable...
75 class AIS_LocalContext : public Standard_Transient
81 Standard_EXPORT AIS_LocalContext();
83 //! Constructor By Default, the displayed objects are
84 //! automatically loaded.
85 Standard_EXPORT AIS_LocalContext(const Handle(AIS_InteractiveContext)& aCtx, const Standard_Integer anIndex, const Standard_Boolean LoadDisplayed = Standard_True, const Standard_Boolean AcceptStandardModes = Standard_True, const Standard_Boolean AcceptErase = Standard_False, const Standard_Boolean UseBothViewers = Standard_False);
87 //! authorize or not others contexts to erase
88 //! temporary displayed objects here;
89 void AcceptErase (const Standard_Boolean aStatus);
91 Standard_Boolean AcceptErase() const;
93 Standard_EXPORT void SetContext (const Handle(AIS_InteractiveContext)& aCtx);
95 const Handle(AIS_Selection) Selection() const;
97 Standard_EXPORT void Terminate (const Standard_Boolean updateviewer = Standard_True);
99 //! returns true if done...
100 Standard_EXPORT Standard_Boolean Display (const Handle(AIS_InteractiveObject)& anInteractive, const Standard_Integer DisplayMode = 0, const Standard_Boolean AllowShapeDecomposition = Standard_True, const Standard_Integer ActivationMode = 0);
102 //! loads <anInteractive> with nodisplay...
103 //! returns true if done
104 Standard_EXPORT Standard_Boolean Load (const Handle(AIS_InteractiveObject)& anInteractive, const Standard_Boolean AllowShapeDecomposition = Standard_True, const Standard_Integer ActivationMode = 0);
106 //! returns true if done...
107 Standard_EXPORT Standard_Boolean Erase (const Handle(AIS_InteractiveObject)& anInteractive);
109 Standard_EXPORT Standard_Boolean Remove (const Handle(AIS_InteractiveObject)& aSelectable);
111 Standard_EXPORT Standard_Boolean ClearPrs (const Handle(AIS_InteractiveObject)& anInteractive, const Standard_Integer aMode);
113 //! allows or forbids the shape decomposition into
114 //! Activated Standard Mode for <aStoredObject>
115 //! does nothing if the object doesn't inherits
116 //! BasicShape from AIS
117 Standard_EXPORT void SetShapeDecomposition (const Handle(AIS_InteractiveObject)& aStoredObject, const Standard_Boolean aStatus);
119 //! according to <atype> , clears the different parts of
120 //! the selector (filters, modeof activation, objects...)
121 Standard_EXPORT void Clear (const AIS_ClearMode atype = AIS_CM_All);
123 //! optional : activation of a mode which is not 0 for a selectable...
124 Standard_EXPORT void ActivateMode (const Handle(AIS_InteractiveObject)& aSelectable, const Standard_Integer aMode);
126 Standard_EXPORT void DeactivateMode (const Handle(AIS_InteractiveObject)& aSelectable, const Standard_Integer aMode);
128 Standard_EXPORT void Deactivate (const Handle(AIS_InteractiveObject)& aSelectable);
130 //! decomposition of shapes into <aType>
131 Standard_EXPORT void ActivateStandardMode (const TopAbs_ShapeEnum aType);
133 Standard_EXPORT void DeactivateStandardMode (const TopAbs_ShapeEnum aType);
135 const TColStd_ListOfInteger& StandardModes() const;
137 Standard_EXPORT void AddFilter (const Handle(SelectMgr_Filter)& aFilter);
139 Standard_EXPORT void RemoveFilter (const Handle(SelectMgr_Filter)& aFilter);
141 const SelectMgr_ListOfFilter& ListOfFilter() const;
143 const Handle(SelectMgr_OrFilter)& Filter() const;
145 //! if <aStatus> = True , the shapes or subshapes detected
146 //! by the selector will be automatically hilighted in the
148 //! Else the user has to manage the detected shape outside the
149 //! Shape Selector....
150 void SetAutomaticHilight (const Standard_Boolean aStatus);
152 Standard_Boolean AutomaticHilight() const;
154 Standard_EXPORT AIS_StatusOfDetection MoveTo (const Standard_Integer theXpix, const Standard_Integer theYpix, const Handle(V3d_View)& theView, const Standard_Boolean theToRedrawImmediate);
156 //! returns True if more than one entity
157 //! was detected at the last Mouse position.
158 Standard_Boolean HasNextDetected() const;
160 //! returns True if last detected. the next detected will
161 //! be first one (endless loop)
162 Standard_EXPORT Standard_Integer HilightNextDetected (const Handle(V3d_View)& theView, const Standard_Boolean theToRedrawImmediate);
164 Standard_EXPORT Standard_Integer HilightPreviousDetected (const Handle(V3d_View)& theView, const Standard_Boolean theToRedrawImmediate);
166 //! returns True if something was done...
167 Standard_EXPORT Standard_Boolean UnhilightLastDetected (const Handle(V3d_Viewer)& theViewer);
169 //! returns True if something was done...
170 Standard_EXPORT Standard_Boolean UnhilightLastDetected (const Handle(V3d_View)& theView);
172 //! returns the number of selected
173 Standard_EXPORT AIS_StatusOfPick AddSelect (const Handle(SelectMgr_EntityOwner)& theObject);
175 Standard_EXPORT AIS_StatusOfPick Select (const Standard_Boolean updateviewer = Standard_True);
177 Standard_EXPORT AIS_StatusOfPick ShiftSelect (const Standard_Boolean updateviewer = Standard_True);
179 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);
181 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);
183 Standard_EXPORT AIS_StatusOfPick Select (const TColgp_Array1OfPnt2d& Polyline, const Handle(V3d_View)& aView, const Standard_Boolean updateviewer = Standard_True);
185 Standard_EXPORT AIS_StatusOfPick ShiftSelect (const TColgp_Array1OfPnt2d& Polyline, const Handle(V3d_View)& aView, const Standard_Boolean updateviewer = Standard_True);
187 Standard_EXPORT void HilightPicked (const Standard_Boolean updateviewer = Standard_True);
189 Standard_EXPORT void UnhilightPicked (const Standard_Boolean updateviewer = Standard_True);
191 Standard_EXPORT void UpdateSelected (const Standard_Boolean updateviewer = Standard_True);
193 //! Part of advanced selection highlighting mechanism.
194 //! If no owners belonging to anobj are selected, calls anobj->ClearSelected(),
195 //! otherwise calls anobj->HilightSelected(). This method can be used to avoid
196 //! redrawing the whole selection belonging to several Selectable Objects.
197 Standard_EXPORT void UpdateSelected (const Handle(AIS_InteractiveObject)& anobj, const Standard_Boolean updateviewer = Standard_True);
199 //! useful to update selection with objects coming from
200 //! Collector or stack
201 Standard_EXPORT void SetSelected (const Handle(AIS_InteractiveObject)& anobj, const Standard_Boolean updateviewer = Standard_True);
203 //! useful to update selection with objects coming from
204 //! Collector or stack
205 Standard_EXPORT void AddOrRemoveSelected (const Handle(AIS_InteractiveObject)& anobj, const Standard_Boolean updateviewer = Standard_True);
207 Standard_EXPORT void AddOrRemoveSelected (const TopoDS_Shape& aShape, const Standard_Boolean updateviewer = Standard_True);
209 Standard_EXPORT void AddOrRemoveSelected (const Handle(SelectMgr_EntityOwner)& theOwner, const Standard_Boolean toUpdateViewer = Standard_True);
211 //! Clears local context selection.
212 //! @param toUpdateViewer [in] if TRUE the viewer will be updated.
213 Standard_EXPORT void ClearSelected (const Standard_Boolean toUpdateViewer = Standard_True);
215 //! Clears outdated selection and detection of owners for the
216 //! interactive object. Use this method if selection structures
217 //! of the interactive object have changed. The method unhilights
218 //! and removes outdated entity owners from lists of selected
219 //! and detected owners.
220 //! @param theIO [in] the interactive object.
221 //! @param toClearDeactivated [in] pass TRUE to treat deactivated
222 //! entity owners as 'outdated' when clearing the selection.
223 Standard_EXPORT void ClearOutdatedSelection (const Handle(AIS_InteractiveObject)& theIO, const Standard_Boolean toClearDeactivated);
225 Standard_Boolean HasDetected() const;
228 //! Initialization for iteration through mouse-detected objects in local context.
229 Standard_EXPORT void InitDetected();
232 //! @return true if there is more mouse-detected objects after the current one
233 //! during iteration through mouse-detected interactive objects.
234 Standard_EXPORT Standard_Boolean MoreDetected() const;
237 //! Gets next current object during iteration through mouse-detected
238 //! interactive objects.
239 Standard_EXPORT void NextDetected();
242 //! @return current mouse-detected shape or empty (null) shape, if current interactive object
243 //! is not a shape (AIS_Shape) or there is no current mouse-detected interactive object at all.
244 Standard_EXPORT const TopoDS_Shape& DetectedCurrentShape() const;
247 //! @return current mouse-detected interactive object or null object if there is no current detected.
248 Standard_EXPORT Handle(AIS_InteractiveObject) DetectedCurrentObject() const;
250 Standard_EXPORT Standard_Boolean HasDetectedShape() const;
252 Standard_EXPORT const TopoDS_Shape& DetectedShape() const;
254 Standard_EXPORT Handle(AIS_InteractiveObject) DetectedInteractive() const;
256 Standard_EXPORT Handle(SelectMgr_EntityOwner) DetectedOwner() const;
258 Standard_EXPORT void InitSelected();
260 Standard_EXPORT Standard_Boolean MoreSelected() const;
262 Standard_EXPORT void NextSelected();
264 //! returns TRUE if the detected entity is a shape
265 //! coming from a Decomposition of an element.
266 Standard_EXPORT Standard_Boolean HasShape() const;
268 //! returns true if current selection is not empty
269 //! and the owner of selected object contains a shape.
270 //! This method does not take into account decomposition
271 //! status of detected shape.
272 Standard_EXPORT Standard_Boolean HasSelectedShape() const;
274 Standard_EXPORT TopoDS_Shape SelectedShape() const;
276 Standard_EXPORT Handle(SelectMgr_EntityOwner) SelectedOwner() const;
278 Standard_EXPORT Standard_Boolean IsSelected (const Handle(AIS_InteractiveObject)& aniobj) const;
280 Standard_EXPORT Standard_Boolean IsSelected (const Handle(SelectMgr_EntityOwner)& anOwner) const;
282 Standard_EXPORT Handle(AIS_InteractiveObject) SelectedInteractive() const;
284 //! returns TRUE if an interactive element
285 //! was associated with the current picked entity.
286 Standard_EXPORT Standard_Boolean HasApplicative() const;
288 Standard_EXPORT const Handle(Standard_Transient)& SelectedApplicative() const;
290 Standard_EXPORT void SetDisplayPriority (const Handle(AIS_InteractiveObject)& anObject, const Standard_Integer Prior);
292 Standard_EXPORT Standard_Integer DisplayedObjects (TColStd_MapOfTransient& theMapToFill) const;
294 Standard_EXPORT Standard_Boolean IsIn (const Handle(AIS_InteractiveObject)& anObject) const;
296 Standard_EXPORT Standard_Boolean IsDisplayed (const Handle(AIS_InteractiveObject)& anObject) const;
298 Standard_EXPORT Standard_Boolean IsDisplayed (const Handle(AIS_InteractiveObject)& anObject, const Standard_Integer aMode) const;
300 Standard_EXPORT const TColStd_ListOfInteger& SelectionModes (const Handle(AIS_InteractiveObject)& anObject) const;
302 Standard_EXPORT void SubIntensityOn (const Handle(AIS_InteractiveObject)& anObject);
304 Standard_EXPORT void SubIntensityOff (const Handle(AIS_InteractiveObject)& anObject);
306 Standard_EXPORT void Hilight (const Handle(AIS_InteractiveObject)& anObject);
308 Standard_EXPORT void Hilight (const Handle(AIS_InteractiveObject)& theObj,
309 const Handle(Prs3d_Drawer)& theStyle);
311 Standard_EXPORT void Unhilight (const Handle(AIS_InteractiveObject)& anObject);
313 Standard_EXPORT Standard_Boolean IsHilighted (const Handle(AIS_InteractiveObject)& anObject) const;
315 Standard_EXPORT Standard_Boolean HighlightStyle (const Handle(AIS_InteractiveObject)& theObject,
316 Handle(Prs3d_Drawer)& theStyle) const;
318 //! Define the current selection sensitivity for
319 //! this local context according to the view size.
320 Standard_EXPORT void SetPixelTolerance (const Standard_Integer aPrecision = 2);
322 //! Returns the pixel tolerance.
323 Standard_EXPORT Standard_Integer PixelTolerance() const;
325 //! Allows to manage sensitivity of a particular selection of interactive object theObject
326 //! and changes previous sensitivity value of all sensitive entities in selection with theMode
327 //! to the given theNewSensitivity.
328 Standard_EXPORT void SetSelectionSensitivity (const Handle(AIS_InteractiveObject)& theObject,
329 const Standard_Integer theMode,
330 const Standard_Integer theNewSensitivity);
332 //! Resets the transient list of presentations previously displayed in immediate mode
333 //! and begins accumulation of new list by following AddToImmediateList()/Color()/Highlight() calls.
334 Standard_EXPORT Standard_Boolean BeginImmediateDraw();
336 //! Resets the transient list of presentations previously displayed in immediate mode.
337 Standard_EXPORT virtual void ClearImmediateDraw();
339 //! Stores presentation theMode of object theObj in the transient list of presentations to be displayed in immediate mode.
340 //! Will be taken in account in EndImmediateDraw method.
341 Standard_EXPORT Standard_Boolean ImmediateAdd (const Handle(AIS_InteractiveObject)& theObj, const Standard_Integer theMode = 0);
343 //! Allows rapid drawing of the view theView by avoiding an update of the whole background.
344 Standard_EXPORT Standard_Boolean EndImmediateDraw (const Handle(V3d_Viewer)& theViewer);
346 //! Returns true if Presentation Manager is accumulating transient list of presentations to be displayed in immediate mode.
347 Standard_EXPORT Standard_Boolean IsImmediateModeOn() const;
349 Standard_EXPORT TCollection_AsciiString Status() const;
351 Standard_EXPORT const Handle(AIS_LocalStatus)& Status (const Handle(AIS_InteractiveObject)& anObject) const;
353 Standard_EXPORT void LoadContextObjects();
355 Standard_EXPORT void UnloadContextObjects();
357 Standard_EXPORT void DisplaySensitive (const Handle(V3d_View)& aView);
359 Standard_EXPORT void ClearSensitive (const Handle(V3d_View)& aView);
361 const Handle(StdSelect_ViewerSelector3d)& MainSelector() const;
363 Standard_EXPORT Handle(SelectMgr_EntityOwner) FindSelectedOwnerFromIO (const Handle(AIS_InteractiveObject)& anIObj) const;
365 Standard_EXPORT Handle(SelectMgr_EntityOwner) FindSelectedOwnerFromShape (const TopoDS_Shape& aShape) const;
367 //! Iterates through all interactive objects of local context and activates selection modes
368 //! stored in local status
369 Standard_EXPORT void RestoreActivatedModes() const;
371 DEFINE_STANDARD_RTTIEXT(AIS_LocalContext,Standard_Transient)
376 Standard_EXPORT void Process (const Handle(SelectMgr_SelectableObject)& anObject);
378 Standard_EXPORT void Process();
380 Standard_EXPORT void ActivateStandardModes (const Handle(SelectMgr_SelectableObject)& anObject);
382 Standard_EXPORT void manageDetected (const Handle(SelectMgr_EntityOwner)& thePickOwner, const Handle(V3d_View)& theView, const Standard_Boolean theToRedrawImmediate);
384 //! returns 0 if the detected entity was Not FilterOK...
385 Standard_Integer DetectedIndex();
387 Standard_EXPORT void Hilight (const Handle(SelectMgr_EntityOwner)& Own, const Handle(V3d_View)& aview);
389 Standard_EXPORT void Unhilight (const Handle(SelectMgr_EntityOwner)& Ownr, const Handle(V3d_View)& aview);
391 Standard_EXPORT void ClearObjects();
393 Standard_EXPORT void ClearDetected();
395 Standard_EXPORT Standard_Boolean IsDecompositionOn() const;
397 Standard_EXPORT Standard_Boolean IsShape (const Standard_Integer anIndex) const;
399 Standard_EXPORT Standard_Boolean IsValidForSelection (const Handle(AIS_InteractiveObject)& anIObj) const;
401 Standard_Boolean IsValidIndex (const Standard_Integer anIndex) const;
403 Standard_EXPORT Standard_Boolean ComesFromDecomposition (const Standard_Integer aPickedIndex) const;
405 Standard_EXPORT Standard_Boolean HasFilters (const TopAbs_ShapeEnum aType) const;
407 Handle(AIS_InteractiveContext) myCTX;
408 Standard_Boolean myLoadDisplayed;
409 Standard_Boolean myAcceptStdMode;
410 Standard_Boolean myAcceptErase;
411 Handle(SelectMgr_SelectionManager) mySM;
412 Handle(StdSelect_ViewerSelector3d) myMainVS;
413 Handle(PrsMgr_PresentationManager3d) myMainPM;
414 Handle(StdSelect_ViewerSelector3d) myCollVS;
415 AIS_DataMapOfSelStat myActiveObjects;
416 Handle(SelectMgr_OrFilter) myFilters;
417 TColStd_ListOfInteger myListOfStandardMode;
418 Handle(SelectMgr_Filter) myStdFilters[9];
419 Standard_Boolean myAutoHilight;
420 Handle(SelectMgr_IndexedMapOfOwner) myMapOfOwner;
421 Handle(AIS_Selection) mySelection;
422 Standard_Integer mylastindex;
423 Standard_Integer mylastgood;
424 Standard_Integer myCurrentOwner;
425 TColStd_SequenceOfInteger myDetectedSeq;
426 Standard_Integer myCurDetected;
427 AIS_SequenceOfInteractive myAISDetectedSeq;
428 Standard_Integer myAISCurDetected;
429 Handle(Prs3d_Drawer) mySubintStyle;
434 #include <AIS_LocalContext.lxx>
440 #endif // _AIS_LocalContext_HeaderFile