Salome HOME
Add copyright header according to request of CEA from 06.06.2017
[modules/shaper.git] / src / SketcherPrs / SketcherPrs_Transformation.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_Transformation_H
22 #define SketcherPrs_Transformation_H
23
24 #include "SketcherPrs_SymbolPrs.h"
25 #include <ModelAPI_Feature.h>
26
27
28 DEFINE_STANDARD_HANDLE(SketcherPrs_Transformation, SketcherPrs_SymbolPrs)
29
30 /**
31 * \ingroup GUI
32 * A redefinition of standard AIS Interactive Object in order to provide  
33 * presentation of parallel constraint
34 */
35 class SketcherPrs_Transformation: public SketcherPrs_SymbolPrs
36 {
37 public:
38   /// Constructor
39   /// \param theConstraint a constraint feature
40   /// \param thePlane a coordinate plane of current sketch
41   /// \param isTranslation a flag is it translation or rotation
42   Standard_EXPORT SketcherPrs_Transformation(ModelAPI_Feature* theConstraint,
43                                          const std::shared_ptr<GeomAPI_Ax3>& thePlane,
44                                          bool isTranslation);
45
46   DEFINE_STANDARD_RTTIEXT(SketcherPrs_Transformation, SketcherPrs_SymbolPrs)
47
48   /// Returns true if the constraint feature arguments are correcly filled to build AIS presentation
49   /// \param theConstraint a constraint feature
50   /// \param thePlane a coordinate plane of current sketch
51   /// \return boolean result value
52   static bool IsReadyToDisplay(ModelAPI_Feature* theConstraint,
53                                const std::shared_ptr<GeomAPI_Ax3>& thePlane);
54 protected:
55   virtual const char* iconName() const { return myIsTranslation? "translate.png" : "rotate.png"; }
56
57   /// Redefine this function in order to add additiona lines of constraint base
58   /// \param thePrs a presentation
59   /// \param theColor a color of additiona lines
60   virtual void drawLines(const Handle(Prs3d_Presentation)& thePrs, Quantity_Color theColor) const;
61
62   /// Update myPntArray according to presentation positions
63   /// \return true in case of success
64   virtual bool updateIfReadyToDisplay(double theStep, bool withColor) const;
65
66 private:
67   bool myIsTranslation;
68 };
69
70 #endif