{
/// <summary>
- /// RelativeVector3 is a three dimensional vector.
- /// All values(x, y, z and w) should be between [0, 1].
+ /// RelativeVector3 is a three-dimensional vector.
+ /// All values (x, y, z and w) should be between [0, 1].
/// </summary>
public class RelativeVector3 : global::System.IDisposable
{
return (obj == null) ? new global::System.Runtime.InteropServices.HandleRef(null, global::System.IntPtr.Zero) : obj.swigCPtr;
}
- //NUI Dispose Pattern written by Jinwoo Nam(jjw.nam)
-
//A Flag to check who called Dispose(). (By User or DisposeQueue)
private bool isDisposeQueued = false;
//A Flat to check if it is already disposed.
/// <summary>
- /// Addition operator.
+ /// The addition operator.
/// </summary>
- /// <param name="arg1">Vector to add</param>
- /// <param name="arg2">Vector to add</param>
- /// <returns>A vector containing the result of the addition</returns>
+ /// <param name="arg1">The vector to add.</param>
+ /// <param name="arg2">Th vector to add.</param>
+ /// <returns>The vector containing the result of the addition.</returns>
public static RelativeVector3 operator +(RelativeVector3 arg1, RelativeVector3 arg2)
{
RelativeVector3 result = arg1.Add(arg2);
}
/// <summary>
- /// Subtraction operator.
+ /// The subtraction operator.
/// </summary>
- /// <param name="arg1">Vector to subtract</param>
- /// <param name="arg2">Vector to subtract</param>
- /// <returns>A vector containing the result of the subtraction</returns>
+ /// <param name="arg1">The vector to subtract.</param>
+ /// <param name="arg2">The vector to subtract.</param>
+ /// <returns>The vector containing the result of the subtraction.</returns>
public static RelativeVector3 operator -(RelativeVector3 arg1, RelativeVector3 arg2)
{
RelativeVector3 result = arg1.Subtract(arg2);
}
/// <summary>
- /// Multiplication operator.
+ /// The multiplication operator.
/// </summary>
- /// <param name="arg1">The vector to multiply</param>
- /// <param name="arg2">The vector to multiply</param>
- /// <returns>A vector containing the result of the multiplication</returns>
+ /// <param name="arg1">The vector to multiply.</param>
+ /// <param name="arg2">The vector to multiply.</param>
+ /// <returns>The vector containing the result of the multiplication.</returns>
public static RelativeVector3 operator *(RelativeVector3 arg1, RelativeVector3 arg2)
{
RelativeVector3 result = arg1.Multiply(arg2);
}
/// <summary>
- /// Multiplication operator.
+ /// The multiplication operator.
/// </summary>
- /// <param name="arg1">The vector to multiply</param>
- /// <param name="arg2">The float value to scale the vector</param>
- /// <returns>A vector containing the result of the scaling</returns>
+ /// <param name="arg1">The vector to multiply.</param>
+ /// <param name="arg2">The float value to scale the vector.</param>
+ /// <returns>The vector containing the result of the scaling.</returns>
public static RelativeVector3 operator *(RelativeVector3 arg1, float arg2)
{
RelativeVector3 result = arg1.Multiply(arg2);
}
/// <summary>
- /// Division operator.
+ /// The division operator.
/// </summary>
- /// <param name="arg1">The vector to divide</param>
- /// <param name="arg2">The vector to divide</param>
- /// <returns>A vector containing the result of the division</returns>
+ /// <param name="arg1">The vector to divide.</param>
+ /// <param name="arg2">The vector to divide.</param>
+ /// <returns>The vector containing the result of the division.</returns>
public static RelativeVector3 operator /(RelativeVector3 arg1, RelativeVector3 arg2)
{
RelativeVector3 result = arg1.Divide(arg2);
}
/// <summary>
- /// Division operator.
+ /// The division operator.
/// </summary>
- /// <param name="arg1">The vector to divide</param>
- /// <param name="arg2">The float value to scale the vector by</param>
- /// <returns>A vector containing the result of the scaling</returns>
+ /// <param name="arg1">The vector to divide.</param>
+ /// <param name="arg2">The float value to scale the vector by.</param>
+ /// <returns>The vector containing the result of the scaling.</returns>
public static RelativeVector3 operator /(RelativeVector3 arg1, float arg2)
{
RelativeVector3 result = arg1.Divide(arg2);
/// <summary>
- /// Const array subscript operator overload. Should be 0, 1 or 2.
+ /// The const array subscript operator overload. Should be 0, 1 or 2.
/// </summary>
- /// <param name="index">Subscript index</param>
- /// <returns>The float at the given index</returns>
+ /// <param name="index">The subscript index.</param>
+ /// <returns>The float at the given index.</returns>
public float this[uint index]
{
get
/// <summary>
- /// Constructor
+ /// The constructor.
/// </summary>
public RelativeVector3() : this(NDalicPINVOKE.new_Vector3__SWIG_0(), true)
{
}
/// <summary>
- /// Constructor
+ /// The constructor.
/// </summary>
- /// <param name="x">x component</param>
- /// <param name="y">y component</param>
- /// <param name="z">z component</param>
+ /// <param name="x">The x component.</param>
+ /// <param name="y">The y component.</param>
+ /// <param name="z">The z component.</param>
public RelativeVector3(float x, float y, float z) : this(NDalicPINVOKE.new_Vector3__SWIG_1(x, y, z), true)
{
ValueCheck(x);
}
/// <summary>
- /// Constructor
+ /// The constructor.
/// </summary>
- /// <param name="relativeVector2">RelativeVector2 to create this vector from</param>
+ /// <param name="relativeVector2">The RelativeVector2 to create this vector from.</param>
public RelativeVector3(RelativeVector2 relativeVector2) : this(NDalicPINVOKE.new_Vector3__SWIG_3(RelativeVector2.getCPtr(relativeVector2)), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
/// <summary>
- /// Constructor
+ /// The constructor.
/// </summary>
- /// <param name="relativeVector4">RelativeVector4 to create this vector from</param>
+ /// <param name="relativeVector4">The RelativeVector4 to create this vector from.</param>
public RelativeVector3(RelativeVector4 relativeVector4) : this(NDalicPINVOKE.new_Vector3__SWIG_4(RelativeVector4.getCPtr(relativeVector4)), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
/// <summary>
- /// Compare if rhs is equal to
+ /// Compares if the rhs is equal to.
/// </summary>
- /// <param name="rhs">The vector to compare</param>
- /// <returns>Returns true if the two vectors are equal, otherwise false</returns>
+ /// <param name="rhs">The vector to compare.</param>
+ /// <returns>Returns true if the two vectors are equal, otherwise false.</returns>
public bool EqualTo(RelativeVector3 rhs)
{
bool ret = NDalicPINVOKE.Vector3_EqualTo(swigCPtr, RelativeVector3.getCPtr(rhs));
}
/// <summary>
- /// Compare if rhs is not equal to
+ /// Compares if the rhs is not equal to.
/// </summary>
- /// <param name="rhs">The vector to compare</param>
- /// <returns>Returns true if the two vectors are not equal, otherwise false</returns>
+ /// <param name="rhs">The vector to compare.</param>
+ /// <returns>Returns true if the two vectors are not equal, otherwise false.</returns>
public bool NotEqualTo(RelativeVector3 rhs)
{
bool ret = NDalicPINVOKE.Vector3_NotEqualTo(swigCPtr, RelativeVector3.getCPtr(rhs));
/// <summary>
- /// x component
+ /// The x component.
/// </summary>
public float X
{
}
/// <summary>
- /// y component
+ /// The y component.
/// </summary>
public float Y
{
}
/// <summary>
- /// z component
+ /// The z component.
/// </summary>
public float Z
{
projects / platform / core / csapi / tizenfx.git / blobdiff