0029938: Visualization - SelectMgr_ViewerSelector::PickedPoint() should return point...
[occt.git] / src / Select3D / Select3D_SensitiveWire.hxx
1 // Created on: 1996-10-17
2 // Created by: Odile OLIVIER
3 // Copyright (c) 1996-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 _Select3D_SensitiveWire_HeaderFile
18 #define _Select3D_SensitiveWire_HeaderFile
19
20 #include <Select3D_SensitiveSet.hxx>
21
22 //! A framework to define selection of a wire owner by an
23 //! elastic wire band.
24 class Select3D_SensitiveWire : public Select3D_SensitiveSet
25 {
26 public:
27
28   //! Constructs a sensitive wire object defined by the
29   //! owner theOwnerId
30   Standard_EXPORT Select3D_SensitiveWire (const Handle(SelectBasics_EntityOwner)& theOwnerId);
31
32   //! Adds the sensitive entity theSensitive to this framework.
33   Standard_EXPORT void Add (const Handle(Select3D_SensitiveEntity)& theSensitive);
34
35   //! Returns the amount of sub-entities
36   Standard_EXPORT virtual Standard_Integer NbSubElements() Standard_OVERRIDE;
37
38   Standard_EXPORT virtual Handle(Select3D_SensitiveEntity) GetConnected() Standard_OVERRIDE;
39
40   //! returns the sensitive edges stored in this wire
41   Standard_EXPORT const NCollection_Vector<Handle(Select3D_SensitiveEntity)>& GetEdges();
42
43   //! Sets the owner for all entities in wire
44   Standard_EXPORT void Set (const Handle(SelectBasics_EntityOwner)& theOwnerId) Standard_OVERRIDE;
45
46   Standard_EXPORT Handle(Select3D_SensitiveEntity) GetLastDetected() const;
47
48   //! Returns bounding box of the wire. If location
49   //! transformation is set, it will be applied
50   Standard_EXPORT virtual Select3D_BndBox3d BoundingBox() Standard_OVERRIDE;
51
52   //! Returns center of the wire. If location transformation
53   //! is set, it will be applied
54   Standard_EXPORT virtual gp_Pnt CenterOfGeometry() const Standard_OVERRIDE;
55
56   //! Returns the length of vector of sensitive entities
57   Standard_EXPORT virtual Standard_Integer Size() const Standard_OVERRIDE;
58
59   //! Returns bounding box of sensitive entity with index theIdx
60   Standard_EXPORT virtual Select3D_BndBox3d Box (const Standard_Integer theIdx) const Standard_OVERRIDE;
61
62   //! Returns geometry center of sensitive entity index theIdx in
63   //! the vector along the given axis theAxis
64   Standard_EXPORT virtual Standard_Real Center (const Standard_Integer theIdx,
65                                                 const Standard_Integer theAxis) const Standard_OVERRIDE;
66
67   //! Swaps items with indexes theIdx1 and theIdx2 in the vector
68   Standard_EXPORT virtual void Swap (const Standard_Integer theIdx1,
69                                      const Standard_Integer theIdx2) Standard_OVERRIDE;
70
71   DEFINE_STANDARD_RTTIEXT(Select3D_SensitiveWire,Select3D_SensitiveSet)
72
73 protected:
74
75   //! Checks whether the entity with index theIdx overlaps the current selecting volume
76   Standard_EXPORT virtual Standard_Boolean overlapsElement (SelectBasics_SelectingVolumeManager& theMgr,
77                                                             Standard_Integer theElemIdx,
78                                                             SelectBasics_PickResult& thePickResult) Standard_OVERRIDE;
79
80   //! Checks whether the entity with index theIdx is inside the current selecting volume
81   Standard_EXPORT virtual Standard_Boolean elementIsInside (SelectBasics_SelectingVolumeManager& theMgr,
82                                                             const Standard_Integer               theElemIdx) Standard_OVERRIDE;
83
84   //! Calculates distance from the 3d projection of used-picked screen point to center of the geometry
85   Standard_EXPORT virtual Standard_Real distanceToCOG (SelectBasics_SelectingVolumeManager& theMgr) Standard_OVERRIDE;
86
87 private:
88
89   NCollection_Vector<Handle(Select3D_SensitiveEntity)> myEntities;          //!< Vector of sub-entities
90   NCollection_Vector<Standard_Integer>                 myEntityIndexes;     //!< Indexes of entities for BVH build
91   gp_Pnt                                               myCenter;            //!< Center of the whole wire
92   mutable Select3D_BndBox3d                            myBndBox;            //!< Bounding box of the whole wire
93 };
94
95 DEFINE_STANDARD_HANDLE(Select3D_SensitiveWire, Select3D_SensitiveEntity)
96
97 #endif // _Select3D_SensitiveWire_HeaderFile