0027919: Visualization - support multiple transformation persistence groups within...
[occt.git] / src / SelectMgr / SelectMgr_SensitiveEntitySet.hxx
1 // Created on: 2014-08-15
2 // Created by: Varvara POSKONINA
3 // Copyright (c) 2005-2014 OPEN CASCADE SAS
4 //
5 // This file is part of Open CASCADE Technology software library.
6 //
7 // This library is free software; you can redistribute it and/or modify it under
8 // the terms of the GNU Lesser General Public License version 2.1 as published
9 // by the Free Software Foundation, with special exception defined in the file
10 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
11 // distribution for complete text of the license and disclaimer of any warranty.
12 //
13 // Alternatively, this file may be used under the terms of Open CASCADE
14 // commercial license or contractual agreement.
15
16 #ifndef _SelectMgr_SensitiveEntitySet_HeaderFile
17 #define _SelectMgr_SensitiveEntitySet_HeaderFile
18
19 #include <BVH_PrimitiveSet3d.hxx>
20 #include <NCollection_DataMap.hxx>
21 #include <NCollection_IndexedMap.hxx>
22 #include <Select3D_BndBox3d.hxx>
23 #include <Select3D_BVHBuilder3d.hxx>
24 #include <SelectMgr_EntityOwner.hxx>
25 #include <SelectMgr_SensitiveEntity.hxx>
26 #include <SelectMgr_Selection.hxx>
27
28 typedef NCollection_IndexedMap<Handle(SelectMgr_SensitiveEntity)> SelectMgr_IndexedMapOfHSensitive;
29 typedef NCollection_DataMap<Handle(SelectMgr_EntityOwner), Standard_Integer> SelectMgr_MapOfOwners;
30
31 //! This class is used to store all calculated sensitive entities of one selectable object.
32 //! It provides an interface for building BVH tree which is used to speed-up
33 //! the performance of searching for overlap among sensitives of one selectable object
34 class SelectMgr_SensitiveEntitySet : public BVH_PrimitiveSet3d
35 {
36   DEFINE_STANDARD_RTTIEXT(SelectMgr_SensitiveEntitySet, BVH_PrimitiveSet3d)
37 public:
38
39   //! Empty constructor.
40   Standard_EXPORT SelectMgr_SensitiveEntitySet (const Handle(Select3D_BVHBuilder3d)& theBuilder);
41
42   virtual ~SelectMgr_SensitiveEntitySet() {}
43
44   //! Adds new entity to the set and marks BVH tree for rebuild
45   Standard_EXPORT void Append (const Handle(SelectMgr_SensitiveEntity)& theEntity);
46
47   //! Adds every entity of selection theSelection to the set and marks
48   //! BVH tree for rebuild
49   Standard_EXPORT void Append (const Handle(SelectMgr_Selection)& theSelection);
50
51   //! Removes every entity of selection theSelection from the set
52   //! and marks BVH tree for rebuild
53   Standard_EXPORT void Remove (const Handle(SelectMgr_Selection)& theSelection);
54
55   //! Returns bounding box of entity with index theIdx
56   Standard_EXPORT virtual Select3D_BndBox3d Box (const Standard_Integer theIndex) const Standard_OVERRIDE;
57
58   //! Make inherited method Box() visible to avoid CLang warning
59   using BVH_PrimitiveSet3d::Box;
60
61   //! Returns geometry center of sensitive entity index theIdx
62   //! along the given axis theAxis
63   Standard_EXPORT virtual Standard_Real Center (const Standard_Integer theIndex,
64                                                 const Standard_Integer theAxis) const Standard_OVERRIDE;
65
66   //! Swaps items with indexes theIdx1 and theIdx2
67   Standard_EXPORT virtual void Swap (const Standard_Integer theIndex1,
68                                      const Standard_Integer theIndex2) Standard_OVERRIDE;
69
70   //! Returns the amount of entities
71   Standard_EXPORT virtual Standard_Integer Size() const Standard_OVERRIDE;
72
73   //! Returns the entity with index theIndex in the set
74   Standard_EXPORT const Handle(SelectMgr_SensitiveEntity)& GetSensitiveById (const Standard_Integer theIndex) const;
75
76   //! Returns map of entities.
77   const SelectMgr_IndexedMapOfHSensitive& Sensitives() const { return mySensitives; }
78
79   //! Returns map of owners.
80   const SelectMgr_MapOfOwners& Owners() const { return myOwnersMap; }
81
82   //! Returns map of entities.
83   Standard_Boolean HasEntityWithPersistence() const { return myHasEntityWithPersistence; }
84
85 protected:
86
87   //! Adds entity owner to the map of owners (or increases its counter if it is already there).
88   Standard_EXPORT void addOwner (const Handle(SelectMgr_EntityOwner)& theOwner);
89
90   //! Decreases counter of owner in the map of owners (or removes it from the map if counter == 0).
91   Standard_EXPORT void removeOwner (const Handle(SelectMgr_EntityOwner)& theOwner);
92
93 private:
94
95   SelectMgr_IndexedMapOfHSensitive mySensitives; //!< Map of entities and its corresponding index in BVH
96   SelectMgr_MapOfOwners            myOwnersMap;  //!< Map of entity owners and its corresponding number of sensitives
97   Standard_Boolean  myHasEntityWithPersistence;  //!< flag if some of sensitive entity has own transform persistence
98 };
99
100 #endif // _SelectMgr_SensitiveEntitySet_HeaderFile