]> SALOME platform Git repositories - modules/geom.git/commitdiff
Salome HOME
Mantis issue 0021066: GetAngle function. Update documentation.
authorjfa <jfa@opencascade.com>
Thu, 12 Jan 2012 11:06:08 +0000 (11:06 +0000)
committerjfa <jfa@opencascade.com>
Thu, 12 Jan 2012 11:06:08 +0000 (11:06 +0000)
doc/salome/gui/GEOM/input/using_measurement_tools.doc
src/GEOM_SWIG/geompyDC.py

index 38876272762ede5bffce3045d39d34516933acab..8eb29375bd6a119575fb95cfd57370173ec247e3 100644 (file)
@@ -169,7 +169,12 @@ distance is computed.
 \anchor angle_anchor
 <br><h2>Angle</h2>
 
-\n Returns the angle between two lines or linear edges in degrees
+\n Returns the angle between two lines or linear edges in degrees.
+
+\note If both arguments are <b>vectors</b>, the angle is computed in
+      accordance with their orientations, otherwise the minimum angle
+      is computed.
+
 \n <b>TUI Command:</b> <em>geompy.GetAngle(shape1, shape2),</em> where
 Shape1 and Shape2 are shapes between which the angle is computed. 
 Another TUI command is <em>geompy.GetAngleRadians(shape1,shape2),</em> 
index 4ea478a23c00b805c97d3e1676f1c745208e990c..435d8fd5986b5264e2e79c174626d1b828a6ef66 100644 (file)
@@ -3539,6 +3539,8 @@ class geompyDC(GEOM._objref_GEOM_Gen):
 
         ## Get angle between the given shapes in degrees.
         #  @param theShape1,theShape2 Lines or linear edges to find angle between.
+        #  @note If both arguments are vectors, the angle is computed in accordance
+        #        with their orientations, otherwise the minimum angle is computed.
         #  @return Value of the angle between the given shapes in degrees.
         #
         #  @ref tui_measurement_tools_page "Example"
@@ -3547,8 +3549,11 @@ class geompyDC(GEOM._objref_GEOM_Gen):
             anAngle = self.MeasuOp.GetAngle(theShape1, theShape2)
             RaiseIfFailed("GetAngle", self.MeasuOp)
             return anAngle
+
         ## Get angle between the given shapes in radians.
         #  @param theShape1,theShape2 Lines or linear edges to find angle between.
+        #  @note If both arguments are vectors, the angle is computed in accordance
+        #        with their orientations, otherwise the minimum angle is computed.
         #  @return Value of the angle between the given shapes in radians.
         #
         #  @ref tui_measurement_tools_page "Example"