OpenTK.Vector2 Struct Reference

Represents a 2D vector using two single-precision floating-point numbers. More...

List of all members.

Public Member Functions
	Vector2 (float x, float y)
	Constructs a new Vector2.
	Vector2 (Vector2 v)
	Constructs a new Vector2 from the given Vector2.
	Vector2 (Vector3 v)
	Constructs a new Vector2 from the given Vector3.
	Vector2 (Vector4 v)
	Constructs a new Vector2 from the given Vector4.
void	Add (Vector2 right)
	Add the Vector passed as parameter to this instance.
void	Add (ref Vector2 right)
	Add the Vector passed as parameter to this instance.
void	Sub (Vector2 right)
	Subtract the Vector passed as parameter from this instance.
void	Sub (ref Vector2 right)
	Subtract the Vector passed as parameter from this instance.
void	Mult (float f)
	Multiply this instance by a scalar.
void	Div (float f)
	Divide this instance by a scalar.
void	Normalize ()
	Scales the Vector2 to unit length.
void	NormalizeFast ()
	Scales the Vector2 to approximately unit length.
void	Scale (float sx, float sy)
	Scales the current Vector2 by the given amounts.
void	Scale (Vector2 scale)
	Scales this instance by the given parameter.
void	Scale (ref Vector2 scale)
	Scales this instance by the given parameter.
override string	ToString ()
	Returns a System.String that represents the current Vector2.
override int	GetHashCode ()
	Returns the hashcode for this instance.
override bool	Equals (object obj)
	Indicates whether this instance and a specified object are equal.
bool	Equals (Vector2 other)
	Indicates whether the current vector is equal to another vector.
Static Public Member Functions
static Vector2	Sub (Vector2 a, Vector2 b)
	Subtract one Vector from another.
static void	Sub (ref Vector2 a, ref Vector2 b, out Vector2 result)
	Subtract one Vector from another.
static Vector2	Mult (Vector2 a, float f)
	Multiply a vector and a scalar.
static void	Mult (ref Vector2 a, float f, out Vector2 result)
	Multiply a vector and a scalar.
static Vector2	Div (Vector2 a, float f)
	Divide a vector by a scalar.
static void	Div (ref Vector2 a, float f, out Vector2 result)
	Divide a vector by a scalar.
static Vector2	Add (Vector2 a, Vector2 b)
	Adds two vectors.
static void	Add (ref Vector2 a, ref Vector2 b, out Vector2 result)
	Adds two vectors.
static Vector2	Subtract (Vector2 a, Vector2 b)
	Subtract one Vector from another.
static void	Subtract (ref Vector2 a, ref Vector2 b, out Vector2 result)
	Subtract one Vector from another.
static Vector2	Multiply (Vector2 vector, float scale)
	Multiplies a vector by a scalar.
static void	Multiply (ref Vector2 vector, float scale, out Vector2 result)
	Multiplies a vector by a scalar.
static Vector2	Multiply (Vector2 vector, Vector2 scale)
	Multiplies a vector by the components a vector (scale).
static void	Multiply (ref Vector2 vector, ref Vector2 scale, out Vector2 result)
	Multiplies a vector by the components of a vector (scale).
static Vector2	Divide (Vector2 vector, float scale)
	Divides a vector by a scalar.
static void	Divide (ref Vector2 vector, float scale, out Vector2 result)
	Divides a vector by a scalar.
static Vector2	Divide (Vector2 vector, Vector2 scale)
	Divides a vector by the components of a vector (scale).
static void	Divide (ref Vector2 vector, ref Vector2 scale, out Vector2 result)
	Divide a vector by the components of a vector (scale).
static Vector2	ComponentMin (Vector2 a, Vector2 b)
	Calculate the component-wise minimum of two vectors.
static void	ComponentMin (ref Vector2 a, ref Vector2 b, out Vector2 result)
	Calculate the component-wise minimum of two vectors.
static Vector2	ComponentMax (Vector2 a, Vector2 b)
	Calculate the component-wise maximum of two vectors.
static void	ComponentMax (ref Vector2 a, ref Vector2 b, out Vector2 result)
	Calculate the component-wise maximum of two vectors.
static Vector2	Min (Vector2 left, Vector2 right)
	Returns the Vector3 with the minimum magnitude.
static Vector2	Max (Vector2 left, Vector2 right)
	Returns the Vector3 with the minimum magnitude.
static Vector2	Clamp (Vector2 vec, Vector2 min, Vector2 max)
	Clamp a vector to the given minimum and maximum vectors.
static void	Clamp (ref Vector2 vec, ref Vector2 min, ref Vector2 max, out Vector2 result)
	Clamp a vector to the given minimum and maximum vectors.
static Vector2	Normalize (Vector2 vec)
	Scale a vector to unit length.
static void	Normalize (ref Vector2 vec, out Vector2 result)
	Scale a vector to unit length.
static Vector2	NormalizeFast (Vector2 vec)
	Scale a vector to approximately unit length.
static void	NormalizeFast (ref Vector2 vec, out Vector2 result)
	Scale a vector to approximately unit length.
static float	Dot (Vector2 left, Vector2 right)
	Calculate the dot (scalar) product of two vectors.
static void	Dot (ref Vector2 left, ref Vector2 right, out float result)
	Calculate the dot (scalar) product of two vectors.
static Vector2	Lerp (Vector2 a, Vector2 b, float blend)
	Returns a new Vector that is the linear blend of the 2 given Vectors.
static void	Lerp (ref Vector2 a, ref Vector2 b, float blend, out Vector2 result)
	Returns a new Vector that is the linear blend of the 2 given Vectors.
static Vector2	BaryCentric (Vector2 a, Vector2 b, Vector2 c, float u, float v)
	Interpolate 3 Vectors using Barycentric coordinates.
static void	BaryCentric (ref Vector2 a, ref Vector2 b, ref Vector2 c, float u, float v, out Vector2 result)
	Interpolate 3 Vectors using Barycentric coordinates.
static Vector2	Transform (Vector2 vec, Quaternion quat)
	Transforms a vector by a quaternion rotation.
static void	Transform (ref Vector2 vec, ref Quaternion quat, out Vector2 result)
	Transforms a vector by a quaternion rotation.
static Vector2	operator+ (Vector2 left, Vector2 right)
	Adds the specified instances.
static Vector2	operator- (Vector2 left, Vector2 right)
	Subtracts the specified instances.
static Vector2	operator- (Vector2 vec)
	Negates the specified instance.
static Vector2	operator* (Vector2 vec, float scale)
	Multiplies the specified instance by a scalar.
static Vector2	operator* (float scale, Vector2 vec)
	Multiplies the specified instance by a scalar.
static Vector2	operator/ (Vector2 vec, float scale)
	Divides the specified instance by a scalar.
static bool	operator== (Vector2 left, Vector2 right)
	Compares the specified instances for equality.
static bool	operator!= (Vector2 left, Vector2 right)
	Compares the specified instances for inequality.
Public Attributes
float	X
	The X component of the Vector2.
float	Y
	The Y component of the Vector2.
Static Public Attributes
static readonly Vector2	UnitX = new Vector2(1, 0)
	Defines a unit-length Vector2 that points towards the X-axis.
static readonly Vector2	UnitY = new Vector2(0, 1)
	Defines a unit-length Vector2 that points towards the Y-axis.
static readonly Vector2	Zero = new Vector2(0, 0)
	Defines a zero-length Vector2.
static readonly Vector2	One = new Vector2(1, 1)
	Defines an instance with all components set to 1.
static readonly int	SizeInBytes = Marshal.SizeOf(new Vector2())
	Defines the size of the Vector2 struct in bytes.
Properties
float	Length [get]
	Gets the length (magnitude) of the vector.
float	LengthFast [get]
	Gets an approximation of the vector length (magnitude).
float	LengthSquared [get]
	Gets the square of the vector length (magnitude).
Vector2	PerpendicularRight [get]
	Gets the perpendicular vector on the right side of this vector.
Vector2	PerpendicularLeft [get]
	Gets the perpendicular vector on the left side of this vector.

---

Detailed Description

Represents a 2D vector using two single-precision floating-point numbers.

The Vector2 structure is suitable for interoperation with unmanaged code requiring two consecutive floats.

Definition at line 35 of file Vector2.cs.

---

Constructor & Destructor Documentation

OpenTK.Vector2.Vector2	(	float	x,
		float	y
	)

Constructs a new Vector2.

Parameters:

	x	The x coordinate of the net Vector2.
	y	The y coordinate of the net Vector2.

Definition at line 58 of file Vector2.cs.

        {
            X = x;
            Y = y;
        }

OpenTK.Vector2.Vector2

(

Vector2

v

)

Constructs a new Vector2 from the given Vector2.

Parameters:

v

The Vector2 to copy components from.

Definition at line 69 of file Vector2.cs.

        {
            X = v.X;
            Y = v.Y;
        }

OpenTK.Vector2.Vector2

(

Vector3

v

)

Constructs a new Vector2 from the given Vector3.

Parameters:

v

The Vector3 to copy components from. Z is discarded.

Definition at line 80 of file Vector2.cs.

        {
            X = v.X;
            Y = v.Y;
        }

OpenTK.Vector2.Vector2

(

Vector4

v

)

Constructs a new Vector2 from the given Vector4.

Parameters:

v

The Vector4 to copy components from. Z and W are discarded.

Definition at line 91 of file Vector2.cs.

        {
            X = v.X;
            Y = v.Y;
        }

---

Member Function Documentation

static void OpenTK.Vector2.Add	(	ref Vector2	a,
		ref Vector2	b,
		out Vector2	result
	)			[static]

Adds two vectors.

Parameters:

	a	Left operand.
	b	Right operand.
	result	Result of operation.

Definition at line 480 of file Vector2.cs.

        {
            result = new Vector2(a.X + b.X, a.Y + b.Y);
        }

static Vector2 OpenTK.Vector2.Add	(	Vector2	a,
		Vector2	b
	)			[static]

Adds two vectors.

Parameters:

	a	Left operand.
	b	Right operand.

Returns:

Result of operation.

Definition at line 468 of file Vector2.cs.

        {
            Add(ref a, ref b, out a);
            return a;
        }

void OpenTK.Vector2.Add

(

ref Vector2

right

)

Add the Vector passed as parameter to this instance.

Parameters:

right

Right operand. This parameter is only read from.

Definition at line 118 of file Vector2.cs.

        {
            this.X += right.X;
            this.Y += right.Y;
        }

void OpenTK.Vector2.Add

(

Vector2

right

)

Add the Vector passed as parameter to this instance.

Parameters:

right

Right operand. This parameter is only read from.

Definition at line 108 of file Vector2.cs.

        {
            this.X += right.X;
            this.Y += right.Y;
        }

static void OpenTK.Vector2.BaryCentric	(	ref Vector2	a,
		ref Vector2	b,
		ref Vector2	c,
		float	u,
		float	v,
		out Vector2	result
	)			[static]

Interpolate 3 Vectors using Barycentric coordinates.

Parameters:

	a	First input Vector.
	b	Second input Vector.
	c	Third input Vector.
	u	First Barycentric Coordinate.
	v	Second Barycentric Coordinate.
	result	Output Vector. a when u=v=0, b when u=1,v=0, c when u=0,v=1, and a linear combination of a,b,c otherwise

Definition at line 871 of file Vector2.cs.

        {
            result = a; // copy

            Vector2 temp = b; // copy
            Subtract(ref temp, ref a, out temp);
            Multiply(ref temp, u, out temp);
            Add(ref result, ref temp, out result);

            temp = c; // copy
            Subtract(ref temp, ref a, out temp);
            Multiply(ref temp, v, out temp);
            Add(ref result, ref temp, out result);
        }

static Vector2 OpenTK.Vector2.BaryCentric	(	Vector2	a,
		Vector2	b,
		Vector2	c,
		float	u,
		float	v
	)			[static]

Interpolate 3 Vectors using Barycentric coordinates.

Parameters:

	a	First input Vector
	b	Second input Vector
	c	Third input Vector
	u	First Barycentric Coordinate
	v	Second Barycentric Coordinate

Returns:

a when u=v=0, b when u=1,v=0, c when u=0,v=1, and a linear combination of a,b,c otherwise

Definition at line 859 of file Vector2.cs.

        {
            return a + u * (b - a) + v * (c - a);
        }

static void OpenTK.Vector2.Clamp	(	ref Vector2	vec,
		ref Vector2	min,
		ref Vector2	max,
		out Vector2	result
	)			[static]

Clamp a vector to the given minimum and maximum vectors.

Parameters:

	vec	Input vector
	min	Minimum vector
	max	Maximum vector
	result	The clamped vector

Definition at line 725 of file Vector2.cs.

        {
            result.X = vec.X < min.X ? min.X : vec.X > max.X ? max.X : vec.X;
            result.Y = vec.Y < min.Y ? min.Y : vec.Y > max.Y ? max.Y : vec.Y;
        }

static Vector2 OpenTK.Vector2.Clamp	(	Vector2	vec,
		Vector2	min,
		Vector2	max
	)			[static]

Clamp a vector to the given minimum and maximum vectors.

Parameters:

	vec	Input vector
	min	Minimum vector
	max	Maximum vector

Returns:

The clamped vector

Definition at line 711 of file Vector2.cs.

        {
            vec.X = vec.X < min.X ? min.X : vec.X > max.X ? max.X : vec.X;
            vec.Y = vec.Y < min.Y ? min.Y : vec.Y > max.Y ? max.Y : vec.Y;
            return vec;
        }

static void OpenTK.Vector2.ComponentMax	(	ref Vector2	a,
		ref Vector2	b,
		out Vector2	result
	)			[static]

Calculate the component-wise maximum of two vectors.

Parameters:

	a	First operand
	b	Second operand
	result	The component-wise maximum

Definition at line 664 of file Vector2.cs.

        {
            result.X = a.X > b.X ? a.X : b.X;
            result.Y = a.Y > b.Y ? a.Y : b.Y;
        }

static Vector2 OpenTK.Vector2.ComponentMax	(	Vector2	a,
		Vector2	b
	)			[static]

Calculate the component-wise maximum of two vectors.

Parameters:

	a	First operand
	b	Second operand

Returns:

The component-wise maximum

Definition at line 651 of file Vector2.cs.

        {
            a.X = a.X > b.X ? a.X : b.X;
            a.Y = a.Y > b.Y ? a.Y : b.Y;
            return a;
        }

static void OpenTK.Vector2.ComponentMin	(	ref Vector2	a,
		ref Vector2	b,
		out Vector2	result
	)			[static]

Calculate the component-wise minimum of two vectors.

Parameters:

	a	First operand
	b	Second operand
	result	The component-wise minimum

Definition at line 635 of file Vector2.cs.

        {
            result.X = a.X < b.X ? a.X : b.X;
            result.Y = a.Y < b.Y ? a.Y : b.Y;
        }

static Vector2 OpenTK.Vector2.ComponentMin	(	Vector2	a,
		Vector2	b
	)			[static]

Calculate the component-wise minimum of two vectors.

Parameters:

	a	First operand
	b	Second operand

Returns:

The component-wise minimum

Definition at line 622 of file Vector2.cs.

        {
            a.X = a.X < b.X ? a.X : b.X;
            a.Y = a.Y < b.Y ? a.Y : b.Y;
            return a;
        }

static void OpenTK.Vector2.Div	(	ref Vector2	a,
		float	f,
		out Vector2	result
	)			[static]

Divide a vector by a scalar.

Parameters:

	a	Vector operand
	f	Scalar operand
	result	Result of the division

Definition at line 449 of file Vector2.cs.

        {
            float mult = 1.0f / f;
            result.X = a.X * mult;
            result.Y = a.Y * mult;
        }

static Vector2 OpenTK.Vector2.Div	(	Vector2	a,
		float	f
	)			[static]

Divide a vector by a scalar.

Parameters:

	a	Vector operand
	f	Scalar operand

Returns:

Result of the division

Definition at line 434 of file Vector2.cs.

        {
            float mult = 1.0f / f;
            a.X *= mult;
            a.Y *= mult;
            return a;
        }

void OpenTK.Vector2.Div

(

float

f

)

Divide this instance by a scalar.

Parameters:

f

Scalar operand.

Definition at line 167 of file Vector2.cs.

        {
            float mult = 1.0f / f;
            this.X *= mult;
            this.Y *= mult;
        }

static void OpenTK.Vector2.Divide	(	ref Vector2	vector,
		ref Vector2	scale,
		out Vector2	result
	)			[static]

Divide a vector by the components of a vector (scale).

Parameters:

	vector	Left operand.
	scale	Right operand.
	result	Result of the operation.

Definition at line 607 of file Vector2.cs.

        {
            result = new Vector2(vector.X / scale.X, vector.Y / scale.Y);
        }

static Vector2 OpenTK.Vector2.Divide	(	Vector2	vector,
		Vector2	scale
	)			[static]

Divides a vector by the components of a vector (scale).

Parameters:

	vector	Left operand.
	scale	Right operand.

Returns:

Result of the operation.

Definition at line 595 of file Vector2.cs.

        {
            Divide(ref vector, ref scale, out vector);
            return vector;
        }

static void OpenTK.Vector2.Divide	(	ref Vector2	vector,
		float	scale,
		out Vector2	result
	)			[static]

Divides a vector by a scalar.

Parameters:

	vector	Left operand.
	scale	Right operand.
	result	Result of the operation.

Definition at line 584 of file Vector2.cs.

        {
            Multiply(ref vector, 1 / scale, out result);
        }

static Vector2 OpenTK.Vector2.Divide	(	Vector2	vector,
		float	scale
	)			[static]

Divides a vector by a scalar.

Parameters:

	vector	Left operand.
	scale	Right operand.

Returns:

Result of the operation.

Definition at line 572 of file Vector2.cs.

        {
            Divide(ref vector, scale, out vector);
            return vector;
        }

static void OpenTK.Vector2.Dot	(	ref Vector2	left,
		ref Vector2	right,
		out float	result
	)			[static]

Calculate the dot (scalar) product of two vectors.

Parameters:

	left	First operand
	right	Second operand
	result	The dot product of the two inputs

Definition at line 810 of file Vector2.cs.

        {
            result = left.X * right.X + left.Y * right.Y;
        }

static float OpenTK.Vector2.Dot	(	Vector2	left,
		Vector2	right
	)			[static]

Calculate the dot (scalar) product of two vectors.

Parameters:

	left	First operand
	right	Second operand

Returns:

The dot product of the two inputs

Definition at line 799 of file Vector2.cs.

        {
            return left.X * right.X + left.Y * right.Y;
        }

bool OpenTK.Vector2.Equals

(

Vector2

other

)

Indicates whether the current vector is equal to another vector.

Parameters:

other

A vector to compare with this vector.

Returns:

true if the current vector is equal to the vector parameter; otherwise, false.

Definition at line 1081 of file Vector2.cs.

        {
            return
                X == other.X &&
                Y == other.Y;
        }

override bool OpenTK.Vector2.Equals

(

object

obj

)

Indicates whether this instance and a specified object are equal.

Parameters:

obj

The object to compare to.

Returns:

True if the instances are equal; false otherwise.

Definition at line 1062 of file Vector2.cs.

        {
            if (!(obj is Vector2))
                return false;

            return this.Equals((Vector2)obj);
        }

override int OpenTK.Vector2.GetHashCode

(

)

Returns the hashcode for this instance.

Returns:

A System.Int32 containing the unique hashcode for this instance.

Definition at line 1048 of file Vector2.cs.

        {
            return X.GetHashCode() ^ Y.GetHashCode();
        }

static void OpenTK.Vector2.Lerp	(	ref Vector2	a,
		ref Vector2	b,
		float	blend,
		out Vector2	result
	)			[static]

Returns a new Vector that is the linear blend of the 2 given Vectors.

Parameters:

	a	First input vector
	b	Second input vector
	blend	The blend factor. a when blend=0, b when blend=1.
	result	a when blend=0, b when blend=1, and a linear combination otherwise

Definition at line 840 of file Vector2.cs.

        {
            result.X = blend * (b.X - a.X) + a.X;
            result.Y = blend * (b.Y - a.Y) + a.Y;
        }

static Vector2 OpenTK.Vector2.Lerp	(	Vector2	a,
		Vector2	b,
		float	blend
	)			[static]

Returns a new Vector that is the linear blend of the 2 given Vectors.

Parameters:

	a	First input vector
	b	Second input vector
	blend	The blend factor. a when blend=0, b when blend=1.

Returns:

a when blend=0, b when blend=1, and a linear combination otherwise

Definition at line 826 of file Vector2.cs.

        {
            a.X = blend * (b.X - a.X) + a.X;
            a.Y = blend * (b.Y - a.Y) + a.Y;
            return a;
        }

static Vector2 OpenTK.Vector2.Max	(	Vector2	left,
		Vector2	right
	)			[static]

Returns the Vector3 with the minimum magnitude.

Parameters:

	left	Left operand
	right	Right operand

Returns:

The minimum Vector3

Definition at line 695 of file Vector2.cs.

        {
            return left.LengthSquared >= right.LengthSquared ? left : right;
        }

static Vector2 OpenTK.Vector2.Min	(	Vector2	left,
		Vector2	right
	)			[static]

Returns the Vector3 with the minimum magnitude.

Parameters:

	left	Left operand
	right	Right operand

Returns:

The minimum Vector3

Definition at line 680 of file Vector2.cs.

        {
            return left.LengthSquared < right.LengthSquared ? left : right;
        }

static void OpenTK.Vector2.Mult	(	ref Vector2	a,
		float	f,
		out Vector2	result
	)			[static]

Multiply a vector and a scalar.

Parameters:

	a	Vector operand
	f	Scalar operand
	result	Result of the multiplication

Definition at line 417 of file Vector2.cs.

        {
            result.X = a.X * f;
            result.Y = a.Y * f;
        }

static Vector2 OpenTK.Vector2.Mult	(	Vector2	a,
		float	f
	)			[static]

Multiply a vector and a scalar.

Parameters:

	a	Vector operand
	f	Scalar operand

Returns:

Result of the multiplication

Definition at line 403 of file Vector2.cs.

        {
            a.X *= f;
            a.Y *= f;
            return a;
        }

void OpenTK.Vector2.Mult

(

float

f

)

Multiply this instance by a scalar.

Parameters:

f

Scalar operand.

Definition at line 154 of file Vector2.cs.

        {
            this.X *= f;
            this.Y *= f;
        }

static void OpenTK.Vector2.Multiply	(	ref Vector2	vector,
		ref Vector2	scale,
		out Vector2	result
	)			[static]

Multiplies a vector by the components of a vector (scale).

Parameters:

	vector	Left operand.
	scale	Right operand.
	result	Result of the operation.

Definition at line 557 of file Vector2.cs.

        {
            result = new Vector2(vector.X * scale.X, vector.Y * scale.Y);
        }

static Vector2 OpenTK.Vector2.Multiply	(	Vector2	vector,
		Vector2	scale
	)			[static]

Multiplies a vector by the components a vector (scale).

Parameters:

	vector	Left operand.
	scale	Right operand.

Returns:

Result of the operation.

Definition at line 545 of file Vector2.cs.

        {
            Multiply(ref vector, ref scale, out vector);
            return vector;
        }

static void OpenTK.Vector2.Multiply	(	ref Vector2	vector,
		float	scale,
		out Vector2	result
	)			[static]

Multiplies a vector by a scalar.

Parameters:

	vector	Left operand.
	scale	Right operand.
	result	Result of the operation.

Definition at line 534 of file Vector2.cs.

        {
            result = new Vector2(vector.X * scale, vector.Y * scale);
        }

static Vector2 OpenTK.Vector2.Multiply	(	Vector2	vector,
		float	scale
	)			[static]

Multiplies a vector by a scalar.

Parameters:

	vector	Left operand.
	scale	Right operand.

Returns:

Result of the operation.

Definition at line 522 of file Vector2.cs.

        {
            Multiply(ref vector, scale, out vector);
            return vector;
        }

static void OpenTK.Vector2.Normalize	(	ref Vector2	vec,
		out Vector2	result
	)			[static]

Scale a vector to unit length.

Parameters:

	vec	The input vector
	result	The normalized vector

Definition at line 753 of file Vector2.cs.

        {
            float scale = 1.0f / vec.Length;
            result.X = vec.X * scale;
            result.Y = vec.Y * scale;
        }

static Vector2 OpenTK.Vector2.Normalize

(

Vector2

vec

)

[static]

Scale a vector to unit length.

Parameters:

vec

The input vector

Returns:

The normalized vector

Definition at line 740 of file Vector2.cs.

        {
            float scale = 1.0f / vec.Length;
            vec.X *= scale;
            vec.Y *= scale;
            return vec;
        }

void OpenTK.Vector2.Normalize

(

)

Scales the Vector2 to unit length.

Definition at line 270 of file Vector2.cs.

        {
            float scale = 1.0f / this.Length;
            X *= scale;
            Y *= scale;
        }

static void OpenTK.Vector2.NormalizeFast	(	ref Vector2	vec,
		out Vector2	result
	)			[static]

Scale a vector to approximately unit length.

Parameters:

	vec	The input vector
	result	The normalized vector

Definition at line 782 of file Vector2.cs.

        {
            float scale = MathHelper.InverseSqrtFast(vec.X * vec.X + vec.Y * vec.Y);
            result.X = vec.X * scale;
            result.Y = vec.Y * scale;
        }

static Vector2 OpenTK.Vector2.NormalizeFast

(

Vector2

vec

)

[static]

Scale a vector to approximately unit length.

Parameters:

vec

The input vector

Returns:

The normalized vector

Definition at line 769 of file Vector2.cs.

        {
            float scale = MathHelper.InverseSqrtFast(vec.X * vec.X + vec.Y * vec.Y);
            vec.X *= scale;
            vec.Y *= scale;
            return vec;
        }

void OpenTK.Vector2.NormalizeFast

(

)

Scales the Vector2 to approximately unit length.

Definition at line 284 of file Vector2.cs.

        {
            float scale = MathHelper.InverseSqrtFast(X * X + Y * Y);
            X *= scale;
            Y *= scale;
        }

static bool OpenTK.Vector2.operator!=	(	Vector2	left,
		Vector2	right
	)			[static]

Compares the specified instances for inequality.

Parameters:

	left	Left operand.
	right	Right operand.

Returns:

True if both instances are not equal; false otherwise.

Definition at line 1020 of file Vector2.cs.

        {
            return !left.Equals(right);
        }

static Vector2 OpenTK.Vector2.operator*	(	float	scale,
		Vector2	vec
	)			[static]

Multiplies the specified instance by a scalar.

Parameters:

	scale	Left operand.
	vec	Right operand.

Returns:

Result of multiplication.

Definition at line 982 of file Vector2.cs.

        {
            vec.X *= scale;
            vec.Y *= scale;
            return vec;
        }

static Vector2 OpenTK.Vector2.operator*	(	Vector2	vec,
		float	scale
	)			[static]

Multiplies the specified instance by a scalar.

Parameters:

	vec	Left operand.
	scale	Right operand.

Returns:

Result of multiplication.

Definition at line 969 of file Vector2.cs.

        {
            vec.X *= scale;
            vec.Y *= scale;
            return vec;
        }

static Vector2 OpenTK.Vector2.operator+	(	Vector2	left,
		Vector2	right
	)			[static]

Adds the specified instances.

Parameters:

	left	Left operand.
	right	Right operand.

Returns:

Result of addition.

Definition at line 931 of file Vector2.cs.

        {
            left.X += right.X;
            left.Y += right.Y;
            return left;
        }

static Vector2 OpenTK.Vector2.operator-

(

Vector2

vec

)

[static]

Negates the specified instance.

Parameters:

vec

Operand.

Returns:

Result of negation.

Definition at line 956 of file Vector2.cs.

        {
            vec.X = -vec.X;
            vec.Y = -vec.Y;
            return vec;
        }

static Vector2 OpenTK.Vector2.operator-	(	Vector2	left,
		Vector2	right
	)			[static]

Subtracts the specified instances.

Parameters:

	left	Left operand.
	right	Right operand.

Returns:

Result of subtraction.

Definition at line 944 of file Vector2.cs.

        {
            left.X -= right.X;
            left.Y -= right.Y;
            return left;
        }

static Vector2 OpenTK.Vector2.operator/	(	Vector2	vec,
		float	scale
	)			[static]

Divides the specified instance by a scalar.

Parameters:

	vec	Left operand
	scale	Right operand

Returns:

Result of the division.

Definition at line 995 of file Vector2.cs.

        {
            float mult = 1.0f / scale;
            vec.X *= mult;
            vec.Y *= mult;
            return vec;
        }

static bool OpenTK.Vector2.operator==	(	Vector2	left,
		Vector2	right
	)			[static]

Compares the specified instances for equality.

Parameters:

	left	Left operand.
	right	Right operand.

Returns:

True if both instances are equal; false otherwise.

Definition at line 1009 of file Vector2.cs.

        {
            return left.Equals(right);
        }

void OpenTK.Vector2.Scale

(

ref Vector2

scale

)

Scales this instance by the given parameter.

Parameters:

scale

The scaling of the individual components.

Definition at line 320 of file Vector2.cs.

        {
            this.X *= scale.X;
            this.Y *= scale.Y;
        }

void OpenTK.Vector2.Scale

(

Vector2

scale

)

Scales this instance by the given parameter.

Parameters:

scale

The scaling of the individual components.

Definition at line 310 of file Vector2.cs.

        {
            this.X *= scale.X;
            this.Y *= scale.Y;
        }

void OpenTK.Vector2.Scale	(	float	sx,
		float	sy
	)

Scales the current Vector2 by the given amounts.

Parameters:

	sx	The scale of the X component.
	sy	The scale of the Y component.

Definition at line 301 of file Vector2.cs.

        {
            this.X = X * sx;
            this.Y = Y * sy;
        }

static void OpenTK.Vector2.Sub	(	ref Vector2	a,
		ref Vector2	b,
		out Vector2	result
	)			[static]

Subtract one Vector from another.

Parameters:

	a	First operand
	b	Second operand
	result	Result of subtraction

Definition at line 386 of file Vector2.cs.

        {
            result.X = a.X - b.X;
            result.Y = a.Y - b.Y;
        }

static Vector2 OpenTK.Vector2.Sub	(	Vector2	a,
		Vector2	b
	)			[static]

Subtract one Vector from another.

Parameters:

	a	First operand
	b	Second operand

Returns:

Result of subtraction

Definition at line 372 of file Vector2.cs.

        {
            a.X -= b.X;
            a.Y -= b.Y;
            return a;
        }

void OpenTK.Vector2.Sub

(

ref Vector2

right

)

Subtract the Vector passed as parameter from this instance.

Parameters:

right

Right operand. This parameter is only read from.

Definition at line 141 of file Vector2.cs.

        {
            this.X -= right.X;
            this.Y -= right.Y;
        }

void OpenTK.Vector2.Sub

(

Vector2

right

)

Subtract the Vector passed as parameter from this instance.

Parameters:

right

Right operand. This parameter is only read from.

Definition at line 131 of file Vector2.cs.

        {
            this.X -= right.X;
            this.Y -= right.Y;
        }

static void OpenTK.Vector2.Subtract	(	ref Vector2	a,
		ref Vector2	b,
		out Vector2	result
	)			[static]

Subtract one Vector from another.

Parameters:

	a	First operand
	b	Second operand
	result	Result of subtraction

Definition at line 507 of file Vector2.cs.

        {
            result = new Vector2(a.X - b.X, a.Y - b.Y);
        }

static Vector2 OpenTK.Vector2.Subtract	(	Vector2	a,
		Vector2	b
	)			[static]

Subtract one Vector from another.

Parameters:

	a	First operand
	b	Second operand

Returns:

Result of subtraction

Definition at line 495 of file Vector2.cs.

        {
            Subtract(ref a, ref b, out a);
            return a;
        }

override string OpenTK.Vector2.ToString

(

)

Returns a System.String that represents the current Vector2.

Returns:

Definition at line 1035 of file Vector2.cs.

        {
            return String.Format("({0}, {1})", X, Y);
        }

static void OpenTK.Vector2.Transform	(	ref Vector2	vec,
		ref Quaternion	quat,
		out Vector2	result
	)			[static]

Transforms a vector by a quaternion rotation.

Parameters:

	vec	The vector to transform.
	quat	The quaternion to rotate the vector by.
	result	The result of the operation.

Definition at line 909 of file Vector2.cs.

        {
            Quaternion v = new Quaternion(vec.X, vec.Y, 0, 0), i, t;
            Quaternion.Invert(ref quat, out i);
            Quaternion.Multiply(ref quat, ref v, out t);
            Quaternion.Multiply(ref t, ref i, out v);

            result = new Vector2(v.X, v.Y);
        }

static Vector2 OpenTK.Vector2.Transform	(	Vector2	vec,
		Quaternion	quat
	)			[static]

Transforms a vector by a quaternion rotation.

Parameters:

	vec	The vector to transform.
	quat	The quaternion to rotate the vector by.

Returns:

The result of the operation.

Definition at line 896 of file Vector2.cs.

        {
            Vector2 result;
            Transform(ref vec, ref quat, out result);
            return result;
        }

---

Member Data Documentation

readonly Vector2 OpenTK.Vector2.One = new Vector2(1, 1) [static]

Defines an instance with all components set to 1.

Definition at line 352 of file Vector2.cs.

readonly int OpenTK.Vector2.SizeInBytes = Marshal.SizeOf(new Vector2()) [static]

Defines the size of the Vector2 struct in bytes.

Definition at line 357 of file Vector2.cs.

readonly Vector2 OpenTK.Vector2.UnitX = new Vector2(1, 0) [static]

Defines a unit-length Vector2 that points towards the X-axis.

Definition at line 337 of file Vector2.cs.

readonly Vector2 OpenTK.Vector2.UnitY = new Vector2(0, 1) [static]

Defines a unit-length Vector2 that points towards the Y-axis.

Definition at line 342 of file Vector2.cs.

float OpenTK.Vector2.X

The X component of the Vector2.

Definition at line 42 of file Vector2.cs.

float OpenTK.Vector2.Y

The Y component of the Vector2.

Definition at line 47 of file Vector2.cs.

readonly Vector2 OpenTK.Vector2.Zero = new Vector2(0, 0) [static]

Defines a zero-length Vector2.

Definition at line 347 of file Vector2.cs.

---

Property Documentation

float OpenTK.Vector2.Length [get]

Gets the length (magnitude) of the vector.

LengthFast

See also:

LengthSquared

Definition at line 184 of file Vector2.cs.

float OpenTK.Vector2.LengthFast [get]

Gets an approximation of the vector length (magnitude).

This property uses an approximation of the square root function to calculate vector magnitude, with an upper error bound of 0.001.

Length

See also:

LengthSquared

Definition at line 205 of file Vector2.cs.

float OpenTK.Vector2.LengthSquared [get]

Gets the square of the vector length (magnitude).

This property avoids the costly square root operation required by the Length property. This makes it more suitable for comparisons.

Length

See also:

LengthFast

Definition at line 226 of file Vector2.cs.

Vector2 OpenTK.Vector2.PerpendicularLeft [get]

Gets the perpendicular vector on the left side of this vector.

Definition at line 256 of file Vector2.cs.

Vector2 OpenTK.Vector2.PerpendicularRight [get]

Gets the perpendicular vector on the right side of this vector.

Definition at line 241 of file Vector2.cs.