Extension of Parameters interface: to set/get double values of results

[modules/shaper.git] / src / ModuleBase / ModuleBase_ResultPrs.h

diff --git a/src/ModuleBase/ModuleBase_ResultPrs.h b/src/ModuleBase/ModuleBase_ResultPrs.h
index 165406ec294928b040d3911c521c86409797efc8..19a84f59a3ee153fda2664759e370a0f28e9bd5c 100644 (file)
--- a/src/ModuleBase/ModuleBase_ResultPrs.h
+++ b/src/ModuleBase/ModuleBase_ResultPrs.h
@@ -15,6 +15,8 @@
 #include <Standard_DefineHandle.hxx>
 #include <StdSelect_BRepOwner.hxx>
 
+#include <QMap>
+
 DEFINE_STANDARD_HANDLE(ModuleBase_BRepOwner, StdSelect_BRepOwner)
 
 /**
@@ -25,16 +27,26 @@ DEFINE_STANDARD_HANDLE(ModuleBase_BRepOwner, StdSelect_BRepOwner)
 class ModuleBase_BRepOwner: public StdSelect_BRepOwner
 {
 public:
-  ModuleBase_BRepOwner(const TopoDS_Shape& aShape, 
-    const Standard_Integer aPriority = 0, 
+  /// Constructor
+  /// \param aShape an owner shape
+  /// \param aPriority drawig priority
+  /// \param ComesFromDecomposition decomposition flag
+  ModuleBase_BRepOwner(const TopoDS_Shape& aShape,
+    const Standard_Integer aPriority = 0,
     const Standard_Boolean ComesFromDecomposition = Standard_False)
     : StdSelect_BRepOwner(aShape, aPriority, ComesFromDecomposition) {}
 
-  virtual void HilightWithColor (const Handle(PrsMgr_PresentationManager3d)& aPM, 
-    const Quantity_NameOfColor aCol, const Standard_Integer aMode = 0)
-  {  Selectable()->HilightOwnerWithColor(aPM, aCol, this); }
-
-  DEFINE_STANDARD_RTTI(ModuleBase_BRepOwner)
+  /// Highlight the presentation with the given color
+  /// \param aPM a presentations manager
+  /// \param theStyle a style of presentation
+  /// \param aMode a drawing mode
+  virtual void HilightWithColor (const Handle(PrsMgr_PresentationManager3d)& aPM,
+    const Handle(Graphic3d_HighlightStyle)& theStyle, const Standard_Integer aMode = 0)
+  {
+    Selectable()->HilightOwnerWithColor(aPM, theStyle, this);
+  }
+
+  DEFINE_STANDARD_RTTIEXT(ModuleBase_BRepOwner, StdSelect_BRepOwner)
 };
 
 
@@ -48,34 +60,47 @@ DEFINE_STANDARD_HANDLE(ModuleBase_ResultPrs, ViewerData_AISShape)
 */
 class ModuleBase_ResultPrs: public ViewerData_AISShape
 {
+public:
+  enum SelectionModes {
+    Sel_Result = TopAbs_SHAPE + 1 /// it should be combined with Compsolid results, so it is not
+                                  /// the Shape type. It is not defined in XML as compound type
+                                  /// because this type is processed as shape with compounds inside.
+  };
+
 public:
   /// Constructor
   /// \param theResult a result object
   Standard_EXPORT ModuleBase_ResultPrs(ResultPtr theResult);
 
-  /// Returns true if the checked type can be accepted for the base selection type
-  /// It returns true if they are coicide or if the base type is face and the checked type is wire
-  /// @return boolean result
-  static Standard_EXPORT bool isValidShapeType(const TopAbs_ShapeEnum& theBaseType,
-                                               const TopAbs_ShapeEnum& theCheckedType);
-
-
   //! 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 result object
   Standard_EXPORT ResultPtr getResult() const { return myResult; }
 
-  DEFINE_STANDARD_RTTI(ModuleBase_ResultPrs)
+  /// Returns selection priorities that will be added to created selection owner
+  /// \return integer value
+  Standard_EXPORT int getAdditionalSelectionPriority() const
+  { return myAdditionalSelectionPriority; }
+
+  /// Appends a special priority for the mode of selection
+  /// \param theSelectionMode a mode of selection, used in ComputeSelection
+  /// \param thePriority a new priority value
+  Standard_EXPORT void setAdditionalSelectionPriority(const int thePriority);
+
+  DEFINE_STANDARD_RTTIEXT(ModuleBase_ResultPrs, ViewerData_AISShape)
 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
@@ -94,6 +119,10 @@ private:
 
   /// Original shape of the result object
   TopoDS_Shape myOriginalShape;
+
+  /// selection priority that will be added to the standard
+  /// selection priority of the selection entity
+  int myAdditionalSelectionPriority;
 };