Salome HOME
Merge branch 'python_parametric_api' of https://git.salome-platform.org/git/modules...
[modules/shaper.git] / src / PythonAPI / model / sketcher / arc.py
index 8e1bb1a503c4d5c9a018dcffba534e05dadc06a9..b025c4636160e0be7ef2ece7c6e1f3a47bec0eb8 100644 (file)
@@ -4,6 +4,7 @@ from GeomDataAPI import geomDataAPI_Point2D
 from model.errors import WrongNumberOfArguments
 
 class Arc():
+    """Interface for editing a sketch arc feature."""
     def __init__(self, arc_feature, *args):
         self._feature = arc_feature
         self._center = geomDataAPI_Point2D(
@@ -24,16 +25,20 @@ class Arc():
                 "Arc takes 3 or 6 arguments (%s given)" % len(args)
                 )
 
-    def centerData (self):
+    def centerData(self):
+        """Return the center point data."""
         return self._center
     
-    def startPointData (self):
+    def startPointData(self):
+        """Return the start point data."""
         return self._start_point
     
-    def endPointData (self):
+    def endPointData(self):
+        """Return the end point data."""
         return self._end_point
 
-    def result (self):
+    def result(self):
+        """Return the arc circular line attribute."""
         return self._feature.lastResult()
     
     ########
@@ -42,10 +47,9 @@ class Arc():
     #
     ########
     
-    def __createByCoordinates(self, 
-                         center_x, center_y, 
-                         start_x, start_y, 
-                         end_x, end_y):
+    def __createByCoordinates(self, center_x, center_y, 
+                              start_x, start_y, 
+                              end_x, end_y):
         """Create an arc by point coordinates."""
         self._center.setValue(center_x, center_y)
         self._start_point.setValue(start_x, start_y)