Release 4.0.0-preview1-00235
[platform/core/csapi/tizenfx.git] / src / Tizen.NUI / src / public / Path.cs
index bc5b9cb..495851b 100755 (executable)
@@ -21,7 +21,7 @@ namespace Tizen.NUI
 
     /// <summary>
     /// A 3D parametric curve.<br>
-    /// Paths can be used to animate position and orientation of actors.<br>
+    /// Paths can be used to animate the position and orientation of actors.<br>
     /// </summary>
     public class Path : BaseHandle
     {
@@ -76,7 +76,7 @@ namespace Tizen.NUI
         }
 
         /// <summary>
-        /// Creates an initialized Path handle.
+        /// Creates an initialized path handle.
         /// </summary>
         public Path() : this(NDalicPINVOKE.Path_New(), true)
         {
@@ -96,7 +96,7 @@ namespace Tizen.NUI
         /// <summary>
         /// Adds an interpolation point.
         /// </summary>
-        /// <param name="point">The new interpolation point to be added</param>
+        /// <param name="point">The new interpolation point to be added.</param>
         public void AddPoint(Position point)
         {
             NDalicPINVOKE.Path_AddPoint(swigCPtr, Position.getCPtr(point));
@@ -106,7 +106,7 @@ namespace Tizen.NUI
         /// <summary>
         /// Adds a control point.
         /// </summary>
-        /// <param name="point">The new control point to be added</param>
+        /// <param name="point">The new control point to be added.</param>
         public void AddControlPoint(Vector3 point)
         {
             NDalicPINVOKE.Path_AddControlPoint(swigCPtr, Vector3.getCPtr(point));
@@ -121,7 +121,7 @@ namespace Tizen.NUI
         /// The in control point is the length of the preceding segment back along this bisector multiplied by the curvature.<br>
         /// The out control point is the length of the succeeding segment forward along this bisector multiplied by the curvature.<br>
         /// </summary>
-        /// <param name="curvature">The curvature of the spline. 0 gives straight lines between the knots, negative values means the spline contains loops, positive values up to  0.5 result in a smooth curve, positive values between 0.5 and 1 result  in looped curves where the loops are not distinct (i.e. the curve appears to be non-continuous), positive values higher than 1 result in looped curves</param>
+        /// <param name="curvature">The curvature of the spline. 0 gives straight lines between the knots, negative values means the spline contains loops, positive values up to 0.5 result in a smooth curve, positive values between 0.5 and 1 result in looped curves where the loops are not distinct (i.e., the curve appears to be non-continuous), positive values higher than 1 result in looped curves.</param>
         public void GenerateControlPoints(float curvature)
         {
             NDalicPINVOKE.Path_GenerateControlPoints(swigCPtr, curvature);
@@ -129,11 +129,11 @@ namespace Tizen.NUI
         }
 
         /// <summary>
-        /// Sample path at a given progress. Calculates position and tangent at that point of the curve.
+        /// Sample path at a given progress. Calculates the position and tangent at that point of the curve.
         /// </summary>
-        /// <param name="progress">A floating point value between 0.0 and 1.0</param>
-        /// <param name="position">The interpolated position at that progress</param>
-        /// <param name="tangent">The interpolated tangent at that progress</param>
+        /// <param name="progress">A floating point value between 0.0 and 1.0.</param>
+        /// <param name="position">The interpolated position at that progress.</param>
+        /// <param name="tangent">The interpolated tangent at that progress.</param>
         public void Sample(float progress, Vector3 position, Vector3 tangent)
         {
             NDalicPINVOKE.Path_Sample(swigCPtr, progress, Vector3.getCPtr(position), Vector3.getCPtr(tangent));
@@ -141,9 +141,9 @@ namespace Tizen.NUI
         }
 
         /// <summary>
-        /// Accessor for the interpolation points.
+        /// An accessor for the interpolation points.
         /// </summary>
-        /// <param name="index">The index of the interpolation point</param>
+        /// <param name="index">The index of the interpolation point.</param>
         public Vector3 GetPoint(uint index)
         {
             Vector3 ret = new Vector3(NDalicPINVOKE.Path_GetPoint(swigCPtr, index), false);
@@ -152,9 +152,9 @@ namespace Tizen.NUI
         }
 
         /// <summary>
-        /// Accessor for the control points.
+        /// An accessor for the control points.
         /// </summary>
-        /// <param name="index">The index of the control point</param>
+        /// <param name="index">The index of the control point.</param>
         public Vector3 GetControlPoint(uint index)
         {
             Vector3 ret = new Vector3(NDalicPINVOKE.Path_GetControlPoint(swigCPtr, index), false);
@@ -165,7 +165,7 @@ namespace Tizen.NUI
         /// <summary>
         /// Gets the number of interpolation points in the path.
         /// </summary>
-        /// <returns>The number of interpolation points in the path</returns>
+        /// <returns>The number of interpolation points in the path.</returns>
         public uint GetPointCount()
         {
             uint ret = NDalicPINVOKE.Path_GetPointCount(swigCPtr);
@@ -174,7 +174,7 @@ namespace Tizen.NUI
         }
 
         /// <summary>
-        /// Enumeration for Points
+        /// Enumeration for the Points.
         /// </summary>
         public PropertyArray Points
         {
@@ -191,7 +191,7 @@ namespace Tizen.NUI
         }
 
         /// <summary>
-        /// Enumeration for ControlPoints
+        /// Enumeration for the ControlPoints.
         /// </summary>
         public PropertyArray ControlPoints
         {