Class MutableVector

Mutable vector defines a point in 2D or 3D and can be altered after creation.

Implements

GenericVector

Index

Constructors

Methods

add distanceSquaredTo distanceTo divide equals getX getY getZ length lengthCheap lengthSquared multiply nearEqual normalize setTo setToVector subtract toString clone

Constructors

constructor

new MutableVector(x, y, opt_z?): MutableVector
Parameters
- x: number
  the X value of the Vector
- y: number
  the Y value of the Vector
- Optional opt_z: number
  the Z value of the Vector (optional, zero is default value)
Returns MutableVector
- Defined in lab/util/MutableVector.ts:30

Methods

add

add(p): MutableVector
Adds the given GenericVector to this MutableVector.
Parameters
- p: GenericVector
  vector to add
Returns MutableVector
this MutableVector for chaining
- Defined in lab/util/MutableVector.ts:57

distanceSquaredTo

distanceSquaredTo(point): number
Returns distance-squared between this MutableVector and another GenericVector regarding both as points in space. Computationally inexpensive because it only uses multiplication, no square root.
Parameters
- point: GenericVector
  vector to calculate distance to
Returns number
distance squared between this point and the given point
- Defined in lab/util/MutableVector.ts:70

distanceTo

distanceTo(point): number
Returns distance between this MutableVector and another GenericVector regarding both as points in space. Computationally expensive because it involves as square root.
Parameters
- point: GenericVector
  vector to calculate distance to
Returns number
distance between this point and the given point
- Defined in lab/util/MutableVector.ts:82

divide

divide(factor): MutableVector
Divides this MutableVector by the given factor.
Parameters
- factor: number
  factor by which to divide this vector, must be greater than Vector.TINY_POSITIVE
Returns MutableVector
this MutableVector for chaining

Throws
if factor is less than Vector.TINY_POSITIVE
- Defined in lab/util/MutableVector.ts:93

equals

equals(vector): boolean
Returns true if and only if the other object is a GenericVector with the same values.
Parameters
- vector: GenericVector
  the object to compare to
Returns boolean
true iff the other object is a GenericVector with the same values.
- Defined in lab/util/MutableVector.ts:111

getX

getX(): number
Returns the X value of this GenericVector.

Returns number
the X value of this GenericVector
Implementation of GenericVector.getX
- Defined in lab/util/MutableVector.ts:120

getY

getY(): number
Returns the Y value of this GenericVector.

Returns number
the Y value of this GenericVector
Implementation of GenericVector.getY
- Defined in lab/util/MutableVector.ts:125

getZ

getZ(): number
Returns the Z value of this GenericVector.

Returns number
the Z value of this GenericVector
Implementation of GenericVector.getZ
- Defined in lab/util/MutableVector.ts:130

length

length(): number
Returns length of this MutableVector. Note this is computationally expensive as it involves taking a square root.

Returns number
length of this MutableVector
- Defined in lab/util/MutableVector.ts:138

lengthCheap

lengthCheap(): number
Computationally cheap version of length which avoids the square root; returns sum of absolute value of each component x, y, z.

Returns number
sum of absolute value of each component x, y, z.
- Defined in lab/util/MutableVector.ts:146

lengthSquared

lengthSquared(): number
Returns length squared of this MutableVector. Computationally cheap because it only uses multiplication, no square root.

Returns number
length squared of this vector
- Defined in lab/util/MutableVector.ts:158

multiply

multiply(factor): MutableVector
Multiplies this MutableVector by the given factor.
Parameters
- factor: number
  factor by which to multiply this vector
Returns MutableVector
this MutableVector for chaining
- Defined in lab/util/MutableVector.ts:170

nearEqual

nearEqual(vector, opt_tolerance?): boolean
Returns true if this MutableVector is nearly equal to another GenericVector.
Parameters
- vector: GenericVector
  the vector to compare to
- Optional opt_tolerance: number
  optional tolerance for equality test
Returns boolean
true if the vectors are similar
- Defined in lab/util/MutableVector.ts:182

normalize

normalize(): Vector
Returns the normalized version of this MutableVector, having unit length and the same direction.

Returns Vector
normalized version of this MutableVector, having unit length and the same direction

Throws
if this MutableVector has length less than Vector.TINY_POSITIVE
- Defined in lab/util/MutableVector.ts:202

setTo

setTo(x, y, z?): MutableVector
Modifies this MutableVector to have the given values.
Parameters
- x: number
  the X value of the vector
- y: number
  the Y value of the vector
- Optional z: number
  the Z value of the vector, uses zero if not defined
Returns MutableVector
this vector
- Defined in lab/util/MutableVector.ts:217

setToVector

setToVector(p): MutableVector
Modifies this MutableVector to have the same values as the given GenericVector.
Parameters
- p: GenericVector
  vector to copy from
Returns MutableVector
this vector
- Defined in lab/util/MutableVector.ts:228

subtract

subtract(p): MutableVector
Subtracts the given GenericVector from this MutableVector.
Parameters
- p: GenericVector
  vector to subtract
Returns MutableVector
difference of this vector and given vector
- Defined in lab/util/MutableVector.ts:239

toString

toString(): string
Returns string
Inherit Doc
- Defined in lab/util/MutableVector.ts:38

`Static` clone

clone(v): MutableVector
Returns a new MutableVector having the same values as the input GenericVector.
Parameters
- v: GenericVector
  vector to copy
Returns MutableVector
a new MutableVector with the same values as the input GenericVector
- Defined in lab/util/MutableVector.ts:49

Generated using TypeDoc