src/SketcherPrs/SketcherPrs_Perpendicular.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_Perpendicular_H
  22 #define SketcherPrs_Perpendicular_H
  23
  24 #include "SketcherPrs_SymbolPrs.h"
  25
  26 class SketchPlugin_Sketch;
  27
  28
  29 DEFINE_STANDARD_HANDLE(SketcherPrs_Perpendicular, SketcherPrs_SymbolPrs)
  30
  31 /**
  32 * \ingroup GUI
  33 * A redefinition of standard AIS Interactive Object in order to provide
  34 * presentation of perpendicular constraint
  35 */
  36 class SketcherPrs_Perpendicular: public SketcherPrs_SymbolPrs
  37 {
  38 public:
  39   /// Constructor
  40   /// \param theConstraint a constraint feature
  41   /// \param thePlane a coordinate plane of current sketch
  42   Standard_EXPORT SketcherPrs_Perpendicular(ModelAPI_Feature* theConstraint,
  43                                        const std::shared_ptr<GeomAPI_Ax3>& thePlane);
  44
  45   DEFINE_STANDARD_RTTIEXT(SketcherPrs_Perpendicular, SketcherPrs_SymbolPrs)
  46
  47   /// Returns true if the constraint feature arguments are correcly filled to build AIS presentation
  48   /// \param theConstraint a constraint feature
  49   /// \param thePlane a coordinate plane of current sketch
  50   /// \return boolean result value
  51   static bool IsReadyToDisplay(ModelAPI_Feature* theConstraint,
  52                                const std::shared_ptr<GeomAPI_Ax3>& thePlane);
  53 protected:
  54   virtual const char* iconName() const { return "perpendicular.png"; }
  55
  56   /// Redefine this function in order to add additiona lines of constraint base
  57   /// \param thePrs a presentation
  58   /// \param theColor a color of additiona lines
  59   virtual void drawLines(const Handle(Prs3d_Presentation)& thePrs, Quantity_Color theColor) const;
  60
  61   /// Update myPntArray according to presentation positions
  62   /// \return true in case of success
  63   virtual bool updateIfReadyToDisplay(double theStep, bool withColor) const;
  64 };
  65
  66 #endif