Temporary commit proposed by DBV: to make unit-tests working while the compsolids...

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

diff --git a/src/ModuleBase/ModuleBase_ResultPrs.h b/src/ModuleBase/ModuleBase_ResultPrs.h
index 941ef15c4cb85591138c391e83f87198fa09679b..0389241a033826f128d5a6dc099c803c5176b2e7 100644 (file)
--- a/src/ModuleBase/ModuleBase_ResultPrs.h
+++ b/src/ModuleBase/ModuleBase_ResultPrs.h
@@ -11,32 +11,53 @@
 
 #include <ModelAPI_Result.h>
 
-#include <AIS_Shape.hxx>
+#include <ViewerData_AISShape.hxx>
 #include <Standard_DefineHandle.hxx>
 
-DEFINE_STANDARD_HANDLE(ModuleBase_ResultPrs, AIS_Shape)
+DEFINE_STANDARD_HANDLE(ModuleBase_ResultPrs, ViewerData_AISShape)
 
-class ModuleBase_ResultPrs: public AIS_Shape
+/**
+* \ingroup GUI
+* A redefinition of standard AIS Interactive Object in order to provide specific behaviour 
+* for wire presentations based in a one plane
+*/
+class ModuleBase_ResultPrs: public ViewerData_AISShape
 {
 public:
+  /// Constructor
+  /// \param theResult a result object
   Standard_EXPORT ModuleBase_ResultPrs(ResultPtr theResult);
 
+  /// 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 a list of faces
+  Standard_EXPORT const std::list<std::shared_ptr<GeomAPI_Shape> >& facesList() { return myFacesList; }
+
   DEFINE_STANDARD_RTTI(ModuleBase_ResultPrs)
 protected:
+  /// Redefinition of virtual function
   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) ;
 
 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;
 };