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