src/SketcherPrs/SketcherPrs_Coincident.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_Coincident_H
  21 #define SketcherPrs_Coincident_H
  22
  23 #include <GeomAPI_Ax3.h>
  24 #include <SketchPlugin_Sketch.h>
  25 #include <ModelAPI_Feature.h>
  26
  27 #include <AIS_InteractiveObject.hxx>
  28 #include <Standard_DefineHandle.hxx>
  29
  30
  31 DEFINE_STANDARD_HANDLE(SketcherPrs_Coincident, AIS_InteractiveObject)
  32
  33 /**
  34 * \ingroup GUI
  35 * A redefinition of standard AIS Interactive Object in order to provide
  36 * presentation of coincident constraint
  37 */
  38 class SketcherPrs_Coincident: public AIS_InteractiveObject
  39 {
  40 public:
  41   /// Constructor
  42   /// \param theConstraint a constraint object
  43   /// \param thePlane plane of a sketch
  44   Standard_EXPORT SketcherPrs_Coincident(ModelAPI_Feature* theConstraint,
  45     SketchPlugin_Sketch* theSketch);
  46
  47   /// Defines color for the presentation
  48   /// \param aColor a color object
  49   Standard_EXPORT virtual void SetColor(const Quantity_Color& aColor);
  50
  51   /// Defines color for the presentation
  52   /// \param aColor a color name
  53   Standard_EXPORT virtual void SetColor(const Quantity_NameOfColor aColor);
  54
  55   /// Set state of the presentation, in case of custom color, the icon of the presentation is
  56   /// visualized in error color.
  57   /// \param theColor a custom color for object presentation
  58   Standard_EXPORT void SetCustomColor(const std::vector<int>& theColor);
  59
  60   /// Returns true if the constraint feature arguments are correcly filled to build AIS presentation
  61   /// \param theConstraint a constraint feature
  62   /// \param thePlane a coordinate plane of current sketch
  63   /// \return boolean result value
  64   static bool IsReadyToDisplay(ModelAPI_Feature* theConstraint,
  65                                const std::shared_ptr<GeomAPI_Ax3>& thePlane);
  66
  67   DEFINE_STANDARD_RTTIEXT(SketcherPrs_Coincident, AIS_InteractiveObject)
  68 protected:
  69   /// Redefinition of virtual function
  70   Standard_EXPORT virtual void Compute(
  71     const Handle(PrsMgr_PresentationManager3d)& thePresentationManager,
  72     const Handle(Prs3d_Presentation)& thePresentation, const Standard_Integer theMode = 0);
  73
  74   /// Redefinition of virtual function
  75   Standard_EXPORT virtual void ComputeSelection(const Handle(SelectMgr_Selection)& aSelection,
  76     const Standard_Integer aMode) ;
  77
  78 private:
  79   static bool readyToDisplay(ModelAPI_Feature* theConstraint,
  80                       const std::shared_ptr<GeomAPI_Ax3>& thePlane,
  81                       gp_Pnt& thePoint);
  82
  83 private:
  84   ModelAPI_Feature* myConstraint;
  85   SketchPlugin_Sketch* mySketch;
  86   gp_Pnt myPoint;
  87   bool myIsCustomColor; /// state if the presentation is visualized in custom color
  88   Quantity_Color myCustomColor; /// the color of mid ring if there is a conflict
  89 };
  90
  91
  92 #endif