Vector2 Structure

A structure encapsulating two single precision doubling point values and provides hardware accelerated methods.

Namespace: Karamba.Geometry
Assembly: KarambaCommon (in KarambaCommon.dll) Version: 1.0.0.0 (1.0.0.0)

Syntax

[SerializableAttribute]
public struct Vector2 : IEquatable<Vector2>, 
	IFormattable

<SerializableAttribute>
Public Structure Vector2
	Implements IEquatable(Of Vector2), IFormattable

[SerializableAttribute]
public value class Vector2 : IEquatable<Vector2>, 
	IFormattable

[<SealedAttribute>]
[<SerializableAttribute>]
type Vector2 =  
    struct
        interface IEquatable<Vector2>
        interface IFormattable
    end

The Vector2 type exposes the following members.

Constructors

	Name	Description
	Vector2(Double)	Constructs a vector whose elements are all the double specified value.
	Vector2(Double, Double)	Constructs a vector with the given individual elements.

Top

Properties

	Name	Description
	One	Returns the vector (1,1).
	UnitX	Returns the vector (1,0).
	UnitY	Returns the vector (0,1).
	Zero	Returns the vector (0,0).

Top

Methods

	Name	Description
	Abs	Returns a vector whose elements are the absolute values of each of the source vector's elements.
	Add	Adds two vectors together.
	Clamp	Restricts a vector between a min and max value.
	Distance	Returns the Euclidean distance between the two given points.
	DistanceSquared	Returns the Euclidean distance squared between the two given points.
	Divide(Vector2, Vector2)	Divides the first vector by the second.
	Divide(Vector2, Single)	Divides the vector by the given scalar.
	Dot	Returns the dot product of two vectors.
	Equals(Object)	Returns a boolean indicating whether the given Object is equal to this Vector2 instance. (Overrides ValueTypeEquals(Object).)
	Equals(Vector2)	Returns a boolean indicating whether the given Vector2 is equal to this Vector2 instance.
	GetHashCode	Returns the hash code for this instance. (Overrides ValueTypeGetHashCode.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	Length	Returns the length of the vector.
	LengthSquared	Returns the length of the vector squared. This operation is cheaper than Length().
	Lerp	Linearly interpolates between two vectors based on the given weighting.
	Max	Returns a vector whose elements are the maximum of each of the pairs of elements in the two source vectors
	Min	Returns a vector whose elements are the minimum of each of the pairs of elements in the two source vectors.
	Multiply(Single, Vector2)	Multiplies a vector by the given scalar.
	Multiply(Vector2, Vector2)	Multiplies two vectors together.
	Multiply(Vector2, Single)	Multiplies a vector by the given scalar.
	Negate	Negates a given vector.
	Normalize	Returns a vector with the same direction as the given vector, but with a length of 1.
	Reflect	Returns the reflection of a vector off a surface that has the specified normal.
	SquareRoot	Returns a vector whose elements are the square root of each of the source vector's elements.
	Subtract	Subtracts the second vector from the first.
	ToString	Returns a String representing this Vector2 instance. (Overrides ValueTypeToString.)
	ToString(String)	Returns a String representing this Vector2 instance, using the specified format to format individual elements.
	ToString(String, IFormatProvider)	Returns a String representing this Vector2 instance, using the specified format to format individual elements and the given IFormatProvider.
	Transform(Vector2, Matrix3x2)	Transforms a vector by the given matrix.
	Transform(Vector2, Matrix4x4)	Transforms a vector by the given matrix.
	Transform(Vector2, Quaternion)	Transforms a vector by the given Quaternion rotation value.
	TransformNormal(Vector2, Matrix3x2)	Transforms a vector normal by the given matrix.
	TransformNormal(Vector2, Matrix4x4)	Transforms a vector normal by the given matrix.

Top

Operators

	Name	Description
	Addition	Adds two vectors together.
	Division(Vector2, Vector2)	Divides the first vector by the second.
	Division(Vector2, Double)	Divides the vector by the given scalar.
	Equality	Returns a boolean indicating whether the two given vectors are equal.
	Inequality	Returns a boolean indicating whether the two given vectors are not equal.
	Multiply(Double, Vector2)	Multiplies a vector by the given scalar.
	Multiply(Vector2, Vector2)	Multiplies two vectors together.
	Multiply(Vector2, Double)	Multiplies a vector by the given scalar.
	Subtraction	Subtracts the second vector from the first.
	UnaryNegation	Negates a given vector.

Top

Fields

	Name	Description
	X	The X component of the vector.
	Y	The Y component of the vector.

Top

Reference

Karamba.Geometry Namespace