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 <Standard.hxx>
  21 #include <Standard_DefineHandle.hxx>
  22 #include <Standard_Type.hxx>
  23
  24 #include <Bnd_Box.hxx>
  25 #include <gp_Pnt.hxx>
  26 #include <Select3D_SensitiveEntity.hxx>
  27 #include <Handle_SelectBasics_EntityOwner.hxx>
  28 #include <SelectMgr_SelectingVolumeManager.hxx>
  29 #include <Standard_OStream.hxx>
  30
  31 class SelectBasics_EntityOwner;
  32 class Bnd_Box;
  33 class TopLoc_Location;
  34
  35
  36 //! A framework to define selection by a sensitive box.
  37 class Select3D_SensitiveBox : public Select3D_SensitiveEntity
  38 {
  39 public:
  40
  41   //! Constructs a sensitive box object defined by the
  42   //! owner theOwnerId, and the box theBox.
  43   Standard_EXPORT Select3D_SensitiveBox (const Handle(SelectBasics_EntityOwner)& theOwnerId, const Bnd_Box& theBox);
  44
  45   //! Constructs a sensitive box object defined by the
  46   //! owner theOwnerId, and the coordinates theXmin, theYMin, theZMin, theXMax, theYMax, theZMax.
  47   //! theXmin, theYMin and theZMin define the minimum point in
  48   //! the front lower left hand corner of the box,
  49   //! and theXMax, theYMax and theZMax define the maximum
  50   //! point in the back upper right hand corner of the box.
  51   Standard_EXPORT Select3D_SensitiveBox (const Handle(SelectBasics_EntityOwner)& theOwnerId,
  52                                          const Standard_Real theXMin,
  53                                          const Standard_Real theYMin,
  54                                          const Standard_Real theZMin,
  55                                          const Standard_Real theXMax,
  56                                          const Standard_Real theYMax,
  57                                          const Standard_Real theZMax);
  58
  59   //! Returns the amount of sub-entities in sensitive
  60   Standard_EXPORT virtual Standard_Integer NbSubElements() Standard_OVERRIDE;
  61
  62   Standard_EXPORT virtual Handle(Select3D_SensitiveEntity) GetConnected() Standard_OVERRIDE;
  63
  64   //! Checks whether the box overlaps current selecting volume
  65   Standard_EXPORT virtual Standard_Boolean Matches (SelectBasics_SelectingVolumeManager& theMgr,
  66                                                     SelectBasics_PickResult& thePickResult) Standard_OVERRIDE;
  67
  68   Bnd_Box Box() const;
  69
  70   //! Returns center of the box. If location
  71   //! transformation is set, it will be applied
  72   Standard_EXPORT virtual gp_Pnt CenterOfGeometry() const Standard_OVERRIDE;
  73
  74   //! Returns coordinates of the box. If location
  75   //! transformation is set, it will be applied
  76   Standard_EXPORT virtual Select3D_BndBox3d BoundingBox() Standard_OVERRIDE;
  77
  78   DEFINE_STANDARD_RTTI(Select3D_SensitiveBox)
  79
  80 private:
  81
  82   Select3D_BndBox3d myBox;     //!< 3d coordinates of box corners
  83   gp_Pnt myCenter3d;           //!< 3d coordinate of box's center
  84 };
  85
  86 DEFINE_STANDARD_HANDLE(Select3D_SensitiveBox, Select3D_SensitiveEntity)
  87
  88 #endif // _Select3D_SensitiveBox_HeaderFile