Class Vector2

Definition

Namespace:
Tizen.NUI
Assembly:
Tizen.NUI.dll
API Level:
3

A two-dimensional vector.

C#
Copy
public class Vector2 : Disposable, ICloneable
Inheritance
Vector2
Implements
ICloneable

Constructors

View Source

Vector2()

The default constructor initializes the vector to 0.

Declaration
C#
Copy
public Vector2()
API Level: 3
View Source

Vector2(Single, Single)

The constructor.

Declaration
C#
Copy
public Vector2(float x, float y)
Parameters
Type Name Description
Single x

The x or width component.

Single y

The y or height component.

API Level: 3
View Source

Vector2(Single[])

The conversion constructor from an array of two floats.

Declaration
C#
Copy
public Vector2(float[] array)
Parameters
Type Name Description
Single[] array

The array of xy.

API Level: 3
View Source

Vector2(Vector2)

The copy constructor.

Declaration
C#
Copy
public Vector2(Vector2 other)
Parameters
Type Name Description
Vector2 other

The copy target.

View Source

Vector2(Vector3)

The constructor.

Declaration
C#
Copy
public Vector2(Vector3 vec3)
Parameters
Type Name Description
Vector3 vec3

Vector3 to create this vector from.

API Level: 3
View Source

Vector2(Vector4)

The constructor.

Declaration
C#
Copy
public Vector2(Vector4 vec4)
Parameters
Type Name Description
Vector4 vec4

Vector4 to create this vector from.

API Level: 3

Properties

View Source

Height

The height.

Declaration
C#
Copy
public float Height { get; set; }
Property Value
Type Description
Single
Remarks

The setter is deprecated in API8 and will be removed in API10. Use new Vector2(...) constructor.

API Level: 3
View Source

Item[UInt32]

The array subscript operator overload.

Declaration
C#
Copy
public float this[uint index] { get; }
Parameters
Type Name Description
UInt32 index

The subscript index.

Property Value
Type Description
Single

The float at the given index.

API Level: 3
View Source

NegativeXAxis

The vector representing the negative x-axis.

Declaration
C#
Copy
public static Vector2 NegativeXAxis { get; }
Property Value
Type Description
Vector2
API Level: 3
View Source

NegativeYAxis

The vector representing the negative y-axis.

Declaration
C#
Copy
public static Vector2 NegativeYAxis { get; }
Property Value
Type Description
Vector2
API Level: 3
View Source

One

(1.0f,1.0f).

Declaration
C#
Copy
public static Vector2 One { get; }
Property Value
Type Description
Vector2
API Level: 3
View Source

Width

The width.

Declaration
C#
Copy
public float Width { get; set; }
Property Value
Type Description
Single
Remarks

The setter is deprecated in API8 and will be removed in API10. Use new Vector2(...) constructor.

API Level: 3
View Source

X

The x component.

Declaration
C#
Copy
public float X { get; set; }
Property Value
Type Description
Single
Remarks

The setter is deprecated in API8 and will be removed in API10. Use new Vector2(...) constructor.

API Level: 3
View Source

XAxis

The vector representing the x-axis.

Declaration
C#
Copy
public static Vector2 XAxis { get; }
Property Value
Type Description
Vector2
API Level: 3
View Source

Y

The y component.

Declaration
C#
Copy
public float Y { get; set; }
Property Value
Type Description
Single
Remarks

The setter is deprecated in API8 and will be removed in API10. Use new Vector2(...) constructor.

API Level: 3
View Source

YAxis

The vector representing the y-axis.

Declaration
C#
Copy
public static Vector2 YAxis { get; }
Property Value
Type Description
Vector2
API Level: 3
View Source

Zero

(0.0f, 0.0f).

Declaration
C#
Copy
public static Vector2 Zero { get; }
Property Value
Type Description
Vector2
API Level: 3

Methods

View Source

Clamp(Vector2, Vector2)

Clamps the vector between minimum and maximum vectors.

Declaration
C#
Copy
public void Clamp(Vector2 min, Vector2 max)
Parameters
Type Name Description
Vector2 min

The minimum vector.

Vector2 max

The maximum vector.

API Level: 3
View Source

Clone()

Declaration
C#
Copy
public object Clone()
Returns
Type Description
Object
View Source

Equals(Object)

Determines whether the specified object is equal to the current object.

Declaration
C#
Copy
public override bool Equals(Object obj)
Parameters
Type Name Description
Tizen.System.Object obj

The object to compare with the current object.

Returns
Type Description
Boolean

true if the specified object is equal to the current object; otherwise, false.

View Source

GetHashCode()

Gets the hash code of this Vector2.

Declaration
C#
Copy
public override int GetHashCode()
Returns
Type Description
Int32

The Hash Code.

API Level: 6
View Source

Length()

Returns the length of the vector.

Declaration
C#
Copy
public float Length()
Returns
Type Description
Single

The length of the vector.

API Level: 3
View Source

LengthSquared()

Returns the length of the vector squared.
This is more efficient than Length() for threshold testing as it avoids the use of a square root.

Declaration
C#
Copy
public float LengthSquared()
Returns
Type Description
Single

The length of the vector squared

API Level: 3
View Source

Normalize()

Sets the vector to be the unit length, whilst maintaining its direction.

Declaration
C#
Copy
public void Normalize()
API Level: 3
View Source

ReleaseSwigCPtr(Runtime.InteropServices.HandleRef)

Declaration
C#
Copy
protected override void ReleaseSwigCPtr(Runtime.InteropServices.HandleRef swigCPtr)
Parameters
Type Name Description
Tizen.System.Runtime.InteropServices.HandleRef swigCPtr
Overrides

Operators

View Source

Addition(Vector2, Vector2)

The addition operator.

Declaration
C#
Copy
public static Vector2 operator +(Vector2 arg1, Vector2 arg2)
Parameters
Type Name Description
Vector2 arg1

The first value.

Vector2 arg2

The second value.

Returns
Type Description
Vector2

The vector containing the result of the addition.

API Level: 3
View Source

Division(Vector2, Single)

Th division operator.

Declaration
C#
Copy
public static Vector2 operator /(Vector2 arg1, float arg2)
Parameters
Type Name Description
Vector2 arg1

The first value.

Single arg2

The float value to scale the vector by.

Returns
Type Description
Vector2

The vector containing the result of the scaling.

API Level: 3
View Source

Division(Vector2, Vector2)

The division operator.

Declaration
C#
Copy
public static Vector2 operator /(Vector2 arg1, Vector2 arg2)
Parameters
Type Name Description
Vector2 arg1

The first value.

Vector2 arg2

The second value.

Returns
Type Description
Vector2

The vector containing the result of the division.

API Level: 3
View Source

Multiply(Vector2, Single)

Th multiplication operator.

Declaration
C#
Copy
public static Vector2 operator *(Vector2 arg1, float arg2)
Parameters
Type Name Description
Vector2 arg1

The first value.

Single arg2

The float value to scale the vector.

Returns
Type Description
Vector2

The vector containing the result of the scaling.

API Level: 3
View Source

Multiply(Vector2, Vector2)

The multiplication operator.

Declaration
C#
Copy
public static Vector2 operator *(Vector2 arg1, Vector2 arg2)
Parameters
Type Name Description
Vector2 arg1

The first value.

Vector2 arg2

The second value.

Returns
Type Description
Vector2

The vector containing the result of the multiplication.

API Level: 3
View Source

Subtraction(Vector2, Vector2)

The subtraction operator.

Declaration
C#
Copy
public static Vector2 operator -(Vector2 arg1, Vector2 arg2)
Parameters
Type Name Description
Vector2 arg1

The first value.

Vector2 arg2

The second value.

Returns
Type Description
Vector2

The vector containing the result of the subtraction.

API Level: 3
View Source

UnaryNegation(Vector2)

The unary negation operator.

Declaration
C#
Copy
public static Vector2 operator -(Vector2 arg1)
Parameters
Type Name Description
Vector2 arg1

The target value.

Returns
Type Description
Vector2

The vector containing the negation.

API Level: 3

Implements

ICloneable

Extension Methods