Vector2D Structure

Delta Engine Documentation

Represents a 2D vector, which is useful for screen positions (sprites, mouse, touch, etc.) View code on GitHub

Namespace: DeltaEngine.Datatypes
Assembly: DeltaEngine (in DeltaEngine.dll) Version: 1.1.1.0 (1.1.1)

Syntax

public struct Vector2D : IEquatable<Vector2D>, 
	Lerp<Vector2D>, Lerp

public struct Vector2D : IEquatable<Vector2D>, 
	Lerp<Vector2D>, Lerp

Public Structure Vector2D 
	Implements IEquatable(Of Vector2D), Lerp(Of Vector2D), 
	Lerp

Public Structure Vector2D 
	Implements IEquatable(Of Vector2D), Lerp(Of Vector2D), 
	Lerp

public value class Vector2D : IEquatable<Vector2D>, 
	Lerp<Vector2D>, Lerp

public value class Vector2D : IEquatable<Vector2D>, 
	Lerp<Vector2D>, Lerp

[<SealedAttribute>]
type Vector2D =  
    struct 
        interface IEquatable<Vector2D>
        interface Lerp<Vector2D>
        interface Lerp 
    end

[<SealedAttribute>]
type Vector2D =  
    struct 
        interface IEquatable<Vector2D>
        interface Lerp<Vector2D>
        interface Lerp 
    end

The Vector2D type exposes the following members.

Constructors

	Name	Description
	Vector2D(String)	Initializes a new instance of the Vector2D class
	Vector2D(Single, Single)	Initializes a new instance of the Vector2D class

Top

Methods

	Name	Description
	AngleBetweenVector	View code on GitHub
	DirectionTo	View code on GitHub
	DistanceFromProjectAxisPointX
	DistanceFromProjectAxisPointY
	DistanceTo	View code on GitHub
	DistanceToLine	http://en.wikipedia.org/wiki/Distance_from_a_point_to_a_line View code on GitHub
	DistanceToLineSegment	http://stackoverflow.com/questions/849211/shortest-distance-between-a-point-and-a-line-segment View code on GitHub
	DistanceToLineSquared
	DistanceToSquared	View code on GitHub
	DotProduct	View code on GitHub
	Equals(Object)	View code on GitHub (Overrides ValueType Equals(Object).)
	Equals(Vector2D)	View code on GitHub
	GetHashCode	View code on GitHub (Overrides ValueType GetHashCode .)
	GetRotation	View code on GitHub
	IsLeftOfLineOrOnIt	http://stackoverflow.com/questions/3461453/determine-which-side-of-a-line-a-point-lies View code on GitHub
	IsNearlyEqual
	Lerp
	Normalize	View code on GitHub
	ReflectIfHittingBorder
	Rotate	View code on GitHub
	RotateAround(Vector2D, Single)
	RotateAround(Vector2D, Single, Single)
	RotationTo	View code on GitHub
	ToString	View code on GitHub (Overrides ValueType ToString .)

Top

Operators

	Name	Description
	Addition
	Division(Vector2D, Size)
	Division(Vector2D, Single)
	Equality
	(Size to Vector2D)
	Inequality
	Multiply(Single, Vector2D)
	Multiply(Vector2D, Size)
	Multiply(Vector2D, Single)
	Subtraction
	UnaryNegation

Top

Fields

	Name	Description
	Half
	One
	ScreenDown
	ScreenLeft
	ScreenRight
	ScreenUp
	SizeInBytes
	UnitX
	UnitY
	Unused
	Zero

Top

Properties

	Name	Description
	Length	View code on GitHub
	LengthSquared	View code on GitHub
	X
	Y

Top

Remarks

Tests: DeltaEngine.Tests.Datatypes.Vector2DTests

Examples

33 unit tests call DeltaEngine.Datatypes.Vector2D

Copy to Clipboard Print

[Test]
public void Create()
{
    const float X = 3.51f;
    const float Y = 0.23f;
    var v = new Vector2D(X, Y);
    Assert.AreEqual(v.X, X);
    Assert.AreEqual(v.Y, Y);
}

[Test]
public void Create()
{
    const float X = 3.51f;
    const float Y = 0.23f;
    var v = new Vector2D(X, Y);
    Assert.AreEqual(v.X, X);
    Assert.AreEqual(v.Y, Y);
}

Copy to Clipboard Print

[Test]
public void Statics()
{
    Assert.AreEqual(new Vector2D(0, 0), Vector2D.Zero);
    Assert.AreEqual(new Vector2D(1, 1), Vector2D.One);
    Assert.AreEqual(new Vector2D(0.5f, 0.5f), Vector2D.Half);
    Assert.AreEqual(new Vector2D(1, 0), Vector2D.UnitX);
    Assert.AreEqual(new Vector2D(0, 1), Vector2D.UnitY);
    Assert.AreEqual(new Vector2D(1, 0), Vector2D.ScreenRight);
    Assert.AreEqual(new Vector2D(-1, 0), Vector2D.ScreenLeft);
    Assert.AreEqual(new Vector2D(0, -1), Vector2D.ScreenUp);
    Assert.AreEqual(new Vector2D(0, 1), Vector2D.ScreenDown);
    Assert.AreEqual(8, Vector2D.SizeInBytes);
}

[Test]
public void Statics()
{
    Assert.AreEqual(new Vector2D(0, 0), Vector2D.Zero);
    Assert.AreEqual(new Vector2D(1, 1), Vector2D.One);
    Assert.AreEqual(new Vector2D(0.5f, 0.5f), Vector2D.Half);
    Assert.AreEqual(new Vector2D(1, 0), Vector2D.UnitX);
    Assert.AreEqual(new Vector2D(0, 1), Vector2D.UnitY);
    Assert.AreEqual(new Vector2D(1, 0), Vector2D.ScreenRight);
    Assert.AreEqual(new Vector2D(-1, 0), Vector2D.ScreenLeft);
    Assert.AreEqual(new Vector2D(0, -1), Vector2D.ScreenUp);
    Assert.AreEqual(new Vector2D(0, 1), Vector2D.ScreenDown);
    Assert.AreEqual(8, Vector2D.SizeInBytes);
}

Copy to Clipboard Print

[Test]
public void ChangePoint()
{
    var v = new Vector2D(1.0f, 1.0f) { X = 2.1f, Y = 2.1f };
    Assert.AreEqual(2.1f, v.X);
    Assert.AreEqual(2.1f, v.Y);
}

[Test]
public void ChangePoint()
{
    var v = new Vector2D(1.0f, 1.0f) { X = 2.1f, Y = 2.1f };
    Assert.AreEqual(2.1f, v.X);
    Assert.AreEqual(2.1f, v.Y);
}