0031313: Foundation Classes - Dump improvement for classes
[occt.git] / src / Select3D / Select3D_SensitiveSet.hxx
1 // Created on: 2014-05-29
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 _Select3D_SensitiveSet_Header
17 #define _Select3D_SensitiveSet_Header
18
19 #include <BVH_PrimitiveSet3d.hxx>
20 #include <Select3D_BndBox3d.hxx>
21 #include <Select3D_BVHBuilder3d.hxx>
22 #include <Select3D_SensitiveEntity.hxx>
23
24 //! This class is base class for handling overlap detection of complex sensitive
25 //! entities. It provides an interface for building BVH tree for some set of entities.
26 //! Thereby, each iteration of overlap detection is a traverse of BVH tree in fact.
27 //! To use speed-up hierarchical structure in a custom complex sensitive entity, it is
28 //! necessary to make that custom entity a descendant of this class and organize sub-entities
29 //! in some container which allows referencing to elements by index. Note that methods taking
30 //! index as a parameter are used for BVH build and the range of given index is [0; Size() - 1].
31 //! For example of usage see Select3D_SensitiveTriangulation.
32 class Select3D_SensitiveSet : public Select3D_SensitiveEntity
33 {
34   DEFINE_STANDARD_RTTIEXT(Select3D_SensitiveSet, Select3D_SensitiveEntity)
35 public:
36
37   //! Return global instance to default BVH builder.
38   Standard_EXPORT static const Handle(Select3D_BVHBuilder3d)& DefaultBVHBuilder();
39
40   //! Assign new BVH builder to be used by default for new sensitive sets (assigning is NOT thread-safe!).
41   Standard_EXPORT static void SetDefaultBVHBuilder (const Handle(Select3D_BVHBuilder3d)& theBuilder);
42
43 public:
44
45   //! Creates new empty sensitive set and its content
46   Standard_EXPORT Select3D_SensitiveSet (const Handle(SelectMgr_EntityOwner)& theOwnerId);
47
48 public:
49
50   //! Returns the amount of sub-entities of the complex entity
51   virtual Standard_Integer Size() const = 0;
52
53   //! Returns bounding box of sub-entity with index theIdx in sub-entity list
54   virtual Select3D_BndBox3d Box (const Standard_Integer theIdx) const = 0;
55
56   //! Returns geometry center of sensitive entity index theIdx along the given axis theAxis
57   virtual Standard_Real Center (const Standard_Integer theIdx,
58                                 const Standard_Integer theAxis) const = 0;
59
60   //! Swaps items with indexes theIdx1 and theIdx2
61   virtual void Swap (const Standard_Integer theIdx1,
62                      const Standard_Integer theIdx2) = 0;
63
64   //! Checks whether one or more entities of the set overlap current selecting volume.
65   //! Implements the traverse of BVH tree built for the set
66   virtual Standard_Boolean Matches (SelectBasics_SelectingVolumeManager& theMgr,
67                                     SelectBasics_PickResult& thePickResult) Standard_OVERRIDE
68   {
69     return matches (theMgr, thePickResult, false);
70   }
71
72   //! Builds BVH tree for sensitive set.
73   //! Must be called manually to build BVH tree for any sensitive set
74   //! in case if its content was initialized not in a constructor,
75   //! but element by element
76   Standard_EXPORT virtual void BVH() Standard_OVERRIDE;
77
78   //! Sets the method (builder) used to construct BVH.
79   void SetBuilder (const Handle(Select3D_BVHBuilder3d)& theBuilder) { myContent.SetBuilder (theBuilder); }
80
81   //! Marks BVH tree of the set as outdated. It will be rebuild
82   //! at the next call of BVH()
83   void MarkDirty() { myContent.MarkDirty(); }
84
85   //! Returns bounding box of the whole set.
86   //! This method should be redefined in Select3D_SensitiveSet descendants
87   Standard_EXPORT virtual Select3D_BndBox3d BoundingBox() Standard_OVERRIDE;
88
89   //! Returns center of the whole set.
90   //! This method should be redefined in Select3D_SensitiveSet descendants
91   Standard_EXPORT virtual gp_Pnt CenterOfGeometry() const Standard_OVERRIDE;
92
93   //! Destroys cross-reference to avoid memory leak
94   Standard_EXPORT virtual void Clear() Standard_OVERRIDE;
95
96   //! Returns a number of nodes in 1 BVH leaf
97   Standard_Integer GetLeafNodeSize() const { return myContent.Builder()->LeafNodeSize(); }
98
99   //! Dumps the content of me into the stream
100   Standard_EXPORT virtual void DumpJson (Standard_OStream& theOStream, Standard_Integer theDepth = -1) const Standard_OVERRIDE;
101
102 protected:
103
104   //! Checks whether one or more entities of the set overlap current selecting volume.
105   //! Implements the traverse of BVH tree built for the set
106   //! @param theMgr selection manager
107   //! @param thePickResult picking result (for picking by ray)
108   //! @param theToCheckAllInside flag indicating that even with SelectMgr_SelectingVolumeManager::IsOverlapAllowed() returning FALSE
109   //!        the method will return TRUE if at least one sub-element is fully inside selection volume ::elementIsInside();
110   //!        this is useful for entities allowing local selection of sub-elements using single Owner object.
111   Standard_EXPORT Standard_Boolean matches (SelectBasics_SelectingVolumeManager& theMgr,
112                                             SelectBasics_PickResult& thePickResult,
113                                             Standard_Boolean theToCheckAllInside);
114
115   //! Checks whether the entity with index theIdx (partially) overlaps the current selecting volume.
116   //! @param thePickResult [OUT] picking result, should update minimum depth
117   //! @param theMgr [IN] selection manager
118   //! @param theElemIdx [IN] element index within BVH tree to check
119   //! @param theIsFullInside [IN] when TRUE indicates that entire BVH node is already inside selection volume (in case of rectangle selection);
120   //!                             in this case algorithm might skip checking the element and just register it as detected
121   virtual Standard_Boolean overlapsElement (SelectBasics_PickResult& thePickResult,
122                                             SelectBasics_SelectingVolumeManager& theMgr,
123                                             Standard_Integer theElemIdx,
124                                             Standard_Boolean theIsFullInside) = 0;
125
126   //! Checks whether the entity with index theIdx is (fully) inside the current selecting volume
127   //! @param theMgr [IN] selection manager
128   //! @param theElemIdx [IN] element index within BVH tree to check
129   //! @param theIsFullInside [IN] when TRUE indicates that entire BVH node is already inside selection volume (in case of rectangle selection);
130   //!                             in this case algorithm might skip checking the element and just register it as detected
131   virtual Standard_Boolean elementIsInside (SelectBasics_SelectingVolumeManager& theMgr,
132                                             Standard_Integer theElemIdx,
133                                             Standard_Boolean theIsFullInside) = 0;
134
135   //! Calculates distance from the 3d projection of used-picked screen point to center of the geometry
136   virtual Standard_Real distanceToCOG (SelectBasics_SelectingVolumeManager& theMgr) = 0;
137
138 protected:
139
140   //! The purpose of this class is to provide a link between BVH_PrimitiveSet
141   //! and Select3D_SensitiveSet instance to build BVH tree for set of sensitives.
142   class BvhPrimitiveSet : public BVH_PrimitiveSet3d
143   {
144   public:
145
146     //! Empty constructor.
147     BvhPrimitiveSet() : BVH_PrimitiveSet3d (Handle(Select3D_BVHBuilder3d)()) {}
148
149     //! Destructor.
150     ~BvhPrimitiveSet() {}
151
152     //! Setup sensitivity set.
153     void SetSensitiveSet (Select3D_SensitiveSet* theSensitiveSet)
154     {
155       mySensitiveSet = theSensitiveSet;
156       MarkDirty();
157     }
158
159     //! Returns the length of set of sensitives
160     virtual Standard_Integer Size() const Standard_OVERRIDE { return mySensitiveSet->Size(); }
161
162     //! Returns bounding box of sensitive with index theIdx
163     virtual Select3D_BndBox3d Box (const Standard_Integer theIdx) const Standard_OVERRIDE { return mySensitiveSet->Box (theIdx); }
164
165     //! Make inherited method Box() visible to avoid CLang warning
166     using BVH_PrimitiveSet3d::Box;
167
168     //! Returns center of sensitive with index theIdx in the set along the given axis theAxis
169     virtual Standard_Real Center (const Standard_Integer theIdx,
170                                   const Standard_Integer theAxis) const Standard_OVERRIDE { return mySensitiveSet->Center (theIdx, theAxis); }
171
172     //! Swaps items with indexes theIdx1 and theIdx2 in the set
173     virtual void Swap (const Standard_Integer theIdx1,
174                        const Standard_Integer theIdx2) Standard_OVERRIDE { mySensitiveSet->Swap (theIdx1, theIdx2); }
175
176     //! Returns the tree built for set of sensitives
177     const opencascade::handle<BVH_Tree<Standard_Real, 3> >& GetBVH() { return BVH(); }
178
179     //! Dumps the content of me into the stream
180     void DumpJson (Standard_OStream& theOStream, Standard_Integer theDepth = -1) const
181     { (void)theOStream; (void)theDepth; }
182
183   protected:
184     Select3D_SensitiveSet* mySensitiveSet; //!< Set of sensitive entities
185   };
186
187 protected:
188
189   BvhPrimitiveSet  myContent;     //!< A link between sensitive entity and BVH_PrimitiveSet
190   Standard_Integer myDetectedIdx; //!< Index of detected primitive in BVH sorted primitive array
191
192 };
193
194 DEFINE_STANDARD_HANDLE(Select3D_SensitiveSet, Select3D_SensitiveEntity)
195
196 #endif // _Select3D_SensitiveSet_Header