| 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 | //! Clears all selections of the object |
| 60 | Standard_EXPORT virtual ~SelectMgr_SelectableObject(); |
| 61 | |
| 62 | //! Recovers and calculates any sensitive primitive, |
| 63 | //! aSelection, available in Shape mode, specified by |
| 64 | //! aMode. As a rule, these are sensitive faces. |
| 65 | //! This method is defined as virtual. This enables you to |
| 66 | //! implement it in the creation of a new class of AIS |
| 67 | //! Interactive Object. You need to do this and in so |
| 68 | //! doing, redefine this method, if you create a class |
| 69 | //! which enriches the list of signatures and types. |
| 70 | Standard_EXPORT virtual void ComputeSelection (const Handle(SelectMgr_Selection)& aSelection, const Standard_Integer aMode) = 0; |
| 71 | |
| 72 | //! Re-computes the sensitive primitives for all modes. IMPORTANT: Do not use |
| 73 | //! this method to update selection primitives except implementing custom selection manager! |
| 74 | //! This method does not take into account necessary BVH updates, but may invalidate the pointers |
| 75 | //! it refers to. TO UPDATE SELECTION properly from outside classes, use method UpdateSelection. |
| 76 | Standard_EXPORT void RecomputePrimitives(); |
| 77 | |
| 78 | //! Re-computes the sensitive primitives which correspond to the <theMode>th selection mode. |
| 79 | //! IMPORTANT: Do not use this method to update selection primitives except implementing custom selection manager! |
| 80 | //! selection manager! This method does not take into account necessary BVH updates, but may invalidate |
| 81 | //! the pointers it refers to. TO UPDATE SELECTION properly from outside classes, use method UpdateSelection. |
| 82 | Standard_EXPORT void RecomputePrimitives (const Standard_Integer theMode); |
| 83 | |
| 84 | //! Adds the selection aSelection with the selection mode |
| 85 | //! index aMode to this framework. |
| 86 | Standard_EXPORT void AddSelection (const Handle(SelectMgr_Selection)& aSelection, const Standard_Integer aMode); |
| 87 | |
| 88 | //! Empties all the selections in the SelectableObject |
| 89 | //! <update> parameter defines whether all object's |
| 90 | //! selections should be flagged for further update or not. |
| 91 | //! This improved method can be used to recompute an |
| 92 | //! object's selection (without redisplaying the object |
| 93 | //! completely) when some selection mode is activated not for the first time. |
| 94 | Standard_EXPORT void ClearSelections (const Standard_Boolean update = Standard_False); |
| 95 | |
| 96 | //! Returns the selection Selection having the selection mode aMode. |
| 97 | Standard_EXPORT const Handle(SelectMgr_Selection)& Selection (const Standard_Integer aMode) const; |
| 98 | |
| 99 | //! Returns true if a selection corresponding to the |
| 100 | //! selection mode theMode was computed for this object. |
| 101 | Standard_EXPORT virtual Standard_Boolean HasSelection (const Standard_Integer theMode) const; |
| 102 | |
| 103 | //! Begins the iteration scanning for sensitive primitives. |
| 104 | void Init() |
| 105 | { |
| 106 | mycurrent = 1; |
| 107 | } |
| 108 | |
| 109 | //! Continues the iteration scanning for sensitive primitives. |
| 110 | Standard_Boolean More() const |
| 111 | { |
| 112 | return mycurrent <= myselections.Length(); |
| 113 | } |
| 114 | |
| 115 | //! Continues the iteration scanning for sensitive primitives. |
| 116 | void Next() |
| 117 | { |
| 118 | mycurrent++; |
| 119 | } |
| 120 | |
| 121 | //! Returns the current selection in this framework. |
| 122 | const Handle(SelectMgr_Selection)& CurrentSelection() const |
| 123 | { |
| 124 | return myselections (mycurrent); |
| 125 | } |
| 126 | |
| 127 | Standard_EXPORT void ResetTransformation() Standard_OVERRIDE; |
| 128 | |
| 129 | //! Recomputes the location of the selection aSelection. |
| 130 | Standard_EXPORT virtual void UpdateTransformation() Standard_OVERRIDE; |
| 131 | |
| 132 | //! Updates locations in all sensitive entities from <aSelection> |
| 133 | //! and in corresponding entity owners. |
| 134 | Standard_EXPORT virtual void UpdateTransformations (const Handle(SelectMgr_Selection)& aSelection); |
| 135 | |
| 136 | //! Method which draws selected owners ( for fast presentation draw ) |
| 137 | Standard_EXPORT virtual void HilightSelected (const Handle(PrsMgr_PresentationManager3d)& PM, const SelectMgr_SequenceOfOwner& Seq); |
| 138 | |
| 139 | //! Method which clear all selected owners belonging |
| 140 | //! to this selectable object ( for fast presentation draw ) |
| 141 | Standard_EXPORT virtual void ClearSelected(); |
| 142 | |
| 143 | //! Method which hilight an owner belonging to |
| 144 | //! this selectable object ( for fast presentation draw ) |
| 145 | Standard_EXPORT virtual void HilightOwnerWithColor (const Handle(PrsMgr_PresentationManager3d)& thePM, |
| 146 | const Handle(Graphic3d_HighlightStyle)& theStyle, |
| 147 | const Handle(SelectMgr_EntityOwner)& theOwner); |
| 148 | |
| 149 | //! If returns True, the old mechanism for highlighting |
| 150 | //! selected objects is used (HilightSelected Method may be empty). |
| 151 | //! If returns False, the HilightSelected method will be |
| 152 | //! fully responsible for highlighting selected entity |
| 153 | //! owners belonging to this selectable object. |
| 154 | Standard_EXPORT virtual Standard_Boolean IsAutoHilight() const; |
| 155 | |
| 156 | //! Set AutoHilight property to true or false |
| 157 | //! Sets up Transform Persistence Mode for this object |
| 158 | Standard_EXPORT virtual void SetAutoHilight (const Standard_Boolean newAutoHilight); |
| 159 | |
| 160 | Standard_EXPORT Handle(Prs3d_Presentation) GetHilightPresentation (const Handle(PrsMgr_PresentationManager3d)& TheMgr); |
| 161 | |
| 162 | Standard_EXPORT Handle(Prs3d_Presentation) GetSelectPresentation (const Handle(PrsMgr_PresentationManager3d)& TheMgr); |
| 163 | |
| 164 | //! Set Z layer ID and update all presentations of the selectable object. |
| 165 | //! The layers mechanism allows drawing objects in higher layers in overlay of objects in lower layers. |
| 166 | Standard_EXPORT virtual void SetZLayer (const Graphic3d_ZLayerId theLayerId) Standard_OVERRIDE; |
| 167 | |
| 168 | //! Sets update status FULL to selections of the object. Must be used as the only method of UpdateSelection |
| 169 | //! from outer classes to prevent BVH structures from being outdated. |
| 170 | void UpdateSelection (const Standard_Integer theMode = -1) |
| 171 | { |
| 172 | updateSelection (theMode); |
| 173 | } |
| 174 | |
| 175 | //! Returns bounding box of selectable object |
| 176 | //! by storing its minimum and maximum 3d coordinates |
| 177 | //! to output parameters |
| 178 | Standard_EXPORT virtual void BoundingBox (Bnd_Box& theBndBox) = 0; |
| 179 | |
| 180 | //! Initializes the drawing tool theDrawer. |
| 181 | Standard_EXPORT virtual void SetAttributes (const Handle(Prs3d_Drawer)& theDrawer); |
| 182 | |
| 183 | //! Returns the attributes settings. |
| 184 | const Handle(Prs3d_Drawer)& Attributes() const |
| 185 | { |
| 186 | return myDrawer; |
| 187 | } |
| 188 | |
| 189 | //! Clears settings provided by the drawing tool theDrawer. |
| 190 | Standard_EXPORT virtual void UnsetAttributes(); |
| 191 | |
| 192 | //! Initializes the hilight drawing tool theDrawer. |
| 193 | Standard_EXPORT virtual void SetHilightAttributes (const Handle(Prs3d_Drawer)& theDrawer); |
| 194 | |
| 195 | //! Returns the hilight attributes settings. |
| 196 | const Handle(Prs3d_Drawer)& HilightAttributes() const |
| 197 | { |
| 198 | return myHilightDrawer; |
| 199 | } |
| 200 | |
| 201 | //! Clears settings provided by the hilight drawing tool theDrawer. |
| 202 | Standard_EXPORT virtual void UnsetHilightAttributes(); |
| 203 | |
| 204 | //! Initializes theDrawer by default hilight settings. |
| 205 | Standard_EXPORT static void InitDefaultHilightAttributes (const Handle(Prs3d_Drawer)& theDrawer); |
| 206 | |
| 207 | //! Sets common entity owner for assembly sensitive object entities |
| 208 | Standard_EXPORT void SetAssemblyOwner (const Handle(SelectMgr_EntityOwner)& theOwner, const Standard_Integer theMode = -1); |
| 209 | |
| 210 | //! Returns common entity owner if the object is an assembly |
| 211 | Standard_EXPORT const Handle(SelectMgr_EntityOwner)& GetAssemblyOwner() const; |
| 212 | |
| 213 | //! Returns a bounding box of sensitive entities with the owners given |
| 214 | //! if they are a part of activated selection |
| 215 | Standard_EXPORT Bnd_Box BndBoxOfSelected (const Handle(SelectMgr_IndexedMapOfOwner)& theOwners); |
| 216 | |
| 217 | //! Returns the mode for selection of object as a whole |
| 218 | Standard_Integer GlobalSelectionMode() const |
| 219 | { |
| 220 | return myGlobalSelMode; |
| 221 | } |
| 222 | |
| 223 | //! Returns the owner of mode for selection of object as a whole |
| 224 | Standard_EXPORT virtual Handle(SelectMgr_EntityOwner) GlobalSelOwner() const; |
| 225 | |
| 226 | |
| 227 | friend class SelectMgr_SelectionManager; |
| 228 | |
| 229 | |
| 230 | DEFINE_STANDARD_RTTIEXT(SelectMgr_SelectableObject,PrsMgr_PresentableObject) |
| 231 | |
| 232 | protected: |
| 233 | |
| 234 | Standard_EXPORT SelectMgr_SelectableObject(const PrsMgr_TypeOfPresentation3d aTypeOfPresentation3d = PrsMgr_TOP_AllView); |
| 235 | |
| 236 | void setGlobalSelMode (const Standard_Integer theMode) |
| 237 | { |
| 238 | myGlobalSelMode = theMode > 0 ? theMode : 0; |
| 239 | } |
| 240 | |
| 241 | Standard_EXPORT virtual void updateSelection (const Standard_Integer theMode); |
| 242 | |
| 243 | protected: |
| 244 | |
| 245 | SelectMgr_SequenceOfSelection myselections; |
| 246 | Handle(Prs3d_Drawer) myDrawer; |
| 247 | Handle(Prs3d_Drawer) myHilightDrawer; |
| 248 | Handle(SelectMgr_EntityOwner) myAssemblyOwner; |
| 249 | Standard_Boolean myAutoHilight; |
| 250 | |
| 251 | private: |
| 252 | |
| 253 | Standard_Integer mycurrent; |
| 254 | Handle(Prs3d_Presentation) mySelectionPrs; |
| 255 | Handle(Prs3d_Presentation) myHilightPrs; |
| 256 | Standard_Integer myGlobalSelMode; |
| 257 | }; |
| 258 | |
| 259 | #endif // _SelectMgr_SelectableObject_HeaderFile |