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