math.Vec2 Extends goog.math.Coordinate
Class for a two-dimensional vector object and assorted functions useful for manipulating points.

Inheritance

Constructor

goog.math.Vec2(x, y)

Parameters

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

Instance Methods

Public Protected Private
Defined in goog.math.Vec2
add(b) ⇒
goog.math.Vec2
Adds another vector to this vector in-place. Uses goog.math.Vec2.sum(a, b) to return a new vector.
Arguments:
b :
goog.math.Coordinate
The vector to add.
Returns: 
goog.math.Vec2
  This vector with b added.
code »
clone() ⇒
goog.math.Vec2
No description.
Returns: 
goog.math.Vec2
  A new vector with the same coordinates as this one.
code »
equals(b) ⇒
boolean
Compares this vector with another for equality.
Arguments:
b :
goog.math.Vec2
The other vector.
Returns: 
boolean
  Whether this vector has the same x and y as the given vector.
code »
invert() ⇒
goog.math.Vec2
Reverses the sign of the vector. Equivalent to scaling the vector by -1.
Returns: 
goog.math.Vec2
  The inverted vector.
code »
magnitude() ⇒
number
Returns the magnitude of the vector measured from the origin.
Returns: 
number
  The length of the vector.
code »
normalize() ⇒
goog.math.Vec2
Normalizes the current vector to have a magnitude of 1.
Returns: 
goog.math.Vec2
  The normalized vector.
code »
rotate(angle) ⇒
goog.math.Vec2
Rotates this vector in-place by a given angle, specified in radians.
Arguments:
angle :
number
The angle, in radians.
Returns: 
goog.math.Vec2
  This vector rotated angle radians.
code »
scale(s) ⇒
goog.math.Vec2
Scales the current vector by a constant.
Arguments:
s :
number
The scale factor.
Returns: 
goog.math.Vec2
  The scaled vector.
code »
squaredMagnitude() ⇒
number
Returns the squared magnitude of the vector measured from the origin. NOTE(user): Leaving out the square root is not a significant optimization in JavaScript.
Returns: 
number
  The length of the vector, squared.
code »
subtract(b) ⇒
goog.math.Vec2
Subtracts another vector from this vector in-place. Uses goog.math.Vec2.difference(a, b) to return a new vector.
Arguments:
b :
goog.math.Coordinate
The vector to subtract.
Returns: 
goog.math.Vec2
  This vector with b subtracted.
code »
Defined in goog.math.Coordinate
clone() ⇒
goog.math.Coordinate
Returns a new copy of the coordinate.
Returns: 
goog.math.Coordinate
  A clone of this coordinate.
code »
toString() ⇒
string
Returns a nice string representing the coordinate.
Returns: 
string
  In the form (50, 73).
code »

Instance Properties

Defined in goog.math.Vec2
x :
number
X-value
Code »
y :
number
Y-value
Code »
Defined in goog.math.Coordinate
x :
number
X-value
Code »
y :
number
Y-value
Code »

Static Methods

goog.math.Vec2.difference(a, b) ⇒
goog.math.Vec2
Returns the difference between two vectors as a new Vec2.
Arguments:
a :
goog.math.Coordinate
The first vector.
b :
goog.math.Coordinate
The second vector.
Returns: 
goog.math.Vec2
  The difference vector.
code »
goog.math.Vec2.distance(a, b) ⇒
number
Returns the distance between two vectors.
Arguments:
a :
goog.math.Coordinate
The first vector.
b :
goog.math.Coordinate
The second vector.
Returns: 
number
  The distance.
code »
goog.math.Vec2.dot(a, b) ⇒
number
Returns the dot-product of two vectors.
Arguments:
a :
goog.math.Coordinate
The first vector.
b :
goog.math.Coordinate
The second vector.
Returns: 
number
  The dot-product of the two vectors.
code »
goog.math.Vec2.equals(a, b) ⇒
boolean
Compares vectors for equality.
Arguments:
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.
code »
goog.math.Vec2.fromCoordinate(a) ⇒
goog.math.Vec2
Returns a new Vec2 object from a given coordinate.
Arguments:
a :
goog.math.Coordinate
The coordinate.
Returns: 
goog.math.Vec2
  A new vector object.
code »
goog.math.Vec2.lerp(a, b, x) ⇒
goog.math.Vec2
Returns a new Vec2 that is the linear interpolant between vectors a and b at scale-value x.
Arguments:
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.
code »
goog.math.Vec2.random() ⇒
goog.math.Vec2
No description.
Returns: 
goog.math.Vec2
  A random vector inside the unit-disc.
code »
goog.math.Vec2.randomUnit() ⇒
goog.math.Vec2
No description.
Returns: 
goog.math.Vec2
  A random unit-length vector.
code »
goog.math.Vec2.rotateAroundPoint(v, axisPoint, angle) ⇒
goog.math.Vec2
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.
Arguments:
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.
code »
goog.math.Vec2.squaredDistance(a, b) ⇒
number
Returns the squared distance between two vectors.
Arguments:
a :
goog.math.Coordinate
The first vector.
b :
goog.math.Coordinate
The second vector.
Returns: 
number
  The squared distance.
code »
goog.math.Vec2.sum(a, b) ⇒
goog.math.Vec2
Returns the sum of two vectors as a new Vec2.
Arguments:
a :
goog.math.Coordinate
The first vector.
b :
goog.math.Coordinate
The second vector.
Returns: 
goog.math.Vec2
  The sum vector.
code »

Package math

Package Reference