X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=src%2FTizen.NUI%2Fsrc%2Fpublic%2FVector2.cs;h=1687a9889a43ae73d96c41c764580d165af41cae;hb=refs%2Ftags%2Fsubmit%2Ftizen_4.0%2F20170921.150009;hp=b8e05da1ab71d029df273137dd5f3ffebdb59615;hpb=ff57cbb1221d9f6b9f5fe7a41b6a15f6e92cfc7b;p=platform%2Fcore%2Fcsapi%2Ftizenfx.git diff --git a/src/Tizen.NUI/src/public/Vector2.cs b/src/Tizen.NUI/src/public/Vector2.cs index b8e05da..1687a98 100755 --- a/src/Tizen.NUI/src/public/Vector2.cs +++ b/src/Tizen.NUI/src/public/Vector2.cs @@ -18,7 +18,7 @@ namespace Tizen.NUI { /// - /// A two dimensional vector. + /// A two-dimensional vector. /// public class Vector2 : global::System.IDisposable { @@ -100,86 +100,86 @@ namespace Tizen.NUI } /// - /// Addition operator. + /// The addition operator. /// - /// First value - /// Second value - /// A vector containing the result of the addition + /// The first value. + /// The second value. + /// The vector containing the result of the addition. public static Vector2 operator +(Vector2 arg1, Vector2 arg2) { return arg1.Add(arg2); } /// - /// Subtraction operator. + /// The subtraction operator. /// - /// First value - /// Second value - /// A vector containing the result of the subtraction + /// The first value. + /// The second value. + /// The vector containing the result of the subtraction. public static Vector2 operator -(Vector2 arg1, Vector2 arg2) { return arg1.Subtract(arg2); } /// - /// Unary negation operator. + /// The unary negation operator. /// - /// Target Value - /// A vector containg the negation + /// The target value. + /// The vector containing the negation. public static Vector2 operator -(Vector2 arg1) { return arg1.Subtract(); } /// - /// Multiplication operator. + /// The multiplication operator. /// - /// First Value - /// Second Value - /// A vector containing the result of the multiplication + /// The first value. + /// The second value. + /// The vector containing the result of the multiplication. public static Vector2 operator *(Vector2 arg1, Vector2 arg2) { return arg1.Multiply(arg2); } /// - /// Multiplication operator. + /// Th multiplication operator. /// - /// First Value - /// The float value to scale the vector - /// A vector containing the result of the scaling + /// The first value. + /// The float value to scale the vector. + /// The vector containing the result of the scaling. public static Vector2 operator *(Vector2 arg1, float arg2) { return arg1.Multiply(arg2); } /// - /// Division operator. + /// The division operator. /// - /// First Value - /// Second Value - /// A vector containing the result of the division + /// The first value. + /// The second value. + /// The vector containing the result of the division. public static Vector2 operator /(Vector2 arg1, Vector2 arg2) { return arg1.Divide(arg2); } /// - /// Division operator. + /// Th division operator. /// - /// First Value - /// The float value to scale the vector by - /// A vector containing the result of the scaling + /// The first value. + /// The float value to scale the vector by. + /// The vector containing the result of the scaling. public static Vector2 operator /(Vector2 arg1, float arg2) { return arg1.Divide(arg2); } /// - /// Array subscript operator overload. + /// The array subscript operator overload. /// - /// Subscript index - /// The float at the given index + /// The subscript index. + /// The float at the given index. public float this[uint index] { get @@ -196,7 +196,7 @@ namespace Tizen.NUI } /// - /// Default constructor, initializes the vector to 0. + /// The default constructor initializes the vector to 0. /// public Vector2() : this(NDalicPINVOKE.new_Vector2__SWIG_0(), true) { @@ -204,44 +204,44 @@ namespace Tizen.NUI } /// - /// Constructor. + /// The constructor. /// - /// x or width component - /// y or height component + /// The x or width component. + /// The y or height component. public Vector2(float x, float y) : this(NDalicPINVOKE.new_Vector2__SWIG_1(x, y), true) { if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); } /// - /// Conversion constructor from an array of two floats. + /// The conversion constructor from an array of two floats. /// - /// Array of xy + /// The array of xy. public Vector2(float[] array) : this(NDalicPINVOKE.new_Vector2__SWIG_2(array), true) { if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); } /// - /// Constructor. + /// The constructor. /// - /// Vector3 to create this vector from + /// Vector3 to create this vector from. public Vector2(Vector3 vec3) : this(NDalicPINVOKE.new_Vector2__SWIG_3(Vector3.getCPtr(vec3)), true) { if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); } /// - /// Constructor. + /// The constructor. /// - /// Vector4 to create this vector from + /// Vector4 to create this vector from. public Vector2(Vector4 vec4) : this(NDalicPINVOKE.new_Vector2__SWIG_4(Vector4.getCPtr(vec4)), true) { if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); } /// - /// (1.0f,1.0f) + /// (1.0f,1.0f). /// public static Vector2 One { @@ -255,7 +255,7 @@ namespace Tizen.NUI } /// - /// Vector representing the X axis + /// The vector representing the x-axis. /// public static Vector2 XAxis { @@ -269,7 +269,7 @@ namespace Tizen.NUI } /// - /// Vector representing the Y axis + /// The vector representing the y-axis. /// public static Vector2 YAxis { @@ -283,7 +283,7 @@ namespace Tizen.NUI } /// - /// Vector representing the negative X axis + /// The vector representing the negative x-axis. /// public static Vector2 NegativeXAxis { @@ -297,7 +297,7 @@ namespace Tizen.NUI } /// - /// Vector representing the negative Y axis + /// The vector representing the negative y-axis. /// public static Vector2 NegativeYAxis { @@ -311,7 +311,7 @@ namespace Tizen.NUI } /// - /// (0.0f, 0.0f) + /// (0.0f, 0.0f). /// public static Vector2 Zero { @@ -439,7 +439,7 @@ namespace Tizen.NUI /// /// Returns the length of the vector. /// - /// The length of the vector + /// The length of the vector. public float Length() { float ret = NDalicPINVOKE.Vector2_Length(swigCPtr); @@ -461,7 +461,7 @@ namespace Tizen.NUI } /// - /// Sets the vector to be unit length, whilst maintaining its direction. + /// Sets the vector to be the unit length, whilst maintaining its direction. /// public void Normalize() { @@ -472,8 +472,8 @@ namespace Tizen.NUI /// /// Clamps the vector between minimum and maximum vectors. /// - /// The minimum vector - /// The maximum vector + /// The minimum vector. + /// The maximum vector. public void Clamp(Vector2 min, Vector2 max) { NDalicPINVOKE.Vector2_Clamp(swigCPtr, Vector2.getCPtr(min), Vector2.getCPtr(max)); @@ -489,7 +489,7 @@ namespace Tizen.NUI } /// - /// x component + /// The x component. /// public float X { @@ -507,7 +507,7 @@ namespace Tizen.NUI } /// - /// width + /// The width. /// public float Width { @@ -525,7 +525,7 @@ namespace Tizen.NUI } /// - /// y component + /// The y component. /// public float Y { @@ -543,7 +543,7 @@ namespace Tizen.NUI } /// - /// height + /// The height. /// public float Height {