Salome HOME
updated copyright message
[modules/shaper.git] / src / SketcherPrs / SketcherPrs_SymbolPrs.h
index 91ab4a27c944f29c78057c502b0e63ad127d0a81..d83d931a87bacf1c62c35aa1050ff3a6aca56bb3 100644 (file)
@@ -1,13 +1,27 @@
-// Copyright (C) 2014-20xx CEA/DEN, EDF R&D
-
-// File:        SketcherPrs_SymbolPrs.h
-// Created:     12 March 2015
-// Author:      Vitaly SMETANNIKOV
+// Copyright (C) 2014-2023  CEA, EDF
+//
+// This library is free software; you can redistribute it and/or
+// modify it under the terms of the GNU Lesser General Public
+// License as published by the Free Software Foundation; either
+// version 2.1 of the License, or (at your option) any later version.
+//
+// This library is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+// Lesser General Public License for more details.
+//
+// You should have received a copy of the GNU Lesser General Public
+// License along with this library; if not, write to the Free Software
+// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
+//
+// See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
+//
 
 #ifndef SketcherPrs_SymbolPrs_H
 #define SketcherPrs_SymbolPrs_H
 
 #include "SketcherPrs_SensitivePoint.h"
+#include <SketchPlugin_Sketch.h>
 #include <ModelAPI_Feature.h>
 #include <ModelAPI_AttributeRefList.h>
 
@@ -29,7 +43,7 @@ class OpenGl_Context;
 
 DEFINE_STANDARD_HANDLE(SketcherPrs_SymbolPrs, AIS_InteractiveObject)
 
-class SketcherPrs_Element;
+class SketcherPrs_SymbolArray;
 /**
 * \ingroup GUI
 * A base class of constraint presentation which is represented by an icon
@@ -41,7 +55,7 @@ public:
   /// \param theConstraint a constraint feature
   /// \param thePlane a coordinate plane of current sketch
   Standard_EXPORT SketcherPrs_SymbolPrs(ModelAPI_Feature* theConstraint,
-                        const std::shared_ptr<GeomAPI_Ax3>& thePlane);
+                                        SketchPlugin_Sketch* theSketcher);
 
   virtual ~SketcherPrs_SymbolPrs();
 
@@ -50,28 +64,31 @@ public:
                                                const SelectMgr_SequenceOfOwner& theOwners);
 
   //! Method which hilight an owner belonging to
-  //! this selectable object  ( for fast presentation draw )
   Standard_EXPORT virtual void HilightOwnerWithColor(
     const Handle(PrsMgr_PresentationManager3d)& thePM,
-    const Handle(Graphic3d_HighlightStyle)& theStyle,
+    const Handle(Prs3d_Drawer)& theStyle,
     const Handle(SelectMgr_EntityOwner)& theOwner);
 
   /// Returns sketcher plane
-  Standard_EXPORT std::shared_ptr<GeomAPI_Ax3> plane() const { return myPlane; }
+  Standard_EXPORT std::shared_ptr<GeomAPI_Ax3> plane() const
+  {
+    return mySketcher->coordinatePlane();
+  }
 
   /// Returns feature object
   Standard_EXPORT ModelAPI_Feature* feature() const { return myConstraint; }
 
+  /// Returns Sketcher object (owner of the constraint)
+  Standard_EXPORT ModelAPI_CompositeFeature* sketcher() const { return mySketcher; }
+
   /// Return array of points where symbols will be placed
   const Handle(Graphic3d_ArrayOfPoints)& pointsArray() const { return myPntArray; }
 
   /// Set state of the presentation, in case of conflicting state, the icon of the presentation is
   /// visualized in error color. The state is stored in an internal field, so should be changed
   /// when constraint become not conflicting
-  /// \param theConflicting a state
   /// \param theColor a color for conflicting object
-  Standard_EXPORT void SetConflictingConstraint(const bool& theConflicting,
-                                                const std::vector<int>& theColor);
+  Standard_EXPORT void SetCustomColor(const std::vector<int>& theColor);
 
   /// Add a bounding box of the presentation to common bounding box
   /// \param theBndBox the common bounding box to update
@@ -109,30 +126,31 @@ protected:
   /// Redefine this function in order to add additiona lines of constraint base
   /// \param thePrs a presentation
   /// \param theColor a color of additiona lines
-  virtual void drawLines(const Handle(Prs3d_Presentation)& thePrs, Quantity_Color theColor) const {}
+  virtual void drawLines(const Handle(Prs3d_Presentation)& /*thePrs*/,
+                         Quantity_Color /*theColor*/) const {}
 
   /// Update myPntArray according to presentation positions
   /// \return true in case of success
-  virtual bool updateIfReadyToDisplay(double theStep) const { return true; }
+  virtual bool updateIfReadyToDisplay(double /*theStep*/, bool /*withColor*/) const { return true; }
 
   /// Draw a shape into the given presentation scene
   /// \param theShape the shape to draw
   /// \param thePrs the presentation scene
   void drawShape(const std::shared_ptr<GeomAPI_Shape>& theShape,
-    const Handle(Prs3d_Presentation)& thePrs) const;
+    const Handle(Prs3d_Presentation)& thePrs, Quantity_Color theColor) const;
 
   /// Draw a list of shapes stored in a RefListAttribute
   /// \param theListAttr the attribute of reference3s list
   /// \param thePrs the presentation scene
   void drawListOfShapes(const std::shared_ptr<ModelAPI_AttributeRefList>& theListAttr,
-                        const Handle(Prs3d_Presentation)& thePrs) const;
+                        const Handle(Prs3d_Presentation)& thePrs, Quantity_Color theColor) const;
 
 protected:
   /// Constraint feature
   ModelAPI_Feature* myConstraint;
 
-  /// Plane of the current sketcher
-  std::shared_ptr<GeomAPI_Ax3> myPlane;
+  /// Sketcher feature
+  SketchPlugin_Sketch* mySketcher;
 
   /// Aspect for entities drawing
   Handle(Graphic3d_AspectMarker3d) myAspect;
@@ -149,11 +167,14 @@ private:
 
   Select3D_EntitySequence mySPoints;
 
-  bool myIsConflicting; /// state if the presentation is visualized in error state
+  bool myIsCustomColor; /// state if the presentation is visualized in custom color
+  Quantity_Color myCustomColor; /// the color of mid ring if there is a conflict
+
+  //bool myIsConflicting; /// state if the presentation is visualized in error state
   Handle(Image_AlienPixMap) myErrorIcon;
   Handle(Graphic3d_MarkerImage) myErrorImage;
 
-  friend class SketcherPrs_Element;
+  friend class SketcherPrs_SymbolArray;
 };
 
 #endif
\ No newline at end of file