Salome HOME
Update copyrights
[modules/shaper.git] / src / SketcherPrs / SketcherPrs_Angle.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_Angle_H
21 #define SketcherPrs_Angle_H
22
23 #include <GeomAPI_Ax3.h>
24 #include <ModelAPI_Feature.h>
25
26 #include <AIS_AngleDimension.hxx>
27 #include <Standard_DefineHandle.hxx>
28
29 #include <SketcherPrs_DimensionStyleListener.h>
30
31 DEFINE_STANDARD_HANDLE(SketcherPrs_Angle, AIS_AngleDimension)
32
33 /**
34 * \ingroup GUI
35 * A class for representation of angle constraint
36 */
37 class SketcherPrs_Angle : public AIS_AngleDimension
38 {
39 public:
40   /// Constructor
41   /// \param theConstraint a constraint feature
42   /// \param thePlane a coordinate plane of current sketch
43   Standard_EXPORT SketcherPrs_Angle(ModelAPI_Feature* theConstraint,
44                         const std::shared_ptr<GeomAPI_Ax3>& thePlane);
45
46   /// Destructor
47   Standard_EXPORT ~SketcherPrs_Angle();
48
49   DEFINE_STANDARD_RTTIEXT(SketcherPrs_Angle, AIS_AngleDimension)
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 protected:
59   /// Redefinition of virtual function
60   Standard_EXPORT virtual void Compute(
61     const Handle(PrsMgr_PresentationManager3d)& thePresentationManager,
62     const Handle(Prs3d_Presentation)& thePresentation, const Standard_Integer theMode = 0);
63
64   /// Redefinition of virtual function
65   Standard_EXPORT virtual void ComputeSelection(const Handle(SelectMgr_Selection)& aSelection,
66     const Standard_Integer aMode);
67
68   /// Checks is the angle plane has inverted direction of normal to the plane of current sketcher
69   /// Returns true if crossed product is negative.
70   /// \return bolean value
71   bool isAnglePlaneReversedToSketchPlane();
72
73   /// Calculates a distance between center of the angle presentation and the value of flyout point
74   /// attribute. It should be used after setting measured geometry for the angle presentation as
75   /// it uses calculated center/first/second point coordinates
76   /// \return real value
77   double calculateDistanceToFlyoutPoint();
78
79   static bool readyToDisplay(ModelAPI_Feature* theConstraint,
80                              const std::shared_ptr<GeomAPI_Ax3>& thePlane,
81                              gp_Pnt& theFirstPoint, gp_Pnt& theSecondPoint,
82                              gp_Pnt& theCenterPoint);
83
84 private:
85   /// Constraint feature
86   ModelAPI_Feature* myConstraint;
87
88   /// Plane of the current sketcher
89   std::shared_ptr<GeomAPI_Ax3> mySketcherPlane;
90
91   Handle(Prs3d_DimensionAspect) myAspect;
92
93   /// Listener to update dimension visualization style
94   SketcherPrs_DimensionStyleListener* myStyleListener;
95
96   /// container of values obtained from the constraint, which are necessary to fill the presentation
97   gp_Pnt myFirstPoint; ///< the dimension first point for measured geometry
98   gp_Pnt mySecondPoint; ///< the dimension second point for measured geometry
99   gp_Pnt myCenterPoint; ///< the dimension center point for measured geometry
100   gp_Pnt myFlyOutPoint;  ///< the dimension fly out point for measured geometry
101
102   SketcherPrs_DimensionStyleListener::DimensionValue myValue; /// the structure filled by constraint
103 };
104
105
106 #endif