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