Salome HOME
Issue #653 - Double and triple click edges -- Fix Debian dynamic_pointer_cast problem...
[modules/shaper.git] / src / ModuleBase / ModuleBase_ViewerPrs.h
index 6dec54b93b605eb2aa7442bd3f89a5f38f0bcfec..419447edb1096006ce2c438123e49df921dd9a14 100644 (file)
 #include <ModelAPI_Result.h>
 
 /**\class ModuleBase_ViewerPrs
- * \ingroup Module base
+ * \ingroup GUI
  * \brief Presentation. Provides container to have feature, shape and/or selection owner.
  */
-class ModuleBase_ViewerPrs
+class MODULEBASE_EXPORT ModuleBase_ViewerPrs
 {
  public:
   /// Constructor
-  ModuleBase_ViewerPrs()
-  {
-  }
+  ModuleBase_ViewerPrs();
 
   /// Constructor
-  /// \param theFeature a model feature
+  /// \param theResult an object
   /// \param theShape a viewer shape
   /// \param theOwner a selection owner
   ModuleBase_ViewerPrs(ObjectPtr theResult, const TopoDS_Shape& theShape,
-                       Handle_SelectMgr_EntityOwner theOwner)
-      : myResult(theResult),
-        myShape(theShape),
-        myOwner(theOwner)
-  {
-  }
+                       Handle_SelectMgr_EntityOwner theOwner);
 
   /// Destructor
-  virtual ~ModuleBase_ViewerPrs()
-  {
-  }
+  virtual ~ModuleBase_ViewerPrs();
 
-  /// Sets the feature.
-  /// \param theFeature a feature instance
-  void setFeature(ObjectPtr theResult)
+  /// Sets the object.
+  /// \param theResult an object instance
+  void setObject(ObjectPtr theResult)
   {
     myResult = theResult;
   }
@@ -59,8 +50,8 @@ class ModuleBase_ViewerPrs
     return myResult;
   }
 
-  /// Returns the presentation owner
-  /// \param the owner
+  /// Set the presentation owner
+  /// \param theOwner an owner to set
   void setOwner(Handle_SelectMgr_EntityOwner theOwner)
   {
     myOwner = theOwner;
@@ -87,16 +78,29 @@ class ModuleBase_ViewerPrs
     return myShape;
   }
 
+  /// Set interactive object
+  /// \param theIO an interactive object
   void setInteractive(const Handle(AIS_InteractiveObject)& theIO)
   {
     myInteractive = theIO;
   }
 
+  /// Returns interactive object if it is installed
   Handle(AIS_InteractiveObject) interactive() const
   {
     return myInteractive;
   }
 
+  /// Returns true if all presentation fields are empty
+  /// \return boolean value
+  bool isEmpty() const
+  {
+    return myShape.IsNull() &&
+           myOwner.IsNull() && !myResult.get();
+  }
+
+  /// Returns True if the current object is equal to the given one
+  /// \param thePrs an object to compare
   bool operator==(const ModuleBase_ViewerPrs& thePrs)
   {
     bool aResult = (myResult.get() == thePrs.object().get());
@@ -110,7 +114,7 @@ class ModuleBase_ViewerPrs
   ObjectPtr myResult;  /// the feature
   Handle(SelectMgr_EntityOwner) myOwner;  /// the selection owner
   TopoDS_Shape myShape;  /// the shape
-  Handle(AIS_InteractiveObject) myInteractive;
+  Handle(AIS_InteractiveObject) myInteractive;  /// interactive object
 };
 
 #endif