0027285: Visualization - selection of AIS_MultipleConnectedInteractive is broken
[occt.git] / src / SelectMgr / SelectMgr_SelectableObject.hxx
1 // Created on: 1995-02-20
2 // Created by: Mister rmi
3 // Copyright (c) 1995-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 _SelectMgr_SelectableObject_HeaderFile
18 #define _SelectMgr_SelectableObject_HeaderFile
19
20 #include <Standard.hxx>
21 #include <Standard_Type.hxx>
22
23 #include <SelectMgr_SequenceOfSelection.hxx>
24 #include <Prs3d_Drawer.hxx>
25 #include <Standard_Integer.hxx>
26 #include <Standard_Boolean.hxx>
27 #include <PrsMgr_PresentableObject.hxx>
28 #include <PrsMgr_TypeOfPresentation3d.hxx>
29 #include <SelectMgr_Selection.hxx>
30 #include <PrsMgr_PresentationManager3d.hxx>
31 #include <SelectMgr_SequenceOfOwner.hxx>
32 #include <Quantity_NameOfColor.hxx>
33 #include <Graphic3d_ZLayerId.hxx>
34 #include <SelectMgr_IndexedMapOfOwner.hxx>
35 class SelectMgr_EntityOwner;
36 class Prs3d_Presentation;
37 class Standard_NotImplemented;
38 class SelectMgr_SelectionManager;
39 class Bnd_Box;
40
41
42 class SelectMgr_SelectableObject;
43 DEFINE_STANDARD_HANDLE(SelectMgr_SelectableObject, PrsMgr_PresentableObject)
44
45 //! A framework to supply the structure of the object to be
46 //! selected. At the first pick, this structure is created by
47 //! calling the appropriate algorithm and retaining this
48 //! framework for further picking.
49 //! This abstract framework is inherited in Application
50 //! Interactive Services (AIS), notably in AIS_InteractiveObject.
51 //! Consequently, 3D selection should be handled by the
52 //! relevant daughter classes and their member functions
53 //! in AIS. This is particularly true in the creation of new interactive objects.
54 class SelectMgr_SelectableObject : public PrsMgr_PresentableObject
55 {
56
57 public:
58
59   
60   //! Recovers and calculates any sensitive primitive,
61   //! aSelection, available in Shape mode, specified by
62   //! aMode. As a rule, these are sensitive faces.
63   //! This method is defined as virtual. This enables you to
64   //! implement it in the creation of a new class of AIS
65   //! Interactive Object. You need to do this and in so
66   //! doing, redefine this method, if you create a class
67   //! which enriches the list of signatures and types.
68   Standard_EXPORT virtual void ComputeSelection (const Handle(SelectMgr_Selection)& aSelection, const Standard_Integer aMode) = 0;
69   
70   //! Re-computes the sensitive primitives for all modes. IMPORTANT: Do not use
71   //! this method to update selection primitives except implementing custom selection manager!
72   //! This method does not take into account necessary BVH updates, but may invalidate the pointers
73   //! it refers to. TO UPDATE SELECTION properly from outside classes, use method UpdateSelection.
74   Standard_EXPORT void RecomputePrimitives();
75   
76   //! Re-computes the sensitive primitives which correspond to the <theMode>th selection mode.
77   //! IMPORTANT: Do not use this method to update selection primitives except implementing custom selection manager!
78   //! selection manager! This method does not take into account necessary BVH updates, but may invalidate
79   //! the pointers it refers to. TO UPDATE SELECTION properly from outside classes, use method UpdateSelection.
80   Standard_EXPORT void RecomputePrimitives (const Standard_Integer theMode);
81   
82   //! Adds the selection aSelection with the selection mode
83   //! index aMode to this framework.
84   Standard_EXPORT void AddSelection (const Handle(SelectMgr_Selection)& aSelection, const Standard_Integer aMode);
85   
86   //! Empties all the selections in the SelectableObject
87   //! <update> parameter defines whether all object's
88   //! selections should be flagged for further update or not.
89   //! This improved method can be used to recompute an
90   //! object's selection (without redisplaying the object
91   //! completely) when some selection mode is activated not for the first time.
92   Standard_EXPORT void ClearSelections (const Standard_Boolean update = Standard_False);
93   
94   //! Returns the selection Selection having the selection mode aMode.
95   Standard_EXPORT const Handle(SelectMgr_Selection)& Selection (const Standard_Integer aMode) const;
96   
97   //! Returns true if a selection corresponding to the
98   //! selection mode theMode was computed for this object.
99   Standard_EXPORT virtual Standard_Boolean HasSelection (const Standard_Integer theMode) const;
100   
101   //! Begins the iteration scanning for sensitive primitives.
102     void Init();
103   
104   //! Continues the iteration scanning for sensitive primitives.
105     Standard_Boolean More() const;
106   
107   //! Continues the iteration scanning for sensitive primitives.
108     void Next();
109   
110   //! Returns the current selection in this framework.
111     const Handle(SelectMgr_Selection)& CurrentSelection() const;
112   
113   Standard_EXPORT void ResetTransformation() Standard_OVERRIDE;
114   
115   //! Recomputes the location of the selection aSelection.
116   Standard_EXPORT virtual void UpdateTransformation() Standard_OVERRIDE;
117   
118   //! Updates locations in all sensitive entities from <aSelection>
119   //! and in corresponding entity owners.
120   Standard_EXPORT virtual void UpdateTransformations (const Handle(SelectMgr_Selection)& aSelection);
121   
122   //! Method which draws selected owners ( for fast presentation draw )
123   Standard_EXPORT virtual void HilightSelected (const Handle(PrsMgr_PresentationManager3d)& PM, const SelectMgr_SequenceOfOwner& Seq);
124   
125   //! Method which clear all selected owners belonging
126   //! to this selectable object ( for fast presentation draw )
127   Standard_EXPORT virtual void ClearSelected();
128   
129   //! Method which hilight an owner belonging to
130   //! this selectable object  ( for fast presentation draw )
131   Standard_EXPORT virtual void HilightOwnerWithColor (const Handle(PrsMgr_PresentationManager3d)& thePM, const Quantity_NameOfColor theColor, const Handle(SelectMgr_EntityOwner)& theOwner);
132   
133   //! If returns True, the old mechanism for highlighting
134   //! selected objects is used (HilightSelected Method may be empty).
135   //! If returns False, the HilightSelected method will be
136   //! fully responsible for highlighting selected entity
137   //! owners belonging to this selectable object.
138   Standard_EXPORT virtual Standard_Boolean IsAutoHilight() const;
139   
140   //! Set AutoHilight property to true or false
141   //! Sets  up  Transform  Persistence Mode  for  this  object
142   Standard_EXPORT virtual void SetAutoHilight (const Standard_Boolean newAutoHilight);
143   
144   Standard_EXPORT Handle(Prs3d_Presentation) GetHilightPresentation (const Handle(PrsMgr_PresentationManager3d)& TheMgr);
145   
146   Standard_EXPORT Handle(Prs3d_Presentation) GetSelectPresentation (const Handle(PrsMgr_PresentationManager3d)& TheMgr);
147   
148   //! Set Z layer ID and update all presentations of the selectable object.
149   //! The layers mechanism allows drawing objects in higher layers in overlay of objects in lower layers.
150   Standard_EXPORT virtual void SetZLayer (const Graphic3d_ZLayerId theLayerId) Standard_OVERRIDE;
151   
152   //! Sets update status FULL to selections of the object. Must be used as the only method of UpdateSelection
153   //! from outer classes to prevent BVH structures from being outdated.
154   Standard_EXPORT void UpdateSelection (const Standard_Integer theMode = -1);
155   
156   //! Returns bounding box of selectable object
157   //! by storing its minimum and maximum 3d coordinates
158   //! to output parameters
159   Standard_EXPORT virtual void BoundingBox (Bnd_Box& theBndBox) = 0;
160   
161   //! Initializes the drawing tool theDrawer.
162   Standard_EXPORT virtual void SetAttributes (const Handle(Prs3d_Drawer)& theDrawer);
163   
164   //! Returns the attributes settings.
165     const Handle(Prs3d_Drawer)& Attributes() const;
166   
167   //! Clears settings provided by the drawing tool theDrawer.
168   Standard_EXPORT virtual void UnsetAttributes();
169   
170   //! Initializes the hilight drawing tool theDrawer.
171   Standard_EXPORT virtual void SetHilightAttributes (const Handle(Prs3d_Drawer)& theDrawer);
172   
173   //! Returns the hilight attributes settings.
174     const Handle(Prs3d_Drawer)& HilightAttributes() const;
175   
176   //! Clears settings provided by the hilight drawing tool theDrawer.
177   Standard_EXPORT virtual void UnsetHilightAttributes();
178   
179   //! Initializes theDrawer by default hilight settings.
180   Standard_EXPORT static void InitDefaultHilightAttributes (const Handle(Prs3d_Drawer)& theDrawer);
181   
182   //! Sets common entity owner for assembly sensitive object entities
183   Standard_EXPORT void SetAssemblyOwner (const Handle(SelectMgr_EntityOwner)& theOwner, const Standard_Integer theMode = -1);
184   
185   //! Returns common entity owner if the object is an assembly
186   Standard_EXPORT const Handle(SelectMgr_EntityOwner)& GetAssemblyOwner() const;
187   
188   //! Returns a bounding box of sensitive entities with the owners given
189   //! if they are a part of activated selection
190   Standard_EXPORT Bnd_Box BndBoxOfSelected (Handle(SelectMgr_IndexedMapOfOwner)& theOwners);
191
192   //! Returns the mode for selection of object as a whole
193   inline Standard_Integer GlobalSelectionMode() const;
194
195   //! Returns the owner of mode for selection of object as a whole
196   Standard_EXPORT virtual Handle(SelectMgr_EntityOwner) GlobalSelOwner() const;
197
198
199 friend class SelectMgr_SelectionManager;
200
201
202   DEFINE_STANDARD_RTTIEXT(SelectMgr_SelectableObject,PrsMgr_PresentableObject)
203
204 protected:
205
206   
207   Standard_EXPORT SelectMgr_SelectableObject(const PrsMgr_TypeOfPresentation3d aTypeOfPresentation3d = PrsMgr_TOP_AllView);
208
209   inline void setGlobalSelMode (const Standard_Integer theMode);
210
211   SelectMgr_SequenceOfSelection myselections;
212   Handle(Prs3d_Drawer) myDrawer;
213   Handle(Prs3d_Drawer) myHilightDrawer;
214   Handle(SelectMgr_EntityOwner) myAssemblyOwner;
215
216
217 private:
218
219
220   Standard_Integer mycurrent;
221   Standard_Boolean myAutoHilight;
222   Handle(Prs3d_Presentation) mySelectionPrs;
223   Handle(Prs3d_Presentation) myHilightPrs;
224   Standard_Integer myGlobalSelMode;
225
226
227 };
228
229
230 #include <SelectMgr_SelectableObject.lxx>
231
232
233
234
235
236 #endif // _SelectMgr_SelectableObject_HeaderFile