goog.math.Vec2

Provided By	`goog.math.Vec2`
Extends	`goog.math.Coordinate`

Class for a two-dimensional vector object and assorted functions useful for manipulating points.

new Vec2( `x`, `y` )

Parameters

`x`	`number`
	The x coordinate for the vector.
`y`	`number`
	The y coordinate for the vector.

VIEW SOURCE

Instance Methods

Adds another vector to this vector in-place.

Parameters

`b`	`goog.math.Coordinate`
	The vector to add.

Returns

goog.math.Vec2

This vector with b added.

VIEW SOURCE

Rounds the x and y fields to the next larger integer values.

Defined by

goog.math.Coordinate

Parameters

None.

Returns

goog.math.Coordinate

This coordinate with ceil'd fields.

VIEW SOURCE

Returns a new copy of the coordinate.

Overrides

goog.math.Coordinate

Parameters

None.

Returns

goog.math.Vec2

A new vector with the same coordinates as this one.

VIEW SOURCE

Returns whether the specified value is equal to this coordinate.

Overrides

goog.math.Coordinate

Parameters

`other`	`*`
	Some other value.

Returns

boolean

Whether the specified value is equal to this coordinate.

VIEW SOURCE

Rounds the x and y fields to the next smaller integer values.

Defined by

goog.math.Coordinate

Parameters

None.

Returns

goog.math.Coordinate

This coordinate with floored fields.

VIEW SOURCE

Reverses the sign of the vector. Equivalent to scaling the vector by -1.

Parameters

None.

Returns

goog.math.Vec2

The inverted vector.

VIEW SOURCE

Returns the magnitude of the vector measured from the origin.

Parameters

None.

Returns

number

The length of the vector.

VIEW SOURCE

Normalizes the current vector to have a magnitude of 1.

Parameters

None.

Returns

goog.math.Vec2

The normalized vector.

VIEW SOURCE

Rotates this vector in-place by a given angle, specified in radians.

Parameters

`angle`	`number`
	The angle, in radians.

Returns

goog.math.Vec2

This vector rotated angle radians.

VIEW SOURCE

Rotates this coordinate clockwise about the origin (or, optionally, the given center) by the given angle, in degrees.

Defined by

goog.math.Coordinate

Parameters

`degrees`	`number`
	The angle by which to rotate this coordinate clockwise about the given center, in degrees.
`opt_center`	`goog.math.Coordinate=`
	The center of rotation. Defaults to (0, 0) if not given.

VIEW SOURCE

Rotates this coordinate clockwise about the origin (or, optionally, the given center) by the given angle, in radians.

Defined by

goog.math.Coordinate

Parameters

`radians`	`number`
	The angle by which to rotate this coordinate clockwise about the given center, in radians.
`opt_center`	`goog.math.Coordinate=`
	The center of rotation. Defaults to (0, 0) if not given.

VIEW SOURCE

Rounds the x and y fields to the nearest integer values.

Defined by

goog.math.Coordinate

Parameters

None.

Returns

goog.math.Coordinate

This coordinate with rounded fields.

VIEW SOURCE

Scales this coordinate by the given scale factors. The x and y values are scaled by sx and opt_sy respectively. If opt_sy is not given, then sx is used for both x and y.

Overrides

goog.math.Coordinate

Parameters

`sx`	`number`
	The scale factor to use for the x dimension.
`opt_sy`	`number=`
	The scale factor to use for the y dimension.

Returns

goog.math.Vec2

This vector after scaling.

VIEW SOURCE

Returns the squared magnitude of the vector measured from the origin. NOTE(brenneman): Leaving out the square root is not a significant optimization in JavaScript.

Parameters

None.

Returns

number

The length of the vector, squared.

VIEW SOURCE

Subtracts another vector from this vector in-place.

Parameters

`b`	`goog.math.Coordinate`
	The vector to subtract.

Returns

goog.math.Vec2

This vector with b subtracted.

VIEW SOURCE

Returns a nice string representing the coordinate.

Defined by

goog.math.Coordinate

Parameters

None.

Returns

string

In the form (50, 73).

VIEW SOURCE

Translates this box by the given offsets. If a goog.math.Coordinate is given, then the x and y values are translated by the coordinate's x and y. Otherwise, x and y are translated by tx and opt_ty respectively.

Defined by

goog.math.Coordinate

Parameters

`tx`	`(number\|goog.math.Coordinate\|null)`
	The value to translate x by or the the coordinate to translate this coordinate by.
`opt_ty`	`number=`
	The value to translate y by.

Returns

goog.math.Coordinate

This coordinate after translating.

VIEW SOURCE

Instance Properties

X-value

Overrides	`goog.math.Coordinate`

VIEW SOURCE

Y-value

Overrides	`goog.math.Coordinate`

VIEW SOURCE

Static Functions

Returns the determinant of two vectors.

Parameters

`a`	`goog.math.Vec2`
	The first vector.
`b`	`goog.math.Vec2`
	The second vector.

Returns

number

The determinant of the two vectors.

VIEW SOURCE

Returns the difference between two vectors as a new Vec2.

Parameters

`a`	`goog.math.Coordinate`
	The first vector.
`b`	`goog.math.Coordinate`
	The second vector.

Returns

goog.math.Vec2

The difference vector.

VIEW SOURCE

Returns the distance between two vectors.

Parameters

`a`	`goog.math.Coordinate`
	The first vector.
`b`	`goog.math.Coordinate`
	The second vector.

Returns

number

The distance.

VIEW SOURCE

Returns the dot-product of two vectors.

Parameters

`a`	`goog.math.Coordinate`
	The first vector.
`b`	`goog.math.Coordinate`
	The second vector.

Returns

number

The dot-product of the two vectors.

VIEW SOURCE

Compares vectors for equality.

Parameters

`a`	`goog.math.Coordinate`
	The first vector.
`b`	`goog.math.Coordinate`
	The second vector.

Returns

boolean

Whether the vectors have the same x and y coordinates.

VIEW SOURCE

Returns a new Vec2 object from a given coordinate.

Parameters

`a`	`goog.math.Coordinate`
	The coordinate.

Returns

goog.math.Vec2

A new vector object.

VIEW SOURCE

Returns a new Vec2 that is the linear interpolant between vectors a and b at scale-value x.

Parameters

`a`	`goog.math.Coordinate`
	Vector a.
`b`	`goog.math.Coordinate`
	Vector b.
`x`	`number`
	The proportion between a and b.

Returns

goog.math.Vec2

The interpolated vector.

VIEW SOURCE

Parameters

None.

Returns

goog.math.Vec2

A random vector inside the unit-disc.

VIEW SOURCE

Parameters

None.

Returns

goog.math.Vec2

A random unit-length vector.

VIEW SOURCE

Returns a new Vec2 that is a copy of the vector a, but rescaled by a factors sx and sy in the x and y directions. If only sx is specified, then y is scaled by the same factor as x.

Parameters

`a`	`goog.math.Coordinate`
	Vector a.
`sx`	`number`
	X scale factor.
`sy`	`number=`
	Y scale factor (optional).

Returns

goog.math.Vec2

A new rescaled vector.

VIEW SOURCE

Rotates a vector by a given angle, specified in radians, relative to a given axis rotation point. The returned vector is a newly created instance - no in-place changes are done.

Parameters

`v`	`goog.math.Vec2`
	A vector.
`axisPoint`	`goog.math.Vec2`
	The rotation axis point.
`angle`	`number`
	The angle, in radians.

Returns

goog.math.Vec2

The rotated vector in a newly created instance.

VIEW SOURCE

Returns the squared distance between two vectors.

Parameters

`a`	`goog.math.Coordinate`
	The first vector.
`b`	`goog.math.Coordinate`
	The second vector.

Returns

number

The squared distance.

VIEW SOURCE

Returns the sum of two vectors as a new Vec2.

Parameters

`a`	`goog.math.Coordinate`
	The first vector.
`b`	`goog.math.Coordinate`
	The second vector.

Returns

goog.math.Vec2

The sum vector.

VIEW SOURCE

goog.math.Vec2

new Vec2( `x`, `y` )

Instance Methods

`this.`add( `b` ) `→` `goog.math.Vec2`

`this.`ceil() `→` `goog.math.Coordinate`

`this.`clone() `→` `goog.math.Vec2`

`this.`equals( `other` ) `→` `boolean`

`this.`floor() `→` `goog.math.Coordinate`

`this.`invert() `→` `goog.math.Vec2`

`this.`magnitude() `→` `number`

`this.`normalize() `→` `goog.math.Vec2`

`this.`rotate( `angle` ) `→` `goog.math.Vec2`

`this.`rotateDegrees( `degrees`, `opt_center` ) `→` `void`

`this.`rotateRadians( `radians`, `opt_center` ) `→` `void`

`this.`round() `→` `goog.math.Coordinate`

`this.`scale( `sx`, `opt_sy` ) `→` `goog.math.Vec2`

`this.`squaredMagnitude() `→` `number`

`this.`subtract( `b` ) `→` `goog.math.Vec2`

`this.`toString() `→` `string`

`this.`translate( `tx`, `opt_ty` ) `→` `goog.math.Coordinate`

Instance Properties

`this.`x `→` `number`

`this.`y `→` `number`

Static Functions

Vec2.determinant( `a`, `b` ) `→` `number`

Vec2.difference( `a`, `b` ) `→` `goog.math.Vec2`

Vec2.distance( `a`, `b` ) `→` `number`

Vec2.dot( `a`, `b` ) `→` `number`

Vec2.equals( `a`, `b` ) `→` `boolean`

Vec2.fromCoordinate( `a` ) `→` `goog.math.Vec2`

Vec2.lerp( `a`, `b`, `x` ) `→` `goog.math.Vec2`

Vec2.random() `→` `goog.math.Vec2`

Vec2.randomUnit() `→` `goog.math.Vec2`

Vec2.rescaled( `a`, `sx`, `sy` ) `→` `goog.math.Vec2`

Vec2.rotateAroundPoint( `v`, `axisPoint`, `angle` ) `→` `goog.math.Vec2`

Vec2.squaredDistance( `a`, `b` ) `→` `number`

Vec2.sum( `a`, `b` ) `→` `goog.math.Vec2`

goog.math.Vec2

new Vec2( x, y )

Instance Methods

this.add( b ) → goog.math.Vec2

this.ceil() → goog.math.Coordinate

this.clone() → goog.math.Vec2

this.equals( other ) → boolean

this.floor() → goog.math.Coordinate

this.invert() → goog.math.Vec2

this.magnitude() → number

this.normalize() → goog.math.Vec2

this.rotate( angle ) → goog.math.Vec2

this.rotateDegrees( degrees, opt_center ) → void

this.rotateRadians( radians, opt_center ) → void

this.round() → goog.math.Coordinate

this.scale( sx, opt_sy ) → goog.math.Vec2

this.squaredMagnitude() → number

this.subtract( b ) → goog.math.Vec2

this.toString() → string

this.translate( tx, opt_ty ) → goog.math.Coordinate

Instance Properties

this.x → number

this.y → number

Static Functions

Vec2.determinant( a, b ) → number

Vec2.difference( a, b ) → goog.math.Vec2

Vec2.distance( a, b ) → number

Vec2.dot( a, b ) → number

Vec2.equals( a, b ) → boolean

Vec2.fromCoordinate( a ) → goog.math.Vec2

Vec2.lerp( a, b, x ) → goog.math.Vec2

Vec2.random() → goog.math.Vec2

Vec2.randomUnit() → goog.math.Vec2

Vec2.rescaled( a, sx, sy ) → goog.math.Vec2

Vec2.rotateAroundPoint( v, axisPoint, angle ) → goog.math.Vec2

Vec2.squaredDistance( a, b ) → number

Vec2.sum( a, b ) → goog.math.Vec2

new Vec2( `x`, `y` )

`this.`add( `b` ) `→` `goog.math.Vec2`

`this.`ceil() `→` `goog.math.Coordinate`

`this.`clone() `→` `goog.math.Vec2`

`this.`equals( `other` ) `→` `boolean`

`this.`floor() `→` `goog.math.Coordinate`

`this.`invert() `→` `goog.math.Vec2`

`this.`magnitude() `→` `number`

`this.`normalize() `→` `goog.math.Vec2`

`this.`rotate( `angle` ) `→` `goog.math.Vec2`

`this.`rotateDegrees( `degrees`, `opt_center` ) `→` `void`

`this.`rotateRadians( `radians`, `opt_center` ) `→` `void`

`this.`round() `→` `goog.math.Coordinate`

`this.`scale( `sx`, `opt_sy` ) `→` `goog.math.Vec2`

`this.`squaredMagnitude() `→` `number`

`this.`subtract( `b` ) `→` `goog.math.Vec2`

`this.`toString() `→` `string`

`this.`translate( `tx`, `opt_ty` ) `→` `goog.math.Coordinate`

`this.`x `→` `number`

`this.`y `→` `number`

Vec2.determinant( `a`, `b` ) `→` `number`

Vec2.difference( `a`, `b` ) `→` `goog.math.Vec2`

Vec2.distance( `a`, `b` ) `→` `number`

Vec2.dot( `a`, `b` ) `→` `number`

Vec2.equals( `a`, `b` ) `→` `boolean`

Vec2.fromCoordinate( `a` ) `→` `goog.math.Vec2`

Vec2.lerp( `a`, `b`, `x` ) `→` `goog.math.Vec2`

Vec2.random() `→` `goog.math.Vec2`

Vec2.randomUnit() `→` `goog.math.Vec2`

Vec2.rescaled( `a`, `sx`, `sy` ) `→` `goog.math.Vec2`

Vec2.rotateAroundPoint( `v`, `axisPoint`, `angle` ) `→` `goog.math.Vec2`

Vec2.squaredDistance( `a`, `b` ) `→` `number`

Vec2.sum( `a`, `b` ) `→` `goog.math.Vec2`