Vector2

classbase

Tip

This is a builtin dotnet type. The documentation and api interface are generated from dotnet source files.

Represents a vector with two single-precision floating-point values.

Fields:

One Vector2

staticread only

Gets a vector whose 2 elements are equal to one.

UnitX Vector2

staticread only

Gets the vector (1,0).

UnitY Vector2

staticread only

Gets the vector (0,1).

X number

The X component of the vector.

Y number

The Y component of the vector.

Zero Vector2

staticread only

Returns a vector whose 2 elements are equal to zero.

Constructors:

New(value: number) :

Creates a new Vector2 object whose two elements have the same value.

Parameters:

Name	Type	Default	Summary
value	number		The value to assign to both elements.

New(x: number, y: number) :

Creates a vector whose elements have the specified values.

Parameters:

Name	Type	Default	Summary
x	number		The value to assign to the Vector2.X field.
y	number		The value to assign to the Vector2.Y field.

Methods:

Abs(value: Vector2) : Vector2

static

Returns a vector whose elements are the absolute values of each of the specified vector's elements.

Parameters:

Name	Type	Default	Summary
value	Vector2		A vector.

Returns:Vector2

Add(left: Vector2, right: Vector2) : Vector2

static

Adds two vectors together.

Parameters:

Name	Type	Default	Summary
left	Vector2		The first vector to add.
right	Vector2		The second vector to add.

Returns:Vector2

Clamp(value1: Vector2, min: Vector2, max: Vector2) : Vector2

static

Restricts a vector between a minimum and a maximum value.

Parameters:

Name	Type	Default	Summary
value1	Vector2		The vector to restrict.
min	Vector2		The minimum value.
max	Vector2		The maximum value.

Returns:Vector2

CopyTo(array: number, index: number) : nil

Copies the elements of the vector to a specified array starting at a specified index position.

Parameters:

Name	Type	Default	Summary
array	number		The destination array.
index	number		The index at which to copy the first element of the vector.

Returns:nil

CopyTo(array: number) : nil

Copies the elements of the vector to a specified array.

Parameters:

Name	Type	Default	Summary
array	number		The destination array.

Returns:nil

Vector2

New(value: number) :

New(x: number, y: number) :

Abs(value: Vector2) : Vector2

Add(left: Vector2, right: Vector2) : Vector2

Clamp(value1: Vector2, min: Vector2, max: Vector2) : Vector2

CopyTo(array: number, index: number) : nil

CopyTo(array: number) : nil

Distance(value1,value2) value1 Vector2 , value2 Vector2

DistanceSquared(value1,value2) value1 Vector2 , value2 Vector2

Divide(left,divisor) left Vector2 , divisor number

Divide(left,right) left Vector2 , right Vector2

Dot(value1,value2) value1 Vector2 , value2 Vector2

Length()

LengthSquared()

Lerp(value1,value2,amount) value1 Vector2 , value2 Vector2 , amount number

Max(value1,value2) value1 Vector2 , value2 Vector2

Min(value1,value2) value1 Vector2 , value2 Vector2

Multiply(left,right) left Vector2 , right Vector2

Multiply(left,right) left Vector2 , right number

Multiply(left,right) left number , right Vector2

Negate(value) value Vector2

Normalize(value) value Vector2

Reflect(vector,normal) vector Vector2 , normal Vector2

SquareRoot(value) value Vector2

Subtract(left,right) left Vector2 , right Vector2

ToString()

ToString(format) format string

Transform(position,matrix) position Vector2 , matrix Matrix3x2

Transform(position,matrix) position Vector2 , matrix Matrix4x4

Transform(value,rotation) value Vector2 , rotation Quaternion

TransformNormal(normal,matrix) normal Vector2 , matrix Matrix3x2

TransformNormal(normal,matrix) normal Vector2 , matrix Matrix4x4