0028778: Coding Rules - clean up confusing code from Select3D
[occt.git] / src / Select3D / Select3D_SensitiveBox.hxx
1 // Created on: 1995-04-13
2 // Created by: Robert COUBLANC
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_SensitiveBox_HeaderFile
18 #define _Select3D_SensitiveBox_HeaderFile
19
20 #include <Bnd_Box.hxx>
21 #include <Select3D_SensitiveEntity.hxx>
22
23 //! A framework to define selection by a sensitive box.
24 class Select3D_SensitiveBox : public Select3D_SensitiveEntity
25 {
26   DEFINE_STANDARD_RTTIEXT(Select3D_SensitiveBox, Select3D_SensitiveEntity)
27 public:
28
29   //! Constructs a sensitive box object defined by the
30   //! owner theOwnerId, and the box theBox.
31   Standard_EXPORT Select3D_SensitiveBox (const Handle(SelectBasics_EntityOwner)& theOwnerId, const Bnd_Box& theBox);
32
33   //! Constructs a sensitive box object defined by the
34   //! owner theOwnerId, and the coordinates theXmin, theYMin, theZMin, theXMax, theYMax, theZMax.
35   //! theXmin, theYMin and theZMin define the minimum point in
36   //! the front lower left hand corner of the box,
37   //! and theXMax, theYMax and theZMax define the maximum
38   //! point in the back upper right hand corner of the box.
39   Standard_EXPORT Select3D_SensitiveBox (const Handle(SelectBasics_EntityOwner)& theOwnerId,
40                                          const Standard_Real theXMin,
41                                          const Standard_Real theYMin,
42                                          const Standard_Real theZMin,
43                                          const Standard_Real theXMax,
44                                          const Standard_Real theYMax,
45                                          const Standard_Real theZMax);
46
47   //! Returns the amount of sub-entities in sensitive
48   Standard_EXPORT virtual Standard_Integer NbSubElements() Standard_OVERRIDE;
49
50   Standard_EXPORT virtual Handle(Select3D_SensitiveEntity) GetConnected() Standard_OVERRIDE;
51
52   //! Checks whether the box overlaps current selecting volume
53   Standard_EXPORT virtual Standard_Boolean Matches (SelectBasics_SelectingVolumeManager& theMgr,
54                                                     SelectBasics_PickResult& thePickResult) Standard_OVERRIDE;
55
56   Bnd_Box Box() const
57   {
58     Bnd_Box aBox;
59     aBox.Update (myBox.CornerMin().x(), myBox.CornerMin().y(), myBox.CornerMin().z(),
60                  myBox.CornerMax().x(), myBox.CornerMax().y(), myBox.CornerMax().z());
61
62     return aBox;
63   }
64
65   //! Returns center of the box. If location
66   //! transformation is set, it will be applied
67   Standard_EXPORT virtual gp_Pnt CenterOfGeometry() const Standard_OVERRIDE;
68
69   //! Returns coordinates of the box. If location
70   //! transformation is set, it will be applied
71   Standard_EXPORT virtual Select3D_BndBox3d BoundingBox() Standard_OVERRIDE;
72
73 private:
74
75   Select3D_BndBox3d myBox;     //!< 3d coordinates of box corners
76   gp_Pnt myCenter3d;           //!< 3d coordinate of box's center
77 };
78
79 DEFINE_STANDARD_HANDLE(Select3D_SensitiveBox, Select3D_SensitiveEntity)
80
81 #endif // _Select3D_SensitiveBox_HeaderFile