Salome HOME
Issue #2208: Development in progress
[modules/shaper.git] / src / SketcherPrs / SketcherPrs_SymbolPrs.h
index 91b2323ac5e74f7dfcfd1c8696f625877c69ca9e..5d28c1dd1a408e7ca059954a817ce4d30ab9753c 100644 (file)
@@ -1,14 +1,30 @@
-// Copyright (C) 2014-20xx CEA/DEN, EDF R&D
-
-// File:        SketcherPrs_SymbolPrs.h
-// Created:     12 March 2015
-// Author:      Vitaly SMETANNIKOV
+// Copyright (C) 2014-2017  CEA/DEN, EDF R&D
+//
+// 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<mailto:webmaster.salome@opencascade.com>
+//
 
 #ifndef SketcherPrs_SymbolPrs_H
 #define SketcherPrs_SymbolPrs_H
 
 #include "SketcherPrs_SensitivePoint.h"
 #include <ModelAPI_Feature.h>
+#include <ModelAPI_AttributeRefList.h>
+#include <ModelAPI_CompositeFeature.h>
 
 #include <AIS_InteractiveObject.hxx>
 #include <GeomAPI_Ax3.h>
@@ -16,7 +32,7 @@
 #include <Graphic3d_AspectMarker3d.hxx>
 #include <Image_AlienPixMap.hxx>
 #include <SelectMgr_EntityOwner.hxx>
-#include <Select3D_SensitiveEntitySequence.hxx>
+#include <Select3D_EntitySequence.hxx>
 
 #include <Standard_DefineHandle.hxx>
 #include <map>
@@ -28,6 +44,7 @@ class OpenGl_Context;
 
 DEFINE_STANDARD_HANDLE(SketcherPrs_SymbolPrs, AIS_InteractiveObject)
 
+class SketcherPrs_SymbolArray;
 /**
 * \ingroup GUI
 * A base class of constraint presentation which is represented by an icon
@@ -38,44 +55,56 @@ public:
   /// Constructor
   /// \param theConstraint a constraint feature
   /// \param thePlane a coordinate plane of current sketch
-  Standard_EXPORT SketcherPrs_SymbolPrs(ModelAPI_Feature* theConstraint, 
+  Standard_EXPORT SketcherPrs_SymbolPrs(ModelAPI_Feature* theConstraint,
+                        ModelAPI_CompositeFeature* theSketcher,
                         const std::shared_ptr<GeomAPI_Ax3>& thePlane);
-  
-  virtual ~SketcherPrs_SymbolPrs();
-
-  //! Method which clear all selected owners belonging
-  //! to this selectable object ( for fast presentation draw )
-  Standard_EXPORT virtual void ClearSelected();
 
+  virtual ~SketcherPrs_SymbolPrs();
 
   //! Method which draws selected owners ( for fast presentation draw )
-  Standard_EXPORT virtual void HilightSelected(const Handle(PrsMgr_PresentationManager3d)& thePM, 
+  Standard_EXPORT virtual void HilightSelected(const Handle(PrsMgr_PresentationManager3d)& thePM,
                                                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 Quantity_NameOfColor theColor, const Handle(SelectMgr_EntityOwner)& theOwner);
+  Standard_EXPORT virtual void HilightOwnerWithColor(
+    const Handle(PrsMgr_PresentationManager3d)& thePM,
+    const Handle(Graphic3d_HighlightStyle)& theStyle,
+    const Handle(SelectMgr_EntityOwner)& theOwner);
 
+  /// Returns sketcher plane
   Standard_EXPORT std::shared_ptr<GeomAPI_Ax3> plane() const { return myPlane; }
 
+  /// 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; }
 
-  Handle(Graphic3d_ArrayOfPoints) pointsArray() const { return myPntArray; }
+  /// Return array of points where symbols will be placed
+  const Handle(Graphic3d_ArrayOfPoints)& pointsArray() const { return myPntArray; }
 
-  void Render(const Handle(OpenGl_Workspace)& theWorkspace) const;
+  /// 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 theColor a color for conflicting object
+  Standard_EXPORT void SetCustomColor(const std::vector<int>& theColor);
 
-  void Release (OpenGl_Context* theContext);
+  /// Add a bounding box of the presentation to common bounding box
+  /// \param theBndBox the common bounding box to update
+  Standard_EXPORT virtual void BoundingBox (Bnd_Box& theBndBox) Standard_OVERRIDE;
 
-  DEFINE_STANDARD_RTTI(SketcherPrs_SymbolPrs)
+  DEFINE_STANDARD_RTTIEXT(SketcherPrs_SymbolPrs, AIS_InteractiveObject)
 
 protected:
   /// Redefinition of virtual function
-  Standard_EXPORT virtual void Compute(const Handle(PrsMgr_PresentationManager3d)& thePresentationManager,
+  Standard_EXPORT virtual void Compute(
+    const Handle(PrsMgr_PresentationManager3d)& thePresentationManager,
     const Handle(Prs3d_Presentation)& thePresentation, const Standard_Integer theMode = 0);
 
   /// Redefinition of virtual function
+  /// \param aSelection selection
+  /// \param aMode compute mode
   Standard_EXPORT virtual void ComputeSelection(const Handle(SelectMgr_Selection)& aSelection,
     const Standard_Integer aMode);
 
@@ -101,16 +130,27 @@ protected:
 
   /// Update myPntArray according to presentation positions
   /// \return true in case of success
-  virtual bool updatePoints(double theStep) const { return true; }
+  virtual bool updateIfReadyToDisplay(double theStep, bool withColor) const { return true; }
 
-  void drawShape(const std::shared_ptr<GeomAPI_Shape>& theShape, 
-    const Handle(Prs3d_Presentation)& thePrs) const;
+  /// 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, 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, Quantity_Color theColor) const;
 
 protected:
   /// Constraint feature
   ModelAPI_Feature* myConstraint;
 
+  /// Sketcher feature
+  ModelAPI_CompositeFeature* mySketcher;
+
   /// Plane of the current sketcher
   std::shared_ptr<GeomAPI_Ax3> myPlane;
 
@@ -120,15 +160,23 @@ protected:
   /// Array of symbols positions
   mutable Handle(Graphic3d_ArrayOfPoints) myPntArray;
 
+  /// An owner object of the presentation
   Handle(SelectMgr_EntityOwner) myOwner;
 
-private: 
+private:
   /// Static map to collect constraints icons {IconName : IconPixMap}
   static std::map<const char*, Handle(Image_AlienPixMap)> myIconsMap;
 
-  mutable Handle(OpenGl_VertexBuffer) myVboAttribs;
+  Select3D_EntitySequence mySPoints;
+
+  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;
 
-  Select3D_SensitiveEntitySequence mySPoints;
+  friend class SketcherPrs_SymbolArray;
 };
 
 #endif
\ No newline at end of file