src/SketcherPrs/SketcherPrs_SymbolPrs.h

   1 // Copyright (C) 2014-2023  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_SymbolPrs_H
  21 #define SketcherPrs_SymbolPrs_H
  22
  23 #include "SketcherPrs_SensitivePoint.h"
  24 #include <SketchPlugin_Sketch.h>
  25 #include <ModelAPI_Feature.h>
  26 #include <ModelAPI_AttributeRefList.h>
  27
  28 #include <AIS_InteractiveObject.hxx>
  29 #include <GeomAPI_Ax3.h>
  30 #include <Graphic3d_ArrayOfPoints.hxx>
  31 #include <Graphic3d_AspectMarker3d.hxx>
  32 #include <Image_AlienPixMap.hxx>
  33 #include <SelectMgr_EntityOwner.hxx>
  34 #include <Select3D_EntitySequence.hxx>
  35
  36 #include <Standard_DefineHandle.hxx>
  37 #include <map>
  38
  39 #include <OpenGl_Workspace.hxx>
  40
  41 class OpenGl_Context;
  42
  43
  44 DEFINE_STANDARD_HANDLE(SketcherPrs_SymbolPrs, AIS_InteractiveObject)
  45
  46 class SketcherPrs_SymbolArray;
  47 /**
  48 * \ingroup GUI
  49 * A base class of constraint presentation which is represented by an icon
  50 */
  51 class SketcherPrs_SymbolPrs: public AIS_InteractiveObject
  52 {
  53 public:
  54   /// Constructor
  55   /// \param theConstraint a constraint feature
  56   /// \param thePlane a coordinate plane of current sketch
  57   Standard_EXPORT SketcherPrs_SymbolPrs(ModelAPI_Feature* theConstraint,
  58                                         SketchPlugin_Sketch* theSketcher);
  59
  60   virtual ~SketcherPrs_SymbolPrs();
  61
  62   //! Method which draws selected owners ( for fast presentation draw )
  63   Standard_EXPORT virtual void HilightSelected(const Handle(PrsMgr_PresentationManager3d)& thePM,
  64                                                const SelectMgr_SequenceOfOwner& theOwners);
  65
  66   //! Method which hilight an owner belonging to
  67   Standard_EXPORT virtual void HilightOwnerWithColor(
  68     const Handle(PrsMgr_PresentationManager3d)& thePM,
  69     const Handle(Prs3d_Drawer)& theStyle,
  70     const Handle(SelectMgr_EntityOwner)& theOwner);
  71
  72   /// Returns sketcher plane
  73   Standard_EXPORT std::shared_ptr<GeomAPI_Ax3> plane() const
  74   {
  75     return mySketcher->coordinatePlane();
  76   }
  77
  78   /// Returns feature object
  79   Standard_EXPORT ModelAPI_Feature* feature() const { return myConstraint; }
  80
  81   /// Returns Sketcher object (owner of the constraint)
  82   Standard_EXPORT ModelAPI_CompositeFeature* sketcher() const { return mySketcher; }
  83
  84   /// Return array of points where symbols will be placed
  85   const Handle(Graphic3d_ArrayOfPoints)& pointsArray() const { return myPntArray; }
  86
  87   /// Set state of the presentation, in case of conflicting state, the icon of the presentation is
  88   /// visualized in error color. The state is stored in an internal field, so should be changed
  89   /// when constraint become not conflicting
  90   /// \param theColor a color for conflicting object
  91   Standard_EXPORT void SetCustomColor(const std::vector<int>& theColor);
  92
  93   /// Add a bounding box of the presentation to common bounding box
  94   /// \param theBndBox the common bounding box to update
  95   Standard_EXPORT virtual void BoundingBox (Bnd_Box& theBndBox) Standard_OVERRIDE;
  96
  97   DEFINE_STANDARD_RTTIEXT(SketcherPrs_SymbolPrs, AIS_InteractiveObject)
  98
  99 protected:
 100   /// Redefinition of virtual function
 101   Standard_EXPORT virtual void Compute(
 102     const Handle(PrsMgr_PresentationManager3d)& thePresentationManager,
 103     const Handle(Prs3d_Presentation)& thePresentation, const Standard_Integer theMode = 0);
 104
 105   /// Redefinition of virtual function
 106   /// \param aSelection selection
 107   /// \param aMode compute mode
 108   Standard_EXPORT virtual void ComputeSelection(const Handle(SelectMgr_Selection)& aSelection,
 109     const Standard_Integer aMode);
 110
 111   /// Returns an icon file name. Has to be redefined in successors
 112   virtual const char* iconName() const = 0;
 113
 114   /// Check and creates if it is necessary myAspect member.
 115   /// It has to be called before the object computation
 116   virtual void prepareAspect();
 117
 118   /// Returns icon corresponded to the current constraint type
 119   Handle(Image_AlienPixMap) icon();
 120
 121   /// Add a line into the given group
 122   /// \param theGroup a group for drawing
 123   /// \param theAttrName an attribute name which corresponds to referenced line
 124   void addLine(const Handle(Graphic3d_Group)& theGroup, std::string theAttrName) const;
 125
 126   /// Redefine this function in order to add additiona lines of constraint base
 127   /// \param thePrs a presentation
 128   /// \param theColor a color of additiona lines
 129   virtual void drawLines(const Handle(Prs3d_Presentation)& /*thePrs*/,
 130                          Quantity_Color /*theColor*/) const {}
 131
 132   /// Update myPntArray according to presentation positions
 133   /// \return true in case of success
 134   virtual bool updateIfReadyToDisplay(double /*theStep*/, bool /*withColor*/) const { return true; }
 135
 136   /// Draw a shape into the given presentation scene
 137   /// \param theShape the shape to draw
 138   /// \param thePrs the presentation scene
 139   void drawShape(const std::shared_ptr<GeomAPI_Shape>& theShape,
 140     const Handle(Prs3d_Presentation)& thePrs, Quantity_Color theColor) const;
 141
 142   /// Draw a list of shapes stored in a RefListAttribute
 143   /// \param theListAttr the attribute of reference3s list
 144   /// \param thePrs the presentation scene
 145   void drawListOfShapes(const std::shared_ptr<ModelAPI_AttributeRefList>& theListAttr,
 146                         const Handle(Prs3d_Presentation)& thePrs, Quantity_Color theColor) const;
 147
 148 protected:
 149   /// Constraint feature
 150   ModelAPI_Feature* myConstraint;
 151
 152   /// Sketcher feature
 153   SketchPlugin_Sketch* mySketcher;
 154
 155   /// Aspect for entities drawing
 156   Handle(Graphic3d_AspectMarker3d) myAspect;
 157
 158   /// Array of symbols positions
 159   mutable Handle(Graphic3d_ArrayOfPoints) myPntArray;
 160
 161   /// An owner object of the presentation
 162   Handle(SelectMgr_EntityOwner) myOwner;
 163
 164 private:
 165   /// Static map to collect constraints icons {IconName : IconPixMap}
 166   static std::map<const char*, Handle(Image_AlienPixMap)> myIconsMap;
 167
 168   Select3D_EntitySequence mySPoints;
 169
 170   bool myIsCustomColor; /// state if the presentation is visualized in custom color
 171   Quantity_Color myCustomColor; /// the color of mid ring if there is a conflict
 172
 173   //bool myIsConflicting; /// state if the presentation is visualized in error state
 174   Handle(Image_AlienPixMap) myErrorIcon;
 175   Handle(Graphic3d_MarkerImage) myErrorImage;
 176
 177   friend class SketcherPrs_SymbolArray;
 178 };
 179
 180 #endif