Class Vector2

2D vector.

( class Vector2 implements Vector )

Hierarchy

Vector2

Implements

Vector

Index

Constructors

constructor

Properties

x
y

Methods

Constructors

constructor

new Vector2(x?: number, y?: number): Vector2

- Defined in RuntimeFull.ts:747
Parameters
- Optional x: number
- Optional y: number
Returns Vector2

Properties

x

x: number

y

y: number

Methods

add

add(v: Vector2): Vector2

- Defined in RuntimeFull.ts:794
Adds v to this vector.

Parameters
- v: Vector2
Returns Vector2

addScalar

addScalar(s: number): Vector2

- Defined in RuntimeFull.ts:798
Adds the scalar value s to this vector's x and y values.

Parameters
- s: number
Returns Vector2

addScaledVector

addScaledVector(v: Vector2, s: number): Vector2

- Defined in RuntimeFull.ts:806
Adds the multiple of v and s to this vector.

Parameters
- v: Vector2
- s: number
Returns Vector2

addVectors

addVectors(a: Vector2, b: Vector2): Vector2

- Defined in RuntimeFull.ts:802
Sets this vector to a + b.

Parameters
- a: Vector2
- b: Vector2
Returns Vector2

angle

angle(): number

- Defined in RuntimeFull.ts:926
computes the angle in radians with respect to the positive x-axis

Returns number

applyMatrix3

applyMatrix3(m: Matrix3): Vector2

- Defined in RuntimeFull.ts:843
Multiplies this vector (with an implicit 1 as the 3rd component) by m.

Parameters
- m: Matrix3
Returns Vector2

ceil

ceil(): Vector2

- Defined in RuntimeFull.ts:883
The x and y components of the vector are rounded up to the nearest integer value.

Returns Vector2

clamp

clamp(min: Vector2, max: Vector2): Vector2

- Defined in RuntimeFull.ts:860
If this vector's x or y value is greater than the max vector's x or y value, it is replaced by the corresponding value. If this vector's x or y value is less than the min vector's x or y value, it is replaced by the corresponding value.

Parameters
- min: Vector2
  
  the minimum x and y values.
- max: Vector2
  
  the maximum x and y values in the desired range.
Returns Vector2

clampLength

clampLength(min: number, max: number): Vector2

- Defined in RuntimeFull.ts:874
If this vector's length is greater than the max value, it is replaced by the max value. If this vector's length is less than the min value, it is replaced by the min value.

Parameters
- min: number
  
  the minimum value the length will be clamped to.
- max: number
  
  the maximum value the length will be clamped to.
Returns Vector2

clampScalar

clampScalar(min: number, max: number): Vector2

- Defined in RuntimeFull.ts:867
If this vector's x or y values are greater than the max value, they are replaced by the max value. If this vector's x or y values are less than the min value, they are replaced by the min value.

Parameters
- min: number
  
  the minimum value the components will be clamped to.
- max: number
  
  the maximum value the components will be clamped to.
Returns Vector2

clone

clone(): this

Implementation of Vector.clone
- Defined in RuntimeFull.ts:785
Clones this vector.

Returns this

copy

copy(v: this): this

Implementation of Vector.copy
- Defined in RuntimeFull.ts:789
Copies value of v to this vector.

Parameters
- v: this
Returns this

distanceTo

distanceTo(v: Vector2): number

- Defined in RuntimeFull.ts:931
Computes distance of this vector to v.

Parameters
- v: Vector2
Returns number

distanceToManhattan

distanceToManhattan(v: Vector2): number

- Defined in RuntimeFull.ts:939
deprecated

Use {@link Vector2#manhattanDistanceTo .manhattanDistanceTo()} instead.

Parameters
- v: Vector2
Returns number

distanceToSquared

distanceToSquared(v: Vector2): number

- Defined in RuntimeFull.ts:935
Computes squared distance of this vector to v.

Parameters
- v: Vector2
Returns number

divide

divide(v: Vector2): Vector2

- Defined in RuntimeFull.ts:833
Divides this vector by v.

Parameters
- v: Vector2
Returns Vector2

divideScalar

divideScalar(s: number): Vector2

Implementation of Vector.divideScalar
- Defined in RuntimeFull.ts:838
Divides this vector by scalar s. Set vector to ( 0, 0 ) if s == 0.

Parameters
- s: number
Returns Vector2

dot

dot(v: Vector2): number

- Defined in RuntimeFull.ts:901
Computes dot product of this vector and v.

Parameters
- v: Vector2
Returns number

equals

equals(v: Vector2): boolean

- Defined in RuntimeFull.ts:963
Checks for strict equality of this vector and v.

Parameters
- v: Vector2
Returns boolean

floor

floor(): Vector2

- Defined in RuntimeFull.ts:879
The components of the vector are rounded down to the nearest integer value.

Returns Vector2

fromArray

fromArray(array: number[], offset?: number): Vector2

- Defined in RuntimeFull.ts:970
Sets this vector's x value to be array[offset] and y value to be array[offset + 1].

Parameters
- array: number[]
  
  the source array.
- Optional offset: number
  
  (optional) offset into the array. Default is 0.
Returns Vector2

getComponent

getComponent(index: number): number

Implementation of Vector.getComponent
- Defined in RuntimeFull.ts:780
Gets a component of this vector.

Parameters
- index: number
Returns number

length

length(): number

Implementation of Vector.length
- Defined in RuntimeFull.ts:911
Computes length of this vector.

Returns number

lengthManhattan

lengthManhattan(): number

- Defined in RuntimeFull.ts:916
deprecated

Use {@link Vector2#manhattanLength .manhattanLength()} instead.

Returns number

lengthSq

lengthSq(): number

Implementation of Vector.lengthSq
- Defined in RuntimeFull.ts:906
Computes squared length of this vector.

Returns number

lerp

lerp(v: Vector2, alpha: number): Vector2

- Defined in RuntimeFull.ts:951
Linearly interpolates between this vector and v, where alpha is the distance along the line - alpha = 0 will be this vector, and alpha = 1 will be v.

Parameters
- v: Vector2
  
  vector to interpolate towards.
- alpha: number
  
  interpolation factor in the closed interval [0, 1].
Returns Vector2

lerpVectors

lerpVectors(v1: Vector2, v2: Vector2, alpha: number): Vector2

- Defined in RuntimeFull.ts:958
Sets this vector to be the vector linearly interpolated between v1 and v2 where alpha is the distance along the line connecting the two vectors - alpha = 0 will be v1, and alpha = 1 will be v2.

Parameters
- v1: Vector2
  
  the starting vector.
- v2: Vector2
  
  vector to interpolate towards.
- alpha: number
  
  interpolation factor in the closed interval [0, 1].
Returns Vector2

manhattanDistanceTo

manhattanDistanceTo(v: Vector2): number

- Defined in RuntimeFull.ts:1003
Computes the Manhattan length (distance) from this vector to the given vector v

see

Wikipedia: Taxicab Geometry

Parameters
- v: Vector2
Returns number

manhattanLength

manhattanLength(): number

- Defined in RuntimeFull.ts:992
Computes the Manhattan length of this vector.

see

Wikipedia: Taxicab Geometry

Returns number

max

max(v: Vector2): Vector2

- Defined in RuntimeFull.ts:852
If this vector's x or y value is less than v's x or y value, replace that value with the corresponding max value.

Parameters
- v: Vector2
Returns Vector2

min

min(v: Vector2): Vector2

- Defined in RuntimeFull.ts:848
If this vector's x or y value is greater than v's x or y value, replace that value with the corresponding min value.

Parameters
- v: Vector2
Returns Vector2

multiply

multiply(v: Vector2): Vector2

- Defined in RuntimeFull.ts:824
Multiplies this vector by v.

Parameters
- v: Vector2
Returns Vector2

multiplyScalar

multiplyScalar(scalar: number): Vector2

Implementation of Vector.multiplyScalar
- Defined in RuntimeFull.ts:828
Multiplies this vector by scalar s.

Parameters
- scalar: number
Returns Vector2

negate

negate(): Vector2

Implementation of Vector.negate
- Defined in RuntimeFull.ts:896
Inverts this vector.

Returns Vector2

normalize

normalize(): Vector2

Implementation of Vector.normalize
- Defined in RuntimeFull.ts:921
Normalizes this vector.

Returns Vector2

rotateAround

rotateAround(center: Vector2, angle: number): Vector2

- Defined in RuntimeFull.ts:983
Rotates the vector around center by angle radians.

Parameters
- center: Vector2
  
  the point around which to rotate.
- angle: number
  
  the angle to rotate, in radians.
Returns Vector2

round

round(): Vector2

- Defined in RuntimeFull.ts:887
The components of the vector are rounded to the nearest integer value.

Returns Vector2

roundToZero

roundToZero(): Vector2

- Defined in RuntimeFull.ts:891
The components of the vector are rounded towards zero (up if negative, down if positive) to an integer value.

Returns Vector2

set

set(x: number, y: number): Vector2

- Defined in RuntimeFull.ts:756
Sets value of this vector.

Parameters
- x: number
- y: number
Returns Vector2

setComponent

setComponent(index: number, value: number): void

Implementation of Vector.setComponent
- Defined in RuntimeFull.ts:776
Sets a component of this vector.

Parameters
- index: number
- value: number
Returns void

setLength

setLength(length: number): Vector2

Implementation of Vector.setLength
- Defined in RuntimeFull.ts:944
Normalizes this vector and multiplies it by l.

Parameters
- length: number
Returns Vector2

setScalar

setScalar(scalar: number): Vector2

- Defined in RuntimeFull.ts:761
Sets the x and y values of this vector both equal to scalar.

Parameters
- scalar: number
Returns Vector2

setX

setX(x: number): Vector2

- Defined in RuntimeFull.ts:766
Sets X component of this vector.

Parameters
- x: number
Returns Vector2

setY

setY(y: number): Vector2

- Defined in RuntimeFull.ts:771
Sets Y component of this vector.

Parameters
- y: number
Returns Vector2

sub

sub(v: Vector2): Vector2

- Defined in RuntimeFull.ts:811
Subtracts v from this vector.

Parameters
- v: Vector2
Returns Vector2

subScalar

subScalar(s: number): Vector2

- Defined in RuntimeFull.ts:815
Subtracts s from this vector's x and y components.

Parameters
- s: number
Returns Vector2

subVectors

subVectors(a: Vector2, b: Vector2): Vector2

- Defined in RuntimeFull.ts:819
Sets this vector to a - b.

Parameters
- a: Vector2
- b: Vector2
Returns Vector2

toArray

toArray(array?: number[], offset?: number): number[]

- Defined in RuntimeFull.ts:976
Returns an array [x, y], or copies x and y into the provided array.

Parameters
- Optional array: number[]
  
  (optional) array to store the vector to. If this is not provided, a new array will be created.
- Optional offset: number
  
  (optional) optional offset into the array.
Returns number[]

Generated using TypeDoc