0024623: Visualization - improve selection mechanism
[occt.git] / src / Select3D / Select3D_SensitivePoint.hxx
1 // Created on: 1995-03-10
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 _Select3D_SensitivePoint_HeaderFile
18 #define _Select3D_SensitivePoint_HeaderFile
19
20 #include <Standard.hxx>
21 #include <Standard_DefineHandle.hxx>
22 #include <Standard_Type.hxx>
23
24 #include <Select3D_Pnt.hxx>
25 #include <Select3D_SensitiveEntity.hxx>
26 #include <Handle_SelectBasics_EntityOwner.hxx>
27 #include <Standard_Boolean.hxx>
28 #include <SelectMgr_SelectingVolumeManager.hxx>
29 #include <Standard_Real.hxx>
30 #include <Standard_OStream.hxx>
31
32 class SelectBasics_EntityOwner;
33 class gp_Pnt;
34 class TopLoc_Location;
35
36 //! A framework to define sensitive 3D points.
37 class Select3D_SensitivePoint : public Select3D_SensitiveEntity
38 {
39 public:
40
41   //! Constructs a sensitive point object defined by the
42   //! owner OwnerId and the point Point.
43   Standard_EXPORT Select3D_SensitivePoint (const Handle(SelectBasics_EntityOwner)& theOwnerId, const gp_Pnt& thePoint);
44
45   //! Returns the amount of sub-entities in sensitive
46   Standard_EXPORT virtual Standard_Integer NbSubElements() Standard_OVERRIDE;
47
48   Standard_EXPORT virtual Handle(Select3D_SensitiveEntity) GetConnected() Standard_OVERRIDE;
49
50   //! Checks whether the point overlaps current selecting volume
51   Standard_EXPORT virtual Standard_Boolean Matches (SelectBasics_SelectingVolumeManager& theMgr,
52                                                     SelectBasics_PickResult& thePickResult) Standard_OVERRIDE;
53
54   //! Returns the point used at the time of construction.
55   Standard_EXPORT gp_Pnt Point() const;
56
57   //! Returns center of point. If location transformation
58   //! is set, it will be applied
59   Standard_EXPORT virtual gp_Pnt CenterOfGeometry() const Standard_OVERRIDE;
60
61   //! Returns bounding box of the point. If location
62   //! transformation is set, it will be applied
63   Standard_EXPORT virtual Select3D_BndBox3d BoundingBox() Standard_OVERRIDE;
64
65   DEFINE_STANDARD_RTTI(Select3D_SensitivePoint)
66
67 private:
68
69   gp_Pnt myPoint;      //!< 3d coordinates of the point
70 };
71
72 DEFINE_STANDARD_HANDLE(Select3D_SensitivePoint, Select3D_SensitiveEntity)
73
74 #endif // _Select3D_SensitivePoint_HeaderFile