Two.Vector

Extends: Two.Events

A class to store x / y component vector data. In addition to storing data Two.Vector has souped-up methods for commonplace mathematical operations.

Source

Constructor

Argument	Description
x	Any number to represent the horizontal `x` component of the vector.
y	Any number to represent the vertical `y` component of the vector.

zero

Handy reference to a vector with component values 0, 0 at all times.

vector.js:77

left

Handy reference to a vector with component values -1, 0 at all times.

vector.js:84

right

Handy reference to a vector with component values 1, 0 at all times.

vector.js:91

up

Handy reference to a vector with component values 0, -1 at all times.

vector.js:98

down

Handy reference to a vector with component values 0, 1 at all times.

vector.js:105

add

Returns: Two.Vector

Argument	Description
v1	First Two.Vector
v2	Second Two.Vector

Add two vectors together.

vector.js:112

sub

Returns: Two.Vector

Argument	Description
v1	First Two.Vector
v2	Second Two.Vector

Subtract two vectors: v2 from v1.

vector.js:124

subtract

Alias for Two.Vector.sub.

vector.js:136

ratioBetween

Returns: Number

The ratio between two points v1 and v2.

Argument	Description
v1	First Two.Vector
v2	Second Two.Vector

vector.js:145

angleBetween

Returns: Number

The angle between points v1 and v2.

Argument	Description
v1	First Two.Vector
v2	Second Two.Vector

vector.js:156

distanceBetween

Returns: Number

The distance between points v1 and v2. Distance is always positive.

Argument	Description
v1	First Two.Vector
v2	Second Two.Vector

vector.js:177

distanceBetweenSquared

Returns: Number

The squared distance between points v1 and v2.

Argument	Description
v1	First Two.Vector
v2	Second Two.Vector

vector.js:188

x

The horizontal x-component of the vector.

vector.js:62

y

The vertical y-component of the vector.

vector.js:69

set

Argument	Description
x	Value of `x` component
y	Value of `y` component

vector.js:204

copy

Argument	Description
v	The Two.Vector to copy

Copy the x / y components of another object Two.Vector.

vector.js:216

clear

Set the x / y component values of the vector to zero.

vector.js:228

clone

Returns: Two.Vector

Create a new vector and copy the existing values onto the newly created instance.

vector.js:239

add

Overloaded

Argument	Description
v	The Two.Vector to add

Add an object with x / y component values to the instance.

vector.js:249

add

Overloaded

Argument	Description
n	Number to add

Add the same number to both x / y component values of the instance.

vector.js:257

add

Overloaded

Argument	Description
x	Number to add to `x` component
y	Number to add to `y` component

Add x / y values to their respective component value on the instance.

vector.js:265

addSelf

Alias for Two.Vector.add.

vector.js:291

sub

Overloaded

Argument	Description
v	The amount as a Two.Vector to subtract

Subtract an object with x / y component values to the instance.

vector.js:300

sub

Overloaded

Argument	Description
n	Number to subtract

Subtract the same number to both x / y component values of the instance.

vector.js:308

sub

Overloaded

Argument	Description
x	Number to subtract from `x` component
y	Number to subtract from `y` component

Subtract x / y values to their respective component value on the instance.

vector.js:316

subtract

Alias for Two.Vector.sub.

vector.js:342

subSelf

Alias for Two.Vector.sub.

vector.js:351

subtractSelf

Alias for Two.Vector.sub.

vector.js:360

multiply

Overloaded

Argument	Description
v	The Two.Vector to multiply

Multiply an object with x / y component values to the instance.

vector.js:369

multiply

Overloaded

Argument	Description
n	The number to multiply

Multiply the same number to both x / y component values of the instance.

vector.js:377

multiply

Overloaded

Argument	Description
x	The number to multiply to `x` component
y	The number to multiply to `y` component

Multiply x / y values to their respective component value on the instance.

vector.js:385

multiplySelf

Alias for Two.Vector.multiply.

vector.js:411

multiplyScalar

Argument	Description
s	The scalar to multiply by.

Multiply the vector by a single number. Shorthand to call Two.Vector.multiply directly.

vector.js:420

divide

Overloaded

Argument	Description
v	The Two.Vector to divide

Divide an object with x / y component values to the instance.

vector.js:430

divide

Overloaded

Argument	Description
n	The number to divide

Divide the same number to both x / y component values of the instance.

vector.js:438

divide

Overloaded

Argument	Description
x	The number to divide on the `x` component
y	The number to divide on the `y` component

Divide x / y values to their respective component value on the instance.

vector.js:446

divideSelf

Alias for Two.Vector.divide.

vector.js:478

divideScalar

Argument	Description
s	The scalar to divide by.

Divide the vector by a single number. Shorthand to call Two.Vector.divide directly.

vector.js:487

negate

Invert each component's sign value.

vector.js:497

dot

Returns: Number

Get the dot product of the vector.

vector.js:506

length

Returns: Number

Get the length of a vector.

vector.js:516

lengthSquared

Returns: Number

Get the length of the vector to the power of two. Widely used as less expensive than Two.Vector.length because it isn't square-rooting any numbers.

vector.js:526

normalize

Normalize the vector from negative one to one.

vector.js:536

distanceTo

Returns: Number

Get the distance between two vectors.

vector.js:545

distanceToSquared

Returns: Number

Get the distance between two vectors to the power of two. Widely used as less expensive than Two.Vector.distanceTo because it isn't square-rooting any numbers.

vector.js:555

setLength

Argument	Description
l	length to set vector to.

Set the length of a vector.

vector.js:567

equals

Returns: Boolean

Argument	Description
v	The vector to compare against.
eps	An options epsilon for precision.

Qualify if one vector roughly equal another. With a margin of error defined by epsilon.

vector.js:577

lerp

Argument	Description
v	The destination vector to step towards.
t	The zero to one value of how close the current vector gets to the destination vector.

Linear interpolate one vector to another by an amount t defined as a zero to one number.

See: Matt DesLauriers has a good thread about this.

vector.js:590

isZero

Returns: Boolean

Argument	Description
eps	Optional precision amount to check against.

Check to see if vector is roughly zero, based on the epsilon precision value.

vector.js:604

toString

Returns: String

Return a comma-separated string of x, y value. Great for storing in a database.

vector.js:616

toObject

Returns: Object

Return a JSON compatible plain object that represents the vector.

vector.js:626

rotate

Argument	Description
radians	The amount to rotate the vector by in radians.

Rotate a vector.

vector.js:636