The goog.vec.Vec2 Namespace

.AnyType

@typedef
{goog.vec.AnyType}

.Float32

@typedef
{goog.vec.Float32}

.Float64

@typedef
{goog.vec.Float64}

.Number

@typedef
{goog.vec.Number}

.add(vec0, vec1, resultVec)

Performs a component-wise addition of vec0 and vec1 together storing the result into resultVec.

vec0 {goog.vec.Vec2.AnyType}
The first addend.
vec1 {goog.vec.Vec2.AnyType}
The second addend.
resultVec {goog.vec.Vec2.AnyType}
The vector to receive the result. May be vec0 or vec1.
returns {!goog.vec.Vec2.AnyType}
Return resultVec so that operations can be chained together.

.cloneFloat32

Creates a clone of the given 2 element Float32 vector.

vec {goog.vec.Vec2.Float32}
The source 2 element vector.
returns {!goog.vec.Vec2.Float32}
The new cloned vector.

.cloneFloat64

Creates a clone of the given 2 element vector.

vec {goog.vec.Vec2.Float64}
The source 2 element vector.
returns {!goog.vec.Vec2.Float64}
The new cloned vector.

.createFloat32()

Creates a 2 element vector of Float32. The array is initialized to zero.

returns {!goog.vec.Vec2.Float32}
The new 2 element array.

.createFloat32FromArray(vec)

Creates a new 2 element FLoat32 vector initialized with the value from the given array.

vec {goog.vec.Vec2.AnyType}
The source 2 element array.
returns {!goog.vec.Vec2.Float32}
The new 2 element array.

.createFloat32FromValues(vec0, vec1)

Creates a new 2 element Float32 vector initialized with the supplied values.

vec0 {number}
The value for element at index 0.
vec1 {number}
The value for element at index 1.
returns {!goog.vec.Vec2.Float32}
The new vector.

.createFloat64()

Creates a 2 element vector of Float64. The array is initialized to zero.

returns {!goog.vec.Vec2.Float64}
The new 2 element array.

.createFloat64FromArray(vec)

Creates a new 2 element Float64 vector initialized with the value from the given array.

vec {goog.vec.Vec2.AnyType}
The source 2 element array.
returns {!goog.vec.Vec2.Float64}
The new 2 element array.

.createFloat64FromValues(vec0, vec1)

Creates a new 2 element Float64 vector initialized with the supplied values.

vec0 {number}
The value for element at index 0.
vec1 {number}
The value for element at index 1.
returns {!goog.vec.Vec2.Float64}
The new vector.

.createNumber()

Creates a 2 element vector of Number. The array is initialized to zero.

returns {!goog.vec.Vec2.Number}
The new 2 element array.

.direction(vec0, vec1, resultVec)

Returns a unit vector pointing from one point to another. If the input points are equal then the result will be all zeros.

vec0 {goog.vec.Vec2.AnyType}
Origin point.
vec1 {goog.vec.Vec2.AnyType}
Target point.
resultVec {goog.vec.Vec2.AnyType}
The vector to receive the results (may be vec0 or vec1).
returns {!goog.vec.Vec2.AnyType}
Return resultVec so that operations can be chained together.

.distance(vec0, vec1)

Returns the distance between two points.

vec0 {goog.vec.Vec2.AnyType}
First point.
vec1 {goog.vec.Vec2.AnyType}
Second point.
returns {number}
The distance between the points.

.distanceSquared(vec0, vec1)

Returns the squared distance between two points.

vec0 {goog.vec.Vec2.AnyType}
First point.
vec1 {goog.vec.Vec2.AnyType}
Second point.
returns {number}
The squared distance between the points.

.dot(vec0, vec1)

Returns the scalar product of vectors vec0 and vec1.

vec0 {goog.vec.Vec2.AnyType}
The first vector.
vec1 {goog.vec.Vec2.AnyType}
The second vector.
returns {number}
The scalar product.

.equals(vec0, vec1)

Returns true if the components of vec0 are equal to the components of vec1.

vec0 {goog.vec.Vec2.AnyType}
The first vector.
vec1 {goog.vec.Vec2.AnyType}
The second vector.
returns {boolean}
True if the vectors are equal, false otherwise.

.lerp(vec0, vec1, f, resultVec)

Linearly interpolate from vec0 to vec1 according to f. The value of f should be in the range [0..1] otherwise the results are undefined.

vec0 {goog.vec.Vec2.AnyType}
The first vector.
vec1 {goog.vec.Vec2.AnyType}
The second vector.
f {number}
The interpolation factor.
resultVec {goog.vec.Vec2.AnyType}
The vector to receive the results (may be vec0 or vec1).
returns {!goog.vec.Vec2.AnyType}
Return resultVec so that operations can be chained together.

.magnitude(vec0)

Returns the magnitude of the given vector.

vec0 {goog.vec.Vec2.AnyType}
The vector.
returns {number}
The magnitude of the vector.

.magnitudeSquared(vec0)

Returns the magnitudeSquared of the given vector.

vec0 {goog.vec.Vec2.AnyType}
The vector.
returns {number}
The magnitude of the vector.

.negate(vec0, resultVec)

Negates vec0, storing the result into resultVec.

vec0 {goog.vec.Vec2.AnyType}
The vector to negate.
resultVec {goog.vec.Vec2.AnyType}
The vector to receive the result. May be vec0.
returns {!goog.vec.Vec2.AnyType}
Return resultVec so that operations can be chained together.

.normalize(vec0, resultVec)

Normalizes the given vector storing the result into resultVec.

vec0 {goog.vec.Vec2.AnyType}
The vector to normalize.
resultVec {goog.vec.Vec2.AnyType}
The vector to receive the result. May be vec0.
returns {!goog.vec.Vec2.AnyType}
Return resultVec so that operations can be chained together.

.scale(vec0, scalar, resultVec)

Multiplies each component of vec0 with scalar storing the product into resultVec.

vec0 {goog.vec.Vec2.AnyType}
The source vector.
scalar {number}
The value to multiply with each component of vec0.
resultVec {goog.vec.Vec2.AnyType}
The vector to receive the result. May be vec0.
returns {!goog.vec.Vec2.AnyType}
Return resultVec so that operations can be chained together.

.setFromArray(vec, values)

Initializes the vector with the given array of values.

vec {goog.vec.Vec2.AnyType}
The vector to receive the values.
values {goog.vec.Vec2.AnyType}
The array of values.
returns {!goog.vec.Vec2.AnyType}
Return vec so that operations can be chained together.

.setFromValues(vec, vec0, vec1)

Initializes the vector with the given values.

vec {goog.vec.Vec2.AnyType}
The vector to receive the values.
vec0 {number}
The value for element at index 0.
vec1 {number}
The value for element at index 1.
returns {!goog.vec.Vec2.AnyType}
Return vec so that operations can be chained together.

.subtract(vec0, vec1, resultVec)

Performs a component-wise subtraction of vec1 from vec0 storing the result into resultVec.

vec0 {goog.vec.Vec2.AnyType}
The minuend.
vec1 {goog.vec.Vec2.AnyType}
The subtrahend.
resultVec {goog.vec.Vec2.AnyType}
The vector to receive the result. May be vec0 or vec1.
returns {!goog.vec.Vec2.AnyType}
Return resultVec so that operations can be chained together.

Documentation generated using JvJsDoc, version 0.5 on 2012-09-03.