src/Select3D/Select3D_SensitiveCircle.hxx

   1 // Created on: 1996-02-06
   2 // Created by: Robert COUBLANC
   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 // Modified    Tue Apr 14 1998 by rob : fix Bug : Case of Null Radius Circle...
  18
  19 #ifndef _Select3D_SensitiveCircle_HeaderFile
  20 #define _Select3D_SensitiveCircle_HeaderFile
  21
  22 #include <Standard.hxx>
  23 #include <Standard_Type.hxx>
  24 #include <Standard_Type.hxx>
  25
  26 #include <Select3D_SensitivePoly.hxx>
  27 #include <Select3D_Pnt.hxx>
  28 #include <TColgp_HArray1OfPnt.hxx>
  29 #include <SelectMgr_SelectingVolumeManager.hxx>
  30 #include <Select3D_TypeOfSensitivity.hxx>
  31
  32 class Geom_Circle;
  33 class Standard_ConstructionError;
  34 class Standard_OutOfRange;
  35 class SelectBasics_EntityOwner;
  36 class gp_Pnt;
  37 class TopLoc_Location;
  38
  39
  40 //! A framework to define sensitive 3D arcs and circles.
  41 //! In some cases this class can raise Standard_ConstructionError and
  42 //! Standard_OutOfRange exceptions. For more details see Select3D_SensitivePoly.
  43 class Select3D_SensitiveCircle : public Select3D_SensitivePoly
  44 {
  45 public:
  46
  47   //! Constructs the sensitive circle object defined by the
  48   //! owner theOwnerId, the circle theCircle, the boolean
  49   //! theIsFilled and the number of points theNbPnts.
  50   Standard_EXPORT Select3D_SensitiveCircle (const Handle(SelectBasics_EntityOwner)& theOwnerId,
  51                                             const Handle(Geom_Circle)& theCircle,
  52                                             const Standard_Boolean theIsFilled = Standard_False,
  53                                             const Standard_Integer theNbPnts = 12);
  54
  55   //! Constructs the sensitive arc object defined by the
  56   //! owner theOwnerId, the circle theCircle, the parameters theU1
  57   //! and theU2, the boolean theIsFilled and the number of points theNbPnts.
  58   //! theU1 and theU2 define the first and last points of the arc on theCircle.
  59   Standard_EXPORT Select3D_SensitiveCircle (const Handle(SelectBasics_EntityOwner)& theOwnerId,
  60                                             const Handle(Geom_Circle)& theCircle,
  61                                             const Standard_Real theU1,
  62                                             const Standard_Real theU2,
  63                                             const Standard_Boolean theIsFilled = Standard_False,
  64                                             const Standard_Integer theNbPnts = 12);
  65
  66   //! Constructs the sensitive circle object defined by the
  67   //! owner theOwnerId, the array of triangles thePnts3d, and the boolean theIsFilled.
  68   //! thePnts3d is an array of consecutive triangles on the
  69   //! circle. The triangle i+1 lies on the intersection of the
  70   //! tangents to the circle of i and i+2. Note, that the first point of thePnts3d
  71   //! must be equal to the last point of thePnts3d.
  72   Standard_EXPORT Select3D_SensitiveCircle (const Handle(SelectBasics_EntityOwner)& theOwnerId,
  73                                             const Handle(TColgp_HArray1OfPnt)& thePnts3d,
  74                                             const Standard_Boolean theIsFilled = Standard_False);
  75
  76   //! Constructs the sensitive circle object defined by the
  77   //! owner theOwnerId, the array of points thePnts3d, and the boolean theIsFilled.
  78   //! If the length of thePnts3d is more then 1, the first point of thePnts3d
  79   //! must be equal to the last point of thePnts3d.
  80   Standard_EXPORT Select3D_SensitiveCircle (const Handle(SelectBasics_EntityOwner)& theOwnerId,
  81                                             const TColgp_Array1OfPnt& thePnts3d,
  82                                             const Standard_Boolean theIsFilled = Standard_False);
  83
  84   //! Checks whether the circle overlaps current selecting volume
  85   Standard_EXPORT  virtual Standard_Boolean Matches (SelectBasics_SelectingVolumeManager& theMgr,
  86                                                      SelectBasics_PickResult& thePickResult) Standard_OVERRIDE;
  87
  88
  89   Standard_EXPORT void ArrayBounds (Standard_Integer & theLow, Standard_Integer & theUp) const;
  90
  91   Standard_EXPORT gp_Pnt GetPoint3d (const Standard_Integer thePntIdx) const;
  92
  93   Standard_EXPORT virtual Handle(Select3D_SensitiveEntity) GetConnected() Standard_OVERRIDE;
  94
  95   //! Returns center of the circle. If location
  96   //! transformation is set, it will be applied
  97   Standard_EXPORT virtual gp_Pnt CenterOfGeometry() const Standard_OVERRIDE;
  98
  99   //! Builds BVH tree for a circle's edge segments if needed
 100   Standard_EXPORT virtual void BVH() Standard_OVERRIDE;
 101
 102   DEFINE_STANDARD_RTTIEXT(Select3D_SensitiveCircle,Select3D_SensitivePoly)
 103
 104 protected:
 105
 106   //! Calculates distance from the 3d projection of used-picked screen point
 107   //! to center of the geometry
 108   virtual Standard_Real distanceToCOG (SelectBasics_SelectingVolumeManager& theMgr) Standard_OVERRIDE;
 109
 110 private:
 111
 112   //! Computes myCenter3D as the barycenter of points from mypolyg3d
 113   void computeCenter3D();
 114
 115 private:
 116
 117   Select3D_TypeOfSensitivity mySensType;     //!< True if type of selection is interior, false otherwise
 118   gp_Pnt                     myCenter3D;       //!< Center of a circle
 119   Handle(Geom_Circle)         myCircle;         //!< Points of the circle
 120   Standard_Real              myStart;          //!< Sensitive arc parameter
 121   Standard_Real              myEnd;            //!< Sensitive arc parameter
 122 };
 123
 124 DEFINE_STANDARD_HANDLE(Select3D_SensitiveCircle, Select3D_SensitivePoly)
 125
 126 #endif // _Select3D_SensitiveCircle_HeaderFile