Salome HOME
Add copyright header according to request of CEA from 06.06.2017
[modules/shaper.git] / src / SketcherPrs / SketcherPrs_Radius.h
1 // Copyright (C) 2014-2017  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
18 // email : webmaster.salome@opencascade.com<mailto:webmaster.salome@opencascade.com>
19 //
20
21 #ifndef SketcherPrs_Radius_H
22 #define SketcherPrs_Radius_H
23
24 #include <GeomAPI_Ax3.h>
25 #include <ModelAPI_Feature.h>
26
27 #include <AIS_RadiusDimension.hxx>
28 #include <Standard_DefineHandle.hxx>
29
30 #include <SketcherPrs_DimensionStyleListener.h>
31
32 DEFINE_STANDARD_HANDLE(SketcherPrs_Radius, AIS_RadiusDimension)
33
34 /**
35 * \ingroup GUI
36 * A class for representation of radius constraint
37 */
38 class SketcherPrs_Radius : public AIS_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                         const std::shared_ptr<GeomAPI_Ax3>& thePlane);
46
47   /// Destructor
48   Standard_EXPORT ~SketcherPrs_Radius();
49
50   DEFINE_STANDARD_RTTIEXT(SketcherPrs_Radius, AIS_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 private:
60   /// Fills the constraint parameters by constraint and plane
61   /// \param theConstraint a constraint feature
62   /// \param thePlane a coordinate plane of current sketch
63   /// \param theCircle a circle build on the constraint values
64   /// \param thePoint an anchor point to show text value
65   /// \return boolean result value
66   static bool readyToDisplay(ModelAPI_Feature* theConstraint,
67                              const std::shared_ptr<GeomAPI_Ax3>& thePlane,
68                              gp_Circ& theCircle, gp_Pnt& theAnchorPoint);
69 protected:
70   /// Redefinition of virtual function
71   Standard_EXPORT virtual void Compute(
72     const Handle(PrsMgr_PresentationManager3d)& thePresentationManager,
73     const Handle(Prs3d_Presentation)& thePresentation, const Standard_Integer theMode = 0);
74
75   /// Redefinition of virtual function
76   Standard_EXPORT virtual void ComputeSelection(const Handle(SelectMgr_Selection)& aSelection,
77     const Standard_Integer aMode);
78
79 private:
80   /// Constraint feature
81   ModelAPI_Feature* myConstraint;
82
83   /// Plane of the current sketcher
84   std::shared_ptr<GeomAPI_Ax3> mySketcherPlane;
85
86   /// Listener to update dimension visualization style
87   SketcherPrs_DimensionStyleListener* myStyleListener;
88
89   /// container of values obtained from the constraint, which are necessary to fill the presentation
90   gp_Circ myCircle; ///< the radius circle
91   gp_Pnt myAnchorPoint; ///< an ancor for the radius value visualization
92
93   SketcherPrs_DimensionStyleListener::DimensionValue myValue; /// the structure filled by constraint
94 };
95
96 #endif