include/opencascade/Select3D_SensitiveBox.hxx

0001 // Created on: 1995-04-13
0002 // Created by: Robert COUBLANC
0003 // Copyright (c) 1995-1999 Matra Datavision
0004 // Copyright (c) 1999-2014 OPEN CASCADE SAS
0005 //
0006 // This file is part of Open CASCADE Technology software library.
0007 //
0008 // This library is free software; you can redistribute it and/or modify it under
0009 // the terms of the GNU Lesser General Public License version 2.1 as published
0010 // by the Free Software Foundation, with special exception defined in the file
0011 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
0012 // distribution for complete text of the license and disclaimer of any warranty.
0013 //
0014 // Alternatively, this file may be used under the terms of Open CASCADE
0015 // commercial license or contractual agreement.
0016
0017 #ifndef _Select3D_SensitiveBox_HeaderFile
0018 #define _Select3D_SensitiveBox_HeaderFile
0019
0020 #include <Select3D_SensitiveEntity.hxx>
0021
0022 //! A framework to define selection by a sensitive box.
0023 class Select3D_SensitiveBox : public Select3D_SensitiveEntity
0024 {
0025   DEFINE_STANDARD_RTTIEXT(Select3D_SensitiveBox, Select3D_SensitiveEntity)
0026 public:
0027   //! Constructs a sensitive box object defined by the
0028   //! owner theOwnerId, and the box theBox.
0029   Standard_EXPORT Select3D_SensitiveBox(const occ::handle<SelectMgr_EntityOwner>& theOwnerId,
0030                                         const Bnd_Box&                            theBox);
0031
0032   //! Constructs a sensitive box object defined by the
0033   //! owner theOwnerId, and the coordinates theXmin, theYMin, theZMin, theXMax, theYMax, theZMax.
0034   //! theXmin, theYMin and theZMin define the minimum point in
0035   //! the front lower left hand corner of the box,
0036   //! and theXMax, theYMax and theZMax define the maximum
0037   //! point in the back upper right hand corner of the box.
0038   Standard_EXPORT Select3D_SensitiveBox(const occ::handle<SelectMgr_EntityOwner>& theOwnerId,
0039                                         const double                              theXMin,
0040                                         const double                              theYMin,
0041                                         const double                              theZMin,
0042                                         const double                              theXMax,
0043                                         const double                              theYMax,
0044                                         const double                              theZMax);
0045
0046   //! Returns the amount of sub-entities in sensitive
0047   Standard_EXPORT int NbSubElements() const override;
0048
0049   Standard_EXPORT occ::handle<Select3D_SensitiveEntity> GetConnected() override;
0050
0051   //! Checks whether the box overlaps current selecting volume
0052   Standard_EXPORT bool Matches(SelectBasics_SelectingVolumeManager& theMgr,
0053                                SelectBasics_PickResult&             thePickResult) override;
0054
0055   Bnd_Box Box() const
0056   {
0057     Bnd_Box aBox;
0058     aBox.Update(myBox.CornerMin().x(),
0059                 myBox.CornerMin().y(),
0060                 myBox.CornerMin().z(),
0061                 myBox.CornerMax().x(),
0062                 myBox.CornerMax().y(),
0063                 myBox.CornerMax().z());
0064
0065     return aBox;
0066   }
0067
0068   //! Returns center of the box. If location
0069   //! transformation is set, it will be applied
0070   Standard_EXPORT gp_Pnt CenterOfGeometry() const override;
0071
0072   //! Returns coordinates of the box. If location
0073   //! transformation is set, it will be applied
0074   Standard_EXPORT Select3D_BndBox3d BoundingBox() override;
0075
0076   //! Returns TRUE if BVH tree is in invalidated state
0077   bool ToBuildBVH() const override { return false; }
0078
0079   //! Dumps the content of me into the stream
0080   Standard_EXPORT void DumpJson(Standard_OStream& theOStream, int theDepth = -1) const override;
0081
0082 private:
0083   Select3D_BndBox3d myBox;      //!< 3d coordinates of box corners
0084   gp_Pnt            myCenter3d; //!< 3d coordinate of box's center
0085 };
0086
0087 #endif // _Select3D_SensitiveBox_HeaderFile