Salome HOME
Copyright update 2022
[modules/shaper.git] / src / ModuleBase / ModuleBase_ResultPrs.h
index e6f2e3e7e41daa59c485b66a6661e6e4328a78d4..5607c2bb08437a54cc6c4e1ee6b24326916a3fd6 100644 (file)
@@ -1,8 +1,21 @@
-// Copyright (C) 2014-20xx CEA/DEN, EDF R&D
-
-// File:        ModuleBase_ResultPrs.h
-// Created:     21 October 2014
-// Author:      Vitaly SMETANNIKOV
+// Copyright (C) 2014-2022  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
+//
 
 #ifndef ModuleBase_ResultPrs_H
 #define ModuleBase_ResultPrs_H
 #include "ModuleBase.h"
 
 #include <ModelAPI_Result.h>
+#include <ModelAPI_ResultField.h>
 
+#include <BRep_Builder.hxx>
+#include <NCollection_List.hxx>
 #include <ViewerData_AISShape.hxx>
 #include <Standard_DefineHandle.hxx>
-#include <StdSelect_BRepOwner.hxx>
-
-DEFINE_STANDARD_HANDLE(ModuleBase_BRepOwner, StdSelect_BRepOwner)
-
-/**
-* \ingroup GUI
-* A redefinition of standard BRep Owner in order to provide specific selection
-* of CompSolid objects. This owner is created only for selection mode TopAbs_COMPSOLID
-*/
-class ModuleBase_BRepOwner: public StdSelect_BRepOwner
-{
-public:
-  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)
-};
+#include <TopoDS_Compound.hxx>
+#include <Prs3d_IsoAspect.hxx>
 
+#include <QMap>
 
+class AIS_ColoredDrawer;
+class AIS_InteractiveContext;
 
 DEFINE_STANDARD_HANDLE(ModuleBase_ResultPrs, ViewerData_AISShape)
 
@@ -48,70 +46,138 @@ 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(Prs3d_Drawer)& theStyle,
+                                        const Handle(SelectMgr_EntityOwner)& theOwner);
 
   /// Returns result object
   Standard_EXPORT ResultPtr getResult() const { return myResult; }
 
-  /// Returns True if the presentation is in sketch mode
-  Standard_EXPORT bool isSketchMode() const { return myIsSketchMode; }
+  /// 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);
+
+  //! Updates color of sub shape drawer
+  Standard_EXPORT virtual void SetColor (const Quantity_Color& theColor);
+
+  /// Change presentation to have given shape hidden.
+  /// It suports FACE type of the shape to be hidden.
+  /// If presentation type is greater than FACE, the SHELL with be shown with the FACE hidden
+  /// It is possible to hide more than one FACE by calling the method with given FACES
+  /// Visual state of the face is controlled by the second parameter
+  /// \param theShapes a container of shape objects
+  /// \returns true if the presentation is changed, or false (if for example it was hidden)
+  Standard_EXPORT void setSubShapeHidden(const TopoDS_ListOfShape& theShapes);
+
+  /// Returns true if parameter shape has been hidden
+  /// \param theShape sub-shape of the presentation shape
+  /// \return boolean value
+  Standard_EXPORT bool isSubShapeHidden(const TopoDS_Shape& theShape);
+
+  /// Returns hidden sub shapes list
+  Standard_EXPORT const TopoDS_ListOfShape& hiddenSubShapes() const
+  { return myHiddenSubShapes; }
+
+  /// Returns true if there are no hidden sub shapes or original shape has at least one not hidden
+  /// \param theShapesToSkip container of shape to be hidden in the presentation (faces)
+  /// \return boolean value
+  Standard_EXPORT bool hasSubShapeVisible(const TopoDS_ListOfShape& theShapesToSkip);
+
+  /// Set transparency of hidden sub shapes: if value is 1, shapes are entirely hidden
+  /// \param theTransparency transparency value
+  /// \return false if parameter is out of [0, 1]
+  Standard_EXPORT bool setHiddenSubShapeTransparency(double theTransparency);
 
-  /// Returns a list of faces
-  Standard_EXPORT const std::list<std::shared_ptr<GeomAPI_Shape> >& facesList() { return myFacesList; }
+  /// Returns the original shape of the presentation
+  Standard_EXPORT TopoDS_Shape originalShape() const { return myOriginalShape; }
 
-  /// Returns true if the object is used in CompSolid selection mode
-  Standard_EXPORT bool hasCompSolidSelectionMode() const;
+  /// Returns True if the original shape is substituted by a corresponded shell
+  Standard_EXPORT bool isSubstituted() const { return myIsSubstituted; }
+
+  Standard_EXPORT void updateIsoLines();
+
+  DEFINE_STANDARD_RTTIEXT(ModuleBase_ResultPrs, ViewerData_AISShape)
 
-  DEFINE_STANDARD_RTTI(ModuleBase_ResultPrs)
 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
   Standard_EXPORT virtual void ComputeSelection(const Handle(SelectMgr_Selection)& aSelection,
-    const Standard_Integer aMode) ;
+                                                const Standard_Integer theMode) ;
 
 private:
-  /// Appens sensitive and owners for wires of the given shape into selection
+  /// If the shape of this presentation is Vertex, it appends custom sensitive and owners for it.
+  /// Owner is a usual Brep owner with "isDecomposite" in true. It is necessary to have "Ring"
+  /// highlight/selected marker.
   /// \param theSelection a current filled selection
-  /// \param theShape a shape
-  void appendWiresSelection(const Handle(SelectMgr_Selection)& theSelection,
-                            const TopoDS_Shape& theShape);
-  /// Returns shape dependent on CompSolid selection mode
-  /// In case CompSolid selection mode it returns parent's compsolid shape
-  TopoDS_Shape getSelectionShape() const;
+  /// \param theMode a selection mode
+  /// \return true if the owner is created
+  bool appendVertexSelection(const Handle(SelectMgr_Selection)& aSelection,
+                             const Standard_Integer theMode);
+
+  /// Creates compound of vertices, edges and faces.
+  /// If the shape is COMPOUND, iterate by sub-shapes.
+  /// If the shape is SOLID/SHEL, explore shape by FACES,
+  /// If the shape is WIRE, explore shape by EDGES
+  /// \param theBuilder result compound builder
+  /// \param theCompound the result shape
+  /// \param theShape the processed shape
+  /// \param theHiddenSubShapes container of shapes to be skipped (faces)
+  void collectSubShapes(BRep_Builder& theBuilder, TopoDS_Shape& theCompound,
+    const TopoDS_Shape& theShape, const TopoDS_ListOfShape& theHiddenSubShapes);
+
+  void setEdgesDefaultColor();
 
+private:
   /// Reference to result object
   ResultPtr myResult;
 
-  /// A sketch mode flag
-  bool myIsSketchMode;
-
   /// Original shape of the result object
   TopoDS_Shape myOriginalShape;
 
-  /// List of faces
-  std::list<std::shared_ptr<GeomAPI_Shape> > myFacesList;
+  bool myIsSubstituted;
+
+  /// Container of original Shape sub shape to be hidden and not selectable
+  TopoDS_ListOfShape myHiddenSubShapes;
+  TopoDS_Compound myVisibleCompound; /// compound of hidden sub shapes
+  TopoDS_Compound myHiddenCompound; /// compound of hidden sub shapes
+  double myTransparency; ///< transparency of hidden shapes, where 0 - there is no transparency
+  Handle(AIS_ColoredDrawer) myHiddenSubShapesDrawer; ///< drawer for hidden sub shapes
+
+  /// selection priority that will be added to the standard
+  /// selection priority of the selection entity
+  int myAdditionalSelectionPriority;
+
+  Handle(Prs3d_IsoAspect) myUIsoAspect;
+  Handle(Prs3d_IsoAspect) myVIsoAspect;
 };