src/SketcherPrs/SketcherPrs_Radius.h

   1 // Copyright (C) 2014-2023  CEA/DEN, EDF R&D
   2 //
   3 // This library is free software; you can redistribute it and/or
   4 // modify it under the terms of the GNU Lesser General Public
   5 // License as published by the Free Software Foundation; either
   6 // version 2.1 of the License, or (at your option) any later version.
   7 //
   8 // This library is distributed in the hope that it will be useful,
   9 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  10 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  11 // Lesser General Public License for more details.
  12 //
  13 // You should have received a copy of the GNU Lesser General Public
  14 // License along with this library; if not, write to the Free Software
  15 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  16 //
  17 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
  18 //
  19
  20 #ifndef SketcherPrs_Radius_H
  21 #define SketcherPrs_Radius_H
  22
  23 #include <GeomAPI_Ax3.h>
  24 #include <ModelAPI_Feature.h>
  25 #include <SketchPlugin_Sketch.h>
  26
  27 #include <PrsDim_RadiusDimension.hxx>
  28 #include <Standard_DefineHandle.hxx>
  29
  30 #include <SketcherPrs_DimensionStyle.h>
  31
  32 DEFINE_STANDARD_HANDLE(SketcherPrs_Radius, PrsDim_RadiusDimension)
  33
  34 /**
  35 * \ingroup GUI
  36 * A class for representation of radius constraint
  37 */
  38 class SketcherPrs_Radius : public PrsDim_RadiusDimension
  39 {
  40 public:
  41   /// Constructor
  42   /// \param theConstraint a constraint feature
  43   /// \param thePlane a coordinate plane of current sketch
  44   Standard_EXPORT SketcherPrs_Radius(ModelAPI_Feature* theConstraint,
  45     SketchPlugin_Sketch* theSketcher);
  46
  47   /// Destructor
  48   Standard_EXPORT ~SketcherPrs_Radius();
  49
  50   DEFINE_STANDARD_RTTIEXT(SketcherPrs_Radius, PrsDim_RadiusDimension)
  51
  52   /// Returns true if the constraint feature arguments are correcly filled
  53   /// to build AIS presentation
  54   /// \param theConstraint a constraint feature
  55   /// \param thePlane a coordinate plane of current sketch
  56   /// \return boolean result value
  57   static bool IsReadyToDisplay(ModelAPI_Feature* theConstraint,
  58                                const std::shared_ptr<GeomAPI_Ax3>& thePlane);
  59
  60   /// Returns sketcher plane
  61   Standard_EXPORT std::shared_ptr<GeomAPI_Ax3> plane() const
  62   {
  63     return mySketcher->coordinatePlane();
  64   }
  65
  66 private:
  67   /// Fills the constraint parameters by constraint and plane
  68   /// \param theConstraint a constraint feature
  69   /// \param thePlane a coordinate plane of current sketch
  70   /// \param theCircle a circle build on the constraint values
  71   /// \param thePoint an anchor point to show text value
  72   /// \return boolean result value
  73   static bool readyToDisplay(ModelAPI_Feature* theConstraint,
  74                              const std::shared_ptr<GeomAPI_Ax3>& thePlane,
  75                              gp_Circ& theCircle, gp_Pnt& theAnchorPoint);
  76 protected:
  77   /// Redefinition of virtual function
  78   Standard_EXPORT virtual void Compute(
  79     const Handle(PrsMgr_PresentationManager3d)& thePresentationManager,
  80     const Handle(Prs3d_Presentation)& thePresentation, const Standard_Integer theMode = 0);
  81
  82   /// Redefinition of virtual function
  83   Standard_EXPORT virtual void ComputeSelection(const Handle(SelectMgr_Selection)& aSelection,
  84     const Standard_Integer aMode);
  85
  86 private:
  87   /// Constraint feature
  88   ModelAPI_Feature* myConstraint;
  89
  90   /// A current sketcher
  91   SketchPlugin_Sketch* mySketcher;
  92
  93   /// Listener to update dimension visualization style
  94   SketcherPrs_DimensionStyle* myStyleListener;
  95
  96   /// container of values obtained from the constraint, which are necessary to fill the presentation
  97   gp_Circ myCircle; ///< the radius circle
  98   gp_Pnt myAnchorPoint; ///< an ancor for the radius value visualization
  99
 100   SketcherPrs_DimensionStyle::DimensionValue myValue; /// the structure filled by constraint
 101 };
 102
 103 #endif