Salome HOME
Updated copyright comment
[modules/shaper.git] / src / SketcherPrs / SketcherPrs_Middle.h
1 // Copyright (C) 2014-2024  CEA, EDF
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_Middle_H
21 #define SketcherPrs_Middle_H
22
23 #include "SketcherPrs_SymbolPrs.h"
24
25
26 DEFINE_STANDARD_HANDLE(SketcherPrs_Middle, SketcherPrs_SymbolPrs)
27
28 /**
29 * \ingroup GUI
30 * A redefinition of standard AIS Interactive Object in order to provide  
31 * presentation of Equal constraint
32 */
33 class SketcherPrs_Middle: public SketcherPrs_SymbolPrs
34 {
35 public:
36   /// Constructor
37   /// \param theConstraint a constraint feature
38   /// \param theSketcher a sketcher object
39   Standard_EXPORT SketcherPrs_Middle(ModelAPI_Feature* theConstraint,
40     SketchPlugin_Sketch* theSketcher);
41   DEFINE_STANDARD_RTTIEXT(SketcherPrs_Middle, SketcherPrs_SymbolPrs)
42
43   /// Returns true if the constraint feature arguments are correcly filled to build AIS presentation
44   /// \param theConstraint a constraint feature
45   /// \param thePlane a coordinate plane of current sketch
46   /// \return boolean result value
47   static bool IsReadyToDisplay(ModelAPI_Feature* theConstraint,
48                                const std::shared_ptr<GeomAPI_Ax3>& thePlane);
49 protected:
50
51   virtual const char* iconName() const { return "middlepoint.png"; }
52
53   virtual void drawLines(const Handle(Prs3d_Presentation)& thePrs, Quantity_Color theColor) const;
54
55   /// Update myPntArray according to presentation positions
56   /// \return true in case of success
57   virtual bool updateIfReadyToDisplay(double theStep, bool withColor) const;
58
59   /// Draw shape of the object. Find shape result if the object is feature
60   void drawLine(const Handle(Prs3d_Presentation)& thePrs, Quantity_Color theColor,
61                 const ObjectPtr& theObject) const;
62 };
63
64 #endif