From: vsv Date: Fri, 17 Apr 2015 13:06:32 +0000 (+0300) Subject: Update documentation X-Git-Tag: V_1.1.0~12 X-Git-Url: http://git.salome-platform.org/gitweb/?a=commitdiff_plain;h=9d1e3115a33fa4e36bfb193f110b31c5bc198068;p=modules%2Fshaper.git Update documentation --- diff --git a/src/GeomAPI/GeomAPI_Ax3.h b/src/GeomAPI/GeomAPI_Ax3.h index 6a554e2b3..bd66173a1 100644 --- a/src/GeomAPI/GeomAPI_Ax3.h +++ b/src/GeomAPI/GeomAPI_Ax3.h @@ -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 theOrigin, std::shared_ptr theDirX, diff --git a/src/PartSet/PartSet_Module.h b/src/PartSet/PartSet_Module.h index fe5387240..b7ec5ba99 100644 --- a/src/PartSet/PartSet_Module.h +++ b/src/PartSet/PartSet_Module.h @@ -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 diff --git a/src/PartSet/PartSet_SketcherMgr.h b/src/PartSet/PartSet_SketcherMgr.h index e1762376b..f302a589e 100644 --- a/src/PartSet/PartSet_SketcherMgr.h +++ b/src/PartSet/PartSet_SketcherMgr.h @@ -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 diff --git a/src/SketcherPrs/SketcherPrs_SensitivePoint.h b/src/SketcherPrs/SketcherPrs_SensitivePoint.h index 9daf62d47..ca30fe434 100644 --- a/src/SketcherPrs/SketcherPrs_SensitivePoint.h +++ b/src/SketcherPrs/SketcherPrs_SensitivePoint.h @@ -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) ; diff --git a/src/SketcherPrs/SketcherPrs_SymbolPrs.h b/src/SketcherPrs/SketcherPrs_SymbolPrs.h index 91b2323ac..b6c0cf66a 100644 --- a/src/SketcherPrs/SketcherPrs_SymbolPrs.h +++ b/src/SketcherPrs/SketcherPrs_SymbolPrs.h @@ -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 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& 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: diff --git a/src/XGUI/XGUI_ContextMenuMgr.h b/src/XGUI/XGUI_ContextMenuMgr.h index 805b376ef..5098ca1bb 100644 --- a/src/XGUI/XGUI_ContextMenuMgr.h +++ b/src/XGUI/XGUI_ContextMenuMgr.h @@ -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: diff --git a/src/XGUI/XGUI_Displayer.h b/src/XGUI/XGUI_Displayer.h index b2860a240..89f693d52 100644 --- a/src/XGUI/XGUI_Displayer.h +++ b/src/XGUI/XGUI_Displayer.h @@ -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); diff --git a/src/XGUI/XGUI_ObjectsBrowser.cpp b/src/XGUI/XGUI_ObjectsBrowser.cpp index df5625c89..75f6c32a9 100644 --- a/src/XGUI/XGUI_ObjectsBrowser.cpp +++ b/src/XGUI/XGUI_ObjectsBrowser.cpp @@ -20,11 +20,20 @@ #include #include +/** +* \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(editor);