{
/// <summary>
- /// Position is a three dimensional vector.
+ /// Position is a three-dimensional vector.
/// </summary>
public class Position : global::System.IDisposable
{
/// <summary>
- /// Addition operator.
+ /// An 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">The vector to add.</param>
+ /// <returns>The vector containing the result of the addition.</returns>
+ /// <since_tizen> 3 </since_tizen>
public static Position operator +(Position arg1, Position arg2)
{
return 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>
+ /// <since_tizen> 3 </since_tizen>
public static Position operator -(Position arg1, Position arg2)
{
return arg1.Subtract(arg2);
}
/// <summary>
- /// Unary negation operator.
+ /// The unary negation operator.
/// </summary>
- /// <param name="arg1">Vector to netate</param>
- /// <returns>A vector containg the negation</returns>
+ /// <param name="arg1">The vector to negate.</param>
+ /// <returns>The vector containg the negation.</returns>
+ /// <since_tizen> 3 </since_tizen>
public static Position operator -(Position arg1)
{
return arg1.Subtract();
}
/// <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>
+ /// <since_tizen> 3 </since_tizen>
public static Position operator *(Position arg1, Position arg2)
{
return 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="arg2">The float value to scale the vector.</param>
+ /// <returns>The vector containing the result of scaling.</returns>
+ /// <since_tizen> 3 </since_tizen>
public static Position operator *(Position arg1, float arg2)
{
return 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>
+ /// <since_tizen> 3 </since_tizen>
public static Position operator /(Position arg1, Position arg2)
{
return 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 scaling.</returns>
+ /// <since_tizen> 3 </since_tizen>
public static Position operator /(Position arg1, float arg2)
{
return 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>
+ /// <since_tizen> 3 </since_tizen>
public float this[uint index]
{
get
}
}
- /// <summary>
- /// </summary>
internal static Position GetPositionFromPtr(global::System.IntPtr cPtr)
{
Position ret = new Position(cPtr, false);
/// <summary>
- /// Constructor
+ /// The constructor.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public Position() : this(NDalicPINVOKE.new_Vector3__SWIG_0(), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
/// <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>
+ /// <since_tizen> 3 </since_tizen>
public Position(float x, float y, float z) : this(NDalicPINVOKE.new_Vector3__SWIG_1(x, y, z), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
/// <summary>
- /// Constructor
+ /// The constructor.
/// </summary>
- /// <param name="position2d">Position2D to create this vector from</param>
+ /// <param name="position2d">Position2D to create this vector from.</param>
+ /// <since_tizen> 3 </since_tizen>
public Position(Position2D position2d) : this(NDalicPINVOKE.new_Vector3__SWIG_3(Position2D.getCPtr(position2d)), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
/// <summary>
- /// Compare if rhs is equal to
+ /// Compares if 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>
+ /// <since_tizen> 3 </since_tizen>
public bool EqualTo(Position rhs)
{
bool ret = NDalicPINVOKE.Vector3_EqualTo(swigCPtr, Position.getCPtr(rhs));
}
/// <summary>
- /// Compare if rhs is not equal to
+ /// Compares if 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>
+ /// <since_tizen> 3 </since_tizen>
public bool NotEqualTo(Position rhs)
{
bool ret = NDalicPINVOKE.Vector3_NotEqualTo(swigCPtr, Position.getCPtr(rhs));
/// <summary>
- /// x component
+ /// The x component.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public float X
{
set
}
/// <summary>
- /// y component
+ /// The y component.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public float Y
{
set
}
/// <summary>
- /// z component
+ /// The z component.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public float Z
{
set
/// <summary>
/// ParentOrigin constants. It's 0.0.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static float ParentOriginTop
{
get
/// <summary>
/// ParentOrigin constants. It's 1.0.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static float ParentOriginBottom
{
get
/// <summary>
/// ParentOrigin constants. It's 0.0.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static float ParentOriginLeft
{
get
/// <summary>
/// ParentOrigin constants. It's 1.0.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static float ParentOriginRight
{
get
/// <summary>
/// ParentOrigin constants. It's 0.5.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static float ParentOriginMiddle
{
get
}
/// <summary>
- /// ParentOrigin constants: 0.0, 0.0, 0.5
+ /// ParentOrigin constants: 0.0, 0.0, 0.5.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static Position ParentOriginTopLeft
{
get
}
/// <summary>
- /// ParentOrigin constants: 0.5, 0.0, 0.5
+ /// ParentOrigin constants: 0.5, 0.0, 0.5.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static Position ParentOriginTopCenter
{
get
}
/// <summary>
- /// ParentOrigin constants: 1.0, 0.0, 0.5
+ /// ParentOrigin constants: 1.0, 0.0, 0.5.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static Position ParentOriginTopRight
{
get
}
/// <summary>
- /// ParentOrigin constants: 0.0, 0.5, 0.5
+ /// ParentOrigin constants: 0.0, 0.5, 0.5.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static Position ParentOriginCenterLeft
{
get
/// <summary>
/// ParentOrigin constants: 0.0, 0.5, 0.5
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static Position ParentOriginCenter
{
get
}
/// <summary>
- /// ParentOrigin constants: 1.0, 0.5, 0.5
+ /// ParentOrigin constants: 1.0, 0.5, 0.5.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static Position ParentOriginCenterRight
{
get
}
/// <summary>
- /// ParentOrigin constants: 0.0f, 1.0f, 0.5f
+ /// ParentOrigin constants: 0.0f, 1.0f, 0.5f.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static Position ParentOriginBottomLeft
{
get
}
/// <summary>
- /// ParentOrigin constants: 0.5, 1.0, 0.5
+ /// ParentOrigin constants: 0.5, 1.0, 0.5.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static Position ParentOriginBottomCenter
{
get
}
/// <summary>
- /// ParentOrigin constants: 1.0, 1.0, 0.5
+ /// ParentOrigin constants: 1.0, 1.0, 0.5.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static Position ParentOriginBottomRight
{
get
}
/// <summary>
- /// PivotPoint constants: 0.0
+ /// PivotPoint constants: 0.0.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public static float PivotPointTop
{
get
}
/// <summary>
- /// PivotPoint constants: 1.0
+ /// PivotPoint constants: 1.0.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public static float PivotPointBottom
{
get
}
/// <summary>
- /// PivotPoint constants: 0.0
+ /// PivotPoint constants: 0.0.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public static float PivotPointLeft
{
get
}
/// <summary>
- /// PivotPoint constants: 1.0
+ /// PivotPoint constants: 1.0.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public static float PivotPointRight
{
get
}
/// <summary>
- /// PivotPoint constants: 0.0
+ /// PivotPoint constants: 0.0.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public static float PivotPointMiddle
{
get
}
/// <summary>
- /// PivotPoint constants: 0.0, 0.0, 0.5
+ /// PivotPoint constants: 0.0, 0.0, 0.5.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public static Position PivotPointTopLeft
{
get
}
/// <summary>
- /// PivotPoint constants: 0.5, 0.0, 0.5
+ /// PivotPoint constants: 0.5, 0.0, 0.5.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public static Position PivotPointTopCenter
{
get
}
/// <summary>
- /// PivotPoint constants: 1.0, 0.0, 0.5
+ /// PivotPoint constants: 1.0, 0.0, 0.5.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public static Position PivotPointTopRight
{
get
}
/// <summary>
- /// PivotPoint constants: 0.0, 0.5, 0.5
+ /// PivotPoint constants: 0.0, 0.5, 0.5.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public static Position PivotPointCenterLeft
{
get
}
/// <summary>
- /// PivotPoint constants: 0.5, 0.5, 0.5
+ /// PivotPoint constants: 0.5, 0.5, 0.5.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public static Position PivotPointCenter
{
get
}
/// <summary>
- /// PivotPoint constants: 1.0, 0.5, 0.5
+ /// PivotPoint constants: 1.0, 0.5, 0.5.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public static Position PivotPointCenterRight
{
get
}
/// <summary>
- /// PivotPoint constants: 0.0, 1.0, 0.5
+ /// PivotPoint constants: 0.0, 1.0, 0.5.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public static Position PivotPointBottomLeft
{
get
/// <summary>
/// PivotPoint constants: 0.5, 1.0, 0.5
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public static Position PivotPointBottomCenter
{
get
}
/// <summary>
- /// PivotPoint constants: 1.0, 1.0, 0.5
+ /// PivotPoint constants: 1.0, 1.0, 0.5.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public static Position PivotPointBottomRight
{
get
}
/// <summary>
- /// Constant ( 1.0f, 1.0f, 1.0f )
+ /// Constant ( 1.0f, 1.0f, 1.0f ).
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static Position One
{
get
}
/// <summary>
- /// Constant ( 0.0f, 0.0f, 0.0f )
+ /// Constant ( 0.0f, 0.0f, 0.0f ).
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static Position Zero
{
get
}
/// <summary>
- /// Convert a position instance to a vector3 instance.
+ /// Converts a position instance to a Vector3 instance.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static implicit operator Vector3(Position Position)
{
return new Vector3(Position.X, Position.Y, Position.Z);
}
/// <summary>
- /// Convert a vector3 instance to a position instance.
+ /// Converts a Vector3 instance to a position instance.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static implicit operator Position(Vector3 vec)
{
return new Position(vec.X, vec.Y, vec.Z);
}
}
-}
+}
\ No newline at end of file
projects / platform / core / csapi / tizenfx.git / blobdiff