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 <MMgt_TShared.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 class AIS_InteractiveContext;
44 class SelectMgr_SelectionManager;
45 class SelectMgr_OrFilter;
46 class SelectMgr_Filter;
47 class TCollection_AsciiString;
48 class AIS_InteractiveObject;
52 class SelectMgr_EntityOwner;
53 class Standard_Transient;
54 class AIS_LocalStatus;
55 class SelectMgr_SelectableObject;
58 class AIS_LocalContext;
59 DEFINE_STANDARD_HANDLE(AIS_LocalContext, MMgt_TShared)
61 //! Defines a specific context for selection.
62 //! It becomes possible to:
63 //! + Load InteractiveObjects with a mode to be
64 //! activated + associate InteractiveObjects with a
65 //! set of temporary selectable Objects.... + +
66 //! activate StandardMode of selection for Entities
67 //! inheriting BasicShape from AIS (Selection Of
68 //! vertices, edges, wires,faces... + Add Filters
69 //! acting on detected owners of sensitive primitives
71 //! - automatically highlight shapes and
72 //! InteractiveObjects (highlight of detected shape +
73 //! highlight of detected selectable...
74 class AIS_LocalContext : public MMgt_TShared
80 Standard_EXPORT AIS_LocalContext();
82 //! Constructor By Default, the displayed objects are
83 //! automatically loaded.
84 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);
86 //! authorize or not others contexts to erase
87 //! temporary displayed objects here;
88 void AcceptErase (const Standard_Boolean aStatus);
90 Standard_Boolean AcceptErase() const;
92 Standard_EXPORT void SetContext (const Handle(AIS_InteractiveContext)& aCtx);
94 const TCollection_AsciiString& SelectionName() const;
96 Standard_EXPORT void Terminate (const Standard_Boolean updateviewer = Standard_True);
98 //! to be called when a upper local context was closed...
99 //! useful to put pack the right projector...
100 Standard_EXPORT void Reactivate();
102 //! returns true if done...
103 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);
105 //! loads <anInteractive> with nodisplay...
106 //! returns true if done
107 Standard_EXPORT Standard_Boolean Load (const Handle(AIS_InteractiveObject)& anInteractive, const Standard_Boolean AllowShapeDecomposition = Standard_True, const Standard_Integer ActivationMode = 0);
109 //! returns true if done...
110 Standard_EXPORT Standard_Boolean Erase (const Handle(AIS_InteractiveObject)& anInteractive);
112 Standard_EXPORT Standard_Boolean Remove (const Handle(AIS_InteractiveObject)& aSelectable);
114 Standard_EXPORT Standard_Boolean ClearPrs (const Handle(AIS_InteractiveObject)& anInteractive, const Standard_Integer aMode);
116 //! allows or forbids the shape decomposition into
117 //! Activated Standard Mode for <aStoredObject>
118 //! does nothing if the object doesn't inherits
119 //! BasicShape from AIS
120 Standard_EXPORT void SetShapeDecomposition (const Handle(AIS_InteractiveObject)& aStoredObject, const Standard_Boolean aStatus);
122 //! according to <atype> , clears the different parts of
123 //! the selector (filters, modeof activation, objects...)
124 Standard_EXPORT void Clear (const AIS_ClearMode atype = AIS_CM_All);
126 //! optional : activation of a mode which is not 0 for a selectable...
127 Standard_EXPORT void ActivateMode (const Handle(AIS_InteractiveObject)& aSelectable, const Standard_Integer aMode);
129 Standard_EXPORT void DeactivateMode (const Handle(AIS_InteractiveObject)& aSelectable, const Standard_Integer aMode);
131 Standard_EXPORT void Deactivate (const Handle(AIS_InteractiveObject)& aSelectable);
133 //! decomposition of shapes into <aType>
134 Standard_EXPORT void ActivateStandardMode (const TopAbs_ShapeEnum aType);
136 Standard_EXPORT void DeactivateStandardMode (const TopAbs_ShapeEnum aType);
138 const TColStd_ListOfInteger& StandardModes() const;
140 Standard_EXPORT void AddFilter (const Handle(SelectMgr_Filter)& aFilter);
142 Standard_EXPORT void RemoveFilter (const Handle(SelectMgr_Filter)& aFilter);
144 const SelectMgr_ListOfFilter& ListOfFilter() const;
146 const Handle(SelectMgr_OrFilter)& Filter() const;
148 //! if <aStatus> = True , the shapes or subshapes detected
149 //! by the selector will be automatically hilighted in the
151 //! Else the user has to manage the detected shape outside the
152 //! Shape Selector....
153 void SetAutomaticHilight (const Standard_Boolean aStatus);
155 Standard_Boolean AutomaticHilight() const;
157 Standard_EXPORT AIS_StatusOfDetection MoveTo (const Standard_Integer theXpix, const Standard_Integer theYpix, const Handle(V3d_View)& theView, const Standard_Boolean theToRedrawImmediate);
159 //! returns True if more than one entity
160 //! was detected at the last Mouse position.
161 Standard_Boolean HasNextDetected() const;
163 //! returns True if last detected. the next detected will
164 //! be first one (endless loop)
165 Standard_EXPORT Standard_Integer HilightNextDetected (const Handle(V3d_View)& theView, const Standard_Boolean theToRedrawImmediate);
167 Standard_EXPORT Standard_Integer HilightPreviousDetected (const Handle(V3d_View)& theView, const Standard_Boolean theToRedrawImmediate);
169 //! returns True if something was done...
170 Standard_EXPORT Standard_Boolean UnhilightLastDetected (const Handle(V3d_View)& aView);
172 //! returns the number of selected
173 Standard_EXPORT AIS_StatusOfPick Select (const Standard_Boolean updateviewer = Standard_True);
175 Standard_EXPORT AIS_StatusOfPick ShiftSelect (const Standard_Boolean updateviewer = Standard_True);
177 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);
179 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);
181 Standard_EXPORT AIS_StatusOfPick Select (const TColgp_Array1OfPnt2d& Polyline, const Handle(V3d_View)& aView, const Standard_Boolean updateviewer = Standard_True);
183 Standard_EXPORT AIS_StatusOfPick ShiftSelect (const TColgp_Array1OfPnt2d& Polyline, const Handle(V3d_View)& aView, const Standard_Boolean updateviewer = Standard_True);
185 Standard_EXPORT void HilightPicked (const Standard_Boolean updateviewer = Standard_True);
187 Standard_EXPORT void UnhilightPicked (const Standard_Boolean updateviewer = Standard_True);
189 Standard_EXPORT void UpdateSelected (const Standard_Boolean updateviewer = Standard_True);
191 //! Part of advanced selection highlighting mechanism.
192 //! If no owners belonging to anobj are selected, calls anobj->ClearSelected(),
193 //! otherwise calls anobj->HilightSelected(). This method can be used to avoid
194 //! redrawing the whole selection belonging to several Selectable Objects.
195 Standard_EXPORT void UpdateSelected (const Handle(AIS_InteractiveObject)& anobj, const Standard_Boolean updateviewer = Standard_True);
197 //! useful to update selection with objects coming from
198 //! Collector or stack
199 Standard_EXPORT void SetSelected (const Handle(AIS_InteractiveObject)& anobj, const Standard_Boolean updateviewer = Standard_True);
201 //! useful to update selection with objects coming from
202 //! Collector or stack
203 Standard_EXPORT void AddOrRemoveSelected (const Handle(AIS_InteractiveObject)& anobj, const Standard_Boolean updateviewer = Standard_True);
205 Standard_EXPORT void AddOrRemoveSelected (const TopoDS_Shape& aShape, const Standard_Boolean updateviewer = Standard_True);
207 Standard_EXPORT void AddOrRemoveSelected (const Handle(SelectMgr_EntityOwner)& theOwner, const Standard_Boolean toUpdateViewer = Standard_True);
209 //! Clears local context selection.
210 //! @param toUpdateViewer [in] if TRUE the viewer will be updated.
211 Standard_EXPORT void ClearSelected (const Standard_Boolean toUpdateViewer = Standard_True);
213 //! Clears outdated selection and detection of owners for the
214 //! interactive object. Use this method if selection structures
215 //! of the interactive object have changed. The method unhilights
216 //! and removes outdated entity owners from lists of selected
217 //! and detected owners.
218 //! @param theIO [in] the interactive object.
219 //! @param toClearDeactivated [in] pass TRUE to treat deactivated
220 //! entity owners as 'outdated' when clearing the selection.
221 Standard_EXPORT void ClearOutdatedSelection (const Handle(AIS_InteractiveObject)& theIO, const Standard_Boolean toClearDeactivated);
223 Standard_Boolean HasDetected() const;
226 //! Initialization for iteration through mouse-detected objects in local context.
227 Standard_EXPORT void InitDetected();
230 //! @return true if there is more mouse-detected objects after the current one
231 //! during iteration through mouse-detected interactive objects.
232 Standard_EXPORT Standard_Boolean MoreDetected() const;
235 //! Gets next current object during iteration through mouse-detected
236 //! interactive objects.
237 Standard_EXPORT void NextDetected();
240 //! @return current mouse-detected shape or empty (null) shape, if current interactive object
241 //! is not a shape (AIS_Shape) or there is no current mouse-detected interactive object at all.
242 Standard_EXPORT const TopoDS_Shape& DetectedCurrentShape() const;
245 //! @return current mouse-detected interactive object or null object if there is no current detected.
246 Standard_EXPORT Handle(AIS_InteractiveObject) DetectedCurrentObject() const;
248 Standard_EXPORT Standard_Boolean HasDetectedShape() const;
250 Standard_EXPORT const TopoDS_Shape& DetectedShape() const;
252 Standard_EXPORT Handle(AIS_InteractiveObject) DetectedInteractive() const;
254 Standard_EXPORT Handle(SelectMgr_EntityOwner) DetectedOwner() const;
256 Standard_EXPORT void InitSelected();
258 Standard_EXPORT Standard_Boolean MoreSelected() const;
260 Standard_EXPORT void NextSelected();
262 //! returns TRUE if the detected entity is a shape
263 //! coming from a Decomposition of an element.
264 Standard_EXPORT Standard_Boolean HasShape() const;
266 //! returns true if current selection is not empty
267 //! and the owner of selected object contains a shape.
268 //! This method does not take into account decomposition
269 //! status of detected shape.
270 Standard_EXPORT Standard_Boolean HasSelectedShape() const;
272 Standard_EXPORT TopoDS_Shape SelectedShape() const;
274 Standard_EXPORT Handle(SelectMgr_EntityOwner) SelectedOwner() const;
276 Standard_EXPORT Standard_Boolean IsSelected (const Handle(AIS_InteractiveObject)& aniobj) const;
278 Standard_EXPORT Standard_Boolean IsSelected (const Handle(SelectMgr_EntityOwner)& anOwner) const;
280 Standard_EXPORT Handle(AIS_InteractiveObject) SelectedInteractive() const;
282 //! returns TRUE if an interactive element
283 //! was associated with the current picked entity.
284 Standard_EXPORT Standard_Boolean HasApplicative() const;
286 Standard_EXPORT const Handle(Standard_Transient)& SelectedApplicative() const;
288 Standard_EXPORT void SetDisplayPriority (const Handle(AIS_InteractiveObject)& anObject, const Standard_Integer Prior);
290 Standard_EXPORT Standard_Integer DisplayedObjects (TColStd_MapOfTransient& theMapToFill) const;
292 Standard_EXPORT Standard_Boolean IsIn (const Handle(AIS_InteractiveObject)& anObject) const;
294 Standard_EXPORT Standard_Boolean IsDisplayed (const Handle(AIS_InteractiveObject)& anObject) const;
296 Standard_EXPORT Standard_Boolean IsDisplayed (const Handle(AIS_InteractiveObject)& anObject, const Standard_Integer aMode) const;
298 Standard_EXPORT const TColStd_ListOfInteger& SelectionModes (const Handle(AIS_InteractiveObject)& anObject) const;
300 Standard_EXPORT void SubIntensityOn (const Handle(AIS_InteractiveObject)& anObject);
302 Standard_EXPORT void SubIntensityOff (const Handle(AIS_InteractiveObject)& anObject);
304 Standard_EXPORT void Hilight (const Handle(AIS_InteractiveObject)& anObject);
306 Standard_EXPORT void Hilight (const Handle(AIS_InteractiveObject)& anObject, const Quantity_NameOfColor aCol);
308 Standard_EXPORT void Unhilight (const Handle(AIS_InteractiveObject)& anObject);
310 Standard_EXPORT Standard_Boolean IsHilighted (const Handle(AIS_InteractiveObject)& anObject) const;
312 Standard_EXPORT Standard_Boolean IsHilighted (const Handle(AIS_InteractiveObject)& anObject, Standard_Boolean& WithColor, Quantity_NameOfColor& HiCol) const;
314 //! Define the current selection sensitivity for
315 //! this local context according to the view size.
316 Standard_EXPORT void SetPixelTolerance (const Standard_Real aPrecision = 2);
318 //! Returns the pixel tolerance.
319 Standard_EXPORT Standard_Real PixelTolerance() const;
321 //! Resets the transient list of presentations previously displayed in immediate mode
322 //! and begins accumulation of new list by following AddToImmediateList()/Color()/Highlight() calls.
323 Standard_EXPORT Standard_Boolean BeginImmediateDraw();
325 //! Resets the transient list of presentations previously displayed in immediate mode.
326 Standard_EXPORT virtual void ClearImmediateDraw();
328 //! Stores presentation theMode of object theObj in the transient list of presentations to be displayed in immediate mode.
329 //! Will be taken in account in EndImmediateDraw method.
330 Standard_EXPORT Standard_Boolean ImmediateAdd (const Handle(AIS_InteractiveObject)& theObj, const Standard_Integer theMode = 0);
332 //! Allows rapid drawing of the view theView by avoiding an update of the whole background.
333 Standard_EXPORT Standard_Boolean EndImmediateDraw (const Handle(V3d_Viewer)& theViewer);
335 //! Returns true if Presentation Manager is accumulating transient list of presentations to be displayed in immediate mode.
336 Standard_EXPORT Standard_Boolean IsImmediateModeOn() const;
338 Standard_EXPORT TCollection_AsciiString Status() const;
340 Standard_EXPORT const Handle(AIS_LocalStatus)& Status (const Handle(AIS_InteractiveObject)& anObject) const;
342 Standard_EXPORT void LoadContextObjects();
344 Standard_EXPORT void UnloadContextObjects();
346 Standard_EXPORT void DisplaySensitive (const Handle(V3d_View)& aView);
348 Standard_EXPORT void ClearSensitive (const Handle(V3d_View)& aView);
350 const Handle(StdSelect_ViewerSelector3d)& MainSelector() const;
352 Standard_EXPORT Handle(SelectMgr_EntityOwner) FindSelectedOwnerFromIO (const Handle(AIS_InteractiveObject)& anIObj) const;
354 Standard_EXPORT Handle(SelectMgr_EntityOwner) FindSelectedOwnerFromShape (const TopoDS_Shape& aShape) const;
359 DEFINE_STANDARD_RTTI(AIS_LocalContext,MMgt_TShared)
369 Standard_EXPORT void Process (const Handle(SelectMgr_SelectableObject)& anObject);
371 Standard_EXPORT void Process();
373 Standard_EXPORT void ActivateStandardModes (const Handle(SelectMgr_SelectableObject)& anObject);
375 Standard_EXPORT void manageDetected (const Handle(SelectMgr_EntityOwner)& thePickOwner, const Handle(V3d_View)& theView, const Standard_Boolean theToRedrawImmediate);
377 //! returns 0 if the detected entity was Not FilterOK...
378 Standard_Integer DetectedIndex();
380 Standard_EXPORT void Hilight (const Handle(SelectMgr_EntityOwner)& Own, const Handle(V3d_View)& aview);
382 Standard_EXPORT void Unhilight (const Handle(SelectMgr_EntityOwner)& Ownr, const Handle(V3d_View)& aview);
384 Standard_EXPORT void ClearObjects();
386 Standard_EXPORT void ClearDetected();
388 Standard_EXPORT Standard_Boolean IsDecompositionOn() const;
390 Standard_EXPORT Standard_Boolean IsShape (const Standard_Integer anIndex) const;
392 Standard_EXPORT Standard_Boolean IsValidForSelection (const Handle(AIS_InteractiveObject)& anIObj) const;
394 Standard_Boolean IsValidIndex (const Standard_Integer anIndex) const;
396 Standard_EXPORT Standard_Boolean ComesFromDecomposition (const Standard_Integer aPickedIndex) const;
398 Standard_EXPORT Standard_Boolean HasFilters (const TopAbs_ShapeEnum aType) const;
400 Handle(AIS_InteractiveContext) myCTX;
401 Standard_Boolean myLoadDisplayed;
402 Standard_Boolean myAcceptStdMode;
403 Standard_Boolean myAcceptErase;
404 Handle(SelectMgr_SelectionManager) mySM;
405 Handle(StdSelect_ViewerSelector3d) myMainVS;
406 Handle(PrsMgr_PresentationManager3d) myMainPM;
407 TCollection_AsciiString mySelName;
408 Handle(StdSelect_ViewerSelector3d) myCollVS;
409 AIS_DataMapOfSelStat myActiveObjects;
410 Handle(SelectMgr_OrFilter) myFilters;
411 TColStd_ListOfInteger myListOfStandardMode;
412 Handle(SelectMgr_Filter) myStdFilters[9];
413 Standard_Boolean myAutoHilight;
414 Handle(SelectMgr_IndexedMapOfOwner) myMapOfOwner;
415 Standard_Integer mylastindex;
416 Standard_Integer mylastgood;
417 Standard_Integer myCurrentOwner;
418 TColStd_SequenceOfInteger myDetectedSeq;
419 Standard_Integer myCurDetected;
420 AIS_SequenceOfInteractive myAISDetectedSeq;
421 Standard_Integer myAISCurDetected;
427 #include <AIS_LocalContext.lxx>
433 #endif // _AIS_LocalContext_HeaderFile