Construction of vertices/edges/faces on the base of sketch: clear list attribute...

[modules/shaper.git] / src / SketcherPrs / SketcherPrs_Tools.h

diff --git a/src/SketcherPrs/SketcherPrs_Tools.h b/src/SketcherPrs/SketcherPrs_Tools.h
index 481e7d96d2eae703326284f11b9ca98e77105933..a7c0925b53b194bb321b2da75b90055de369d3d4 100644 (file)
--- a/src/SketcherPrs/SketcherPrs_Tools.h
+++ b/src/SketcherPrs/SketcherPrs_Tools.h
@@ -21,32 +21,45 @@ class GeomDataAPI_Point2D;
 
 namespace SketcherPrs_Tools {
 
-/// Enumeration with modes for activation of selection custom presentations
-enum SelectionModes {
-  /// Start of enumeration
-  Sel_Mode_First = 100, 
+  /// Enumeration with modes for activation of selection custom presentations
+  enum SelectionModes {
+    /// Start of enumeration
+    Sel_Mode_First = 100, 
   
-  /// Selection mode for all constraints exclude dimensions
-  Sel_Constraint,
+    /// Selection mode for all constraints exclude dimensions
+    Sel_Constraint,
   
-  /// Selection mode for whole dimension
-  Sel_Dimension_All,
+    /// Selection mode for whole dimension
+    Sel_Dimension_All,
   
-  /// Selection mode for line of dimension
-  Sel_Dimension_Line,
+    /// Selection mode for line of dimension
+    Sel_Dimension_Line,
 
-  /// Selection mode foe text of dimension
-  Sel_Dimension_Text
-};
+    /// Selection mode foe text of dimension
+    Sel_Dimension_Text
+  };
 
+  /// Returns result object referenced by feature
+  /// \param theFeature a feature
+  /// \param theAttrName an attribute name
   SKETCHERPRS_EXPORT ObjectPtr getResult(ModelAPI_Feature* theFeature,
                                          const std::string& theAttrName);
 
+  /// Returns shape from result object (or NULL)
+  /// \param theObject a result object
   SKETCHERPRS_EXPORT std::shared_ptr<GeomAPI_Shape> getShape(ObjectPtr theObject);
 
+
+  /// Returns point from a line feature
+  /// \param theFeature a line feature
+  /// \param theAttrName an attribute of the point
   SKETCHERPRS_EXPORT std::shared_ptr<GeomAPI_Pnt2d> getPoint(ModelAPI_Feature* theFeature,
                                           const std::string& theAttrName);
 
+
+  /// Returns point projected on a line
+  /// \param theLine  a line
+  /// \param thePoint a projecting point
   SKETCHERPRS_EXPORT std::shared_ptr<GeomAPI_Pnt2d> getProjectionPoint(
                         const FeaturePtr theLine,
                         const std::shared_ptr<GeomAPI_Pnt2d>& thePoint);
@@ -55,22 +68,35 @@ enum SelectionModes {
                                                const std::string& theAttribute);
 
   /// Obtain the point object from specified constraint parameter
+  /// \param theData a data object
+  /// \param theAttribute an attribute name
+  /// \param thePlane a projection plane (sketcher plane)
   SKETCHERPRS_EXPORT std::shared_ptr<GeomDataAPI_Point2D> getFeaturePoint(DataPtr theData,
                                                        const std::string& theAttribute,
                                                        const std::shared_ptr<GeomAPI_Ax3>& thePlane);
 
+  /// Returns value of dimension arrows size
   SKETCHERPRS_EXPORT double getArrowSize();
 
+  /// Set value of dimension arrows size
+  /// \param theSize a size value
   SKETCHERPRS_EXPORT void setArrowSize(double theSize);
 
+  /// Set value of dimension text height
+  /// \param theHeight a height value
   SKETCHERPRS_EXPORT void setTextHeight(double theHeight);
 
+  /// Returns value of dimension text height
   SKETCHERPRS_EXPORT double getTextHeight();
 
+  /// Returns default value of dimension text height
   SKETCHERPRS_EXPORT double getDefaultTextHeight();
 
+  /// Get flayout distance of the dimension constraint
+  /// \param theConstraint a dimension constraint object
   SKETCHERPRS_EXPORT double getFlyoutDistance(const ModelAPI_Feature* theConstraint);
 
+  /// Compute anchor pint for radius dimension
   SKETCHERPRS_EXPORT std::shared_ptr<GeomAPI_Pnt> getAnchorPoint(
                                               const ModelAPI_Feature* theConstraint,
                                               const std::shared_ptr<GeomAPI_Ax3>& thePlane);