Salome HOME
Update copyrights
[modules/shaper.git] / src / SketcherPrs / SketcherPrs_Radius.h
1 // Copyright (C) 2014-2019  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
26 #include <AIS_RadiusDimension.hxx>
27 #include <Standard_DefineHandle.hxx>
28
29 #include <SketcherPrs_DimensionStyleListener.h>
30
31 DEFINE_STANDARD_HANDLE(SketcherPrs_Radius, AIS_RadiusDimension)
32
33 /**
34 * \ingroup GUI
35 * A class for representation of radius constraint
36 */
37 class SketcherPrs_Radius : public AIS_RadiusDimension
38 {
39 public:
40   /// Constructor
41   /// \param theConstraint a constraint feature
42   /// \param thePlane a coordinate plane of current sketch
43   Standard_EXPORT SketcherPrs_Radius(ModelAPI_Feature* theConstraint,
44                         const std::shared_ptr<GeomAPI_Ax3>& thePlane);
45
46   /// Destructor
47   Standard_EXPORT ~SketcherPrs_Radius();
48
49   DEFINE_STANDARD_RTTIEXT(SketcherPrs_Radius, AIS_RadiusDimension)
50
51   /// Returns true if the constraint feature arguments are correcly filled
52   /// to build AIS presentation
53   /// \param theConstraint a constraint feature
54   /// \param thePlane a coordinate plane of current sketch
55   /// \return boolean result value
56   static bool IsReadyToDisplay(ModelAPI_Feature* theConstraint,
57                                const std::shared_ptr<GeomAPI_Ax3>& thePlane);
58 private:
59   /// Fills the constraint parameters by constraint and plane
60   /// \param theConstraint a constraint feature
61   /// \param thePlane a coordinate plane of current sketch
62   /// \param theCircle a circle build on the constraint values
63   /// \param thePoint an anchor point to show text value
64   /// \return boolean result value
65   static bool readyToDisplay(ModelAPI_Feature* theConstraint,
66                              const std::shared_ptr<GeomAPI_Ax3>& thePlane,
67                              gp_Circ& theCircle, gp_Pnt& theAnchorPoint);
68 protected:
69   /// Redefinition of virtual function
70   Standard_EXPORT virtual void Compute(
71     const Handle(PrsMgr_PresentationManager3d)& thePresentationManager,
72     const Handle(Prs3d_Presentation)& thePresentation, const Standard_Integer theMode = 0);
73
74   /// Redefinition of virtual function
75   Standard_EXPORT virtual void ComputeSelection(const Handle(SelectMgr_Selection)& aSelection,
76     const Standard_Integer aMode);
77
78 private:
79   /// Constraint feature
80   ModelAPI_Feature* myConstraint;
81
82   /// Plane of the current sketcher
83   std::shared_ptr<GeomAPI_Ax3> mySketcherPlane;
84
85   /// Listener to update dimension visualization style
86   SketcherPrs_DimensionStyleListener* myStyleListener;
87
88   /// container of values obtained from the constraint, which are necessary to fill the presentation
89   gp_Circ myCircle; ///< the radius circle
90   gp_Pnt myAnchorPoint; ///< an ancor for the radius value visualization
91
92   SketcherPrs_DimensionStyleListener::DimensionValue myValue; /// the structure filled by constraint
93 };
94
95 #endif