]> SALOME platform Git repositories - modules/shaper.git/commitdiff
Salome HOME
Update documentation
authorvsv <vitaly.smetannikov@opencascade.com>
Fri, 17 Apr 2015 13:06:32 +0000 (16:06 +0300)
committervsv <vitaly.smetannikov@opencascade.com>
Fri, 17 Apr 2015 13:06:32 +0000 (16:06 +0300)
src/GeomAPI/GeomAPI_Ax3.h
src/PartSet/PartSet_Module.h
src/PartSet/PartSet_SketcherMgr.h
src/SketcherPrs/SketcherPrs_SensitivePoint.h
src/SketcherPrs/SketcherPrs_SymbolPrs.h
src/XGUI/XGUI_ContextMenuMgr.h
src/XGUI/XGUI_Displayer.h
src/XGUI/XGUI_ObjectsBrowser.cpp

index 6a554e2b393b3f2516cd7ed9a368fccb92524bf5..bd66173a1cb40ca97d1af5da5caae64cc523712e 100644 (file)
@@ -25,7 +25,6 @@ public:
   /// Ñonstructor
   /// \param theOrigin point of origin
   /// \param theDirX direction of X axis
-  /// \param theDirY direction of Y axis
   /// \param theNorm direction of normal vector
   GeomAPI_Ax3(std::shared_ptr<GeomAPI_Pnt> theOrigin,
               std::shared_ptr<GeomAPI_Dir> theDirX,
index fe5387240c0cf2ccd17716073bd453a6b4968558..b7ec5ba99197062897239e68c596d9e46044cdfd 100644 (file)
@@ -80,8 +80,7 @@ public:
   /// \param theOperation a stopped operation
   virtual void operationStopped(ModuleBase_Operation* theOperation);
 
-  /// Realizes some functionality by an operation start
-  /// \param theOperation a started operation
+  /// Returns current operation
   virtual ModuleBase_Operation* currentOperation() const;
 
   /// Returns True if there are available Undos and the sketch manager allows undo
index e1762376bb70615cb1deccc9f87df5940ad51db2..f302a589e77685ea4a831a212623d8721b248f04 100644 (file)
@@ -93,15 +93,16 @@ public:
   static bool isNestedCreateOperation(ModuleBase_Operation* theOperation);
 
   /// Returns whether the current operation is a sketch entity - line, point, arc or circle
-  /// \param the operation
+  /// \param theId is an id of object
   /// \return a boolean value
   static bool isEntity(const std::string& theId);
 
   /// Returns whether the current operation is a sketch distance - lenght, distance or radius
-  /// \param the operation
+  /// \param theOperation the operation
   /// \return a boolean value
   static bool isDistanceOperation(ModuleBase_Operation* theOperation);
 
+  /// Returns true if a mouse cursor is over viewer window
   bool isMouseOverWindow() { return myIsMouseOverWindow; }
 
   /// Returns current Sketch feature/ Returns NULL if there is no launched sketch operation
@@ -151,6 +152,8 @@ public:
   /// It obtains the selected attributes. The highlighted objects can be processes as the selected ones
   /// \param theHighlightedUse a boolean flag
   void storeSelection(const bool theHighlightedOnly = false);
+
+  /// Restores previously saved selection state
   void restoreSelection();
 
   /// Returns list of strings which contains id's of sketch operations
index 9daf62d47121ade5f950a8c052b8a3c0b337c36f..ca30fe4344b58f39f5bad8b54deb50c30c475e2e 100644 (file)
@@ -36,6 +36,8 @@ public:
   //! the point area in the selection process.
   Standard_EXPORT   void Areas (SelectBasics_ListOfBox2d& aresult) ;
   
+  //! Update location of the point
+  //! \param aLocation a new location
   Standard_EXPORT   Handle(Select3D_SensitiveEntity) GetConnected (const TopLoc_Location& aLocation) ;
   
   //! Checks whether the sensitive entity matches the picking
@@ -43,6 +45,12 @@ public:
   //! For details please refer to base class declaration.
   Standard_EXPORT   Standard_Boolean Matches (const SelectBasics_PickArgs& thePickArgs, Standard_Real& theMatchDMin, Standard_Real& theMatchDepth) ;
   
+  /// Returns true if the current point is matches with given rectangle
+  /// \param XMin an X min coordinate
+  /// \param YMin an Y min coordinate
+  /// \param XMax an X max coordinate
+  /// \param YMax an Y max coordinate
+  /// \param aTol a tolerance
   Standard_EXPORT   Standard_Boolean Matches (const Standard_Real XMin, const Standard_Real YMin, const Standard_Real XMax, const Standard_Real YMax, const Standard_Real aTol) ;
   
   Standard_EXPORT virtual   Standard_Boolean Matches (const TColgp_Array1OfPnt2d& Polyline, const Bnd_Box2d& aBox, const Standard_Real aTol) ;
index 91b2323ac5e74f7dfcfd1c8696f625877c69ca9e..b6c0cf66a2b8a6407dadf7ad6ee10dc9b29fb42b 100644 (file)
@@ -57,15 +57,21 @@ public:
   Standard_EXPORT virtual void HilightOwnerWithColor(const Handle(PrsMgr_PresentationManager3d)& thePM, 
                                                      const Quantity_NameOfColor theColor, 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; }
 
-
+  /// Return array of points where symbols will be placed
   Handle(Graphic3d_ArrayOfPoints) pointsArray() const { return myPntArray; }
 
+  /// Render of the presentation
+  /// \param theWorkspace is OpenGl workspace
   void Render(const Handle(OpenGl_Workspace)& theWorkspace) const;
 
+  /// Release used OpenGl resources
+  /// \param theContext is an OpenGL context
   void Release (OpenGl_Context* theContext);
 
   DEFINE_STANDARD_RTTI(SketcherPrs_SymbolPrs)
@@ -103,6 +109,9 @@ protected:
   /// \return true in case of success
   virtual bool updatePoints(double theStep) const { return true; }
 
+  /// 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) const;
 
@@ -120,6 +129,7 @@ protected:
   /// Array of symbols positions
   mutable Handle(Graphic3d_ArrayOfPoints) myPntArray;
 
+  /// An owner object of the presentation
   Handle(SelectMgr_EntityOwner) myOwner;
 
 private: 
index 805b376ef4fc159ce9c38e0accd568e87d673224..5098ca1bbd63116d2066e9260cc0e37f4fb95af8 100644 (file)
@@ -33,6 +33,8 @@ Q_OBJECT
   /// \param theId an id of an action
   QAction* action(const QString& theId) const;
 
+  /// Returns action object by its Id (name)
+  /// \param theName is an Id of the action
   QAction* actionByName(const QString& theName) const;
 
   /// Returns list of registered actions Ids
@@ -57,7 +59,10 @@ signals:
   /// \param isChecked is checked flag
   void actionTriggered(const QString& theId, bool isChecked);
 
+  /// A signal which is sent before context menu show
   void beforeContextMenu();
+
+  /// A signal which is sent after context menu show
   void afterContextMenu();
 
  private slots:
index b2860a24069e7f77d7b5afccb2ce12a4643bc064..89f693d522c1c58bd8fa21dc955326260fea6498 100644 (file)
@@ -200,7 +200,7 @@ class XGUI_EXPORT XGUI_Displayer: public QObject
   /// Set color on presentation of an object if it is displayed
   /// \param theObject an object 
   /// \param theColor a color which has to be set
-  /// \param theUpdate update viewer flag
+  /// \param toUpdate update viewer flag
   /// \return previously defined color on the object
   QColor setObjectColor(ObjectPtr theObject, const QColor& theColor, bool toUpdate = true);
 
index df5625c890f267640dcf15f39a30c5225320f7ba..75f6c32a9d86d2f0c27e7bc1fd6793ef5bde89ea 100644 (file)
 #include <QAction>
 #include <QStyledItemDelegate>
 
+/**
+* \ingroup GUI
+* Tree item delegate for definition of data in column items editor
+*/
 class XGUI_TreeViewItemDelegate: public QStyledItemDelegate
 {
 public:
+  /// Constructor
+  /// \param theParent a parent of the delegate
   XGUI_TreeViewItemDelegate(XGUI_DataTree* theParent):QStyledItemDelegate(theParent), myTreedView(theParent) {}
 
+  /// Set data for item editor (name of the item)
+  /// \param editor a widget of editor
+  /// \param index the tree item index
   virtual void setEditorData ( QWidget* editor, const QModelIndex& index ) const
   {
     QLineEdit* aEditor = dynamic_cast<QLineEdit*>(editor);