Class Vector2

Readonlydimension

const v = new Vector2(3, 4);
console.log(v.dimension); // 2
Copy

Readonlyelements

const v = new Vector2(3, 4);
console.log(v.elements); // [3, 4]
Copy

x

• get x(): number

  Returns number

  Example

  const v = new Vector2(3, 4);
  console.log(v.x); // 3
  Copy

• set x(x: number): void

  Parameters

  • x: number

  Returns void

  Example

  const v = new Vector2(3, 4);
  v.x = 5;
  console.log(v.x); // 5
  Copy

y

• get y(): number

  Returns number

  Example

  const v = new Vector2(3, 4);
  console.log(v.y); // 4
  Copy

• set y(y: number): void

  Parameters

  • y: number

  Returns void

  Example

  const v = new Vector2(3, 4);
  v.y = 5;
  console.log(v.y); // 5
  Copy

constructor

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

  Parameters

  • x: number
  • y: number

  Returns Vector2

  Example

  const v = new Vector2(3, 4);
  Copy

Staticzero

• zero(): Vector2

  Creates a zero vector instance

  Returns Vector2

  new zero vector instance

  Example

  const v = Vector2.zero();
  console.log(v); // (0, 0)
  Copy

Staticone

• one(): Vector2

  Creates all ones vector instance

  Returns Vector2

  new all ones vector instance

  Example

  const v = Vector2.one();
  console.log(v); // (1, 1)
  Copy

setX

• setX(x: number): Vector2

  Sets x component (mutate this)

  Parameters

  • x: number

  Returns Vector2

  this instance, for method chaining

setY

• setY(y: number): Vector2

  Sets y component (mutate this)

  Parameters

  • y: number

  Returns Vector2

  this instance, for method chaining

clone

• clone(): Vector2

  Creates new instance has same elements (pure)

  Returns Vector2

  new cloned vector instance

  Example

  const v = new Vector2(3, 4);
  const c = v.clone();
  console.log(c); // (3, 4)
  Copy

isZero

• isZero(): boolean

  Determines if this vector is the zero vector (all components are zero)

  Returns boolean

  true if this vector is exactly zero, false otherwise

  Example

  const zero = Vector2.zero();
  const ones = Vector2.one();
  console.log(zero.isZero()); // true
  console.log(ones.isZero()); 
  Copy

set

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

  Sets all elements (mutates this)

  Parameters

  • x: number
  • y: number

  Returns Vector2

  this instance, for method chaining

  Example

  const v = new Vector2(3, 4);
  v.set(5, 6);
  console.log(v); // (5, 6)
  Copy

copy

• copy(other: Vector2): Vector2

  Copies all elements from other vector (mutates this)

  Parameters

  • other: Vector2

  Returns Vector2

  this instance, for method chaining

  Example

  const v1 = new Vector2(3, 4);
  const v2 = new Vector2(5, 6);
  v1.copy(v2);
  console.log(v1); // (5, 6)
  console.log(v2); // (5, 6)
  Copy

add

• add(other: Vector2): Vector2

  Adds by other vector (mutates this)

  Parameters

  • other: Vector2

    other vector

  Returns Vector2

  this instance, for method chaining

  Example

  const v1 = new Vector2(3, 4);
  const v2 = new Vector2(5, 6);
  v1.add(v2);
  console.log(v1); // (8, 10)
  console.log(v2); // (5, 6)
  Copy

subtract

• subtract(other: Vector2): Vector2

  Subtracts by other vector (mutates this)

  Parameters

  • other: Vector2

    other vector

  Returns Vector2

  this instance, for method chaining

  Example

  const v1 = new Vector2(3, 4);
  const v2 = new Vector2(5, 6);
  v1.subtract(v2);
  console.log(v1); // (-2, -2)
  console.log(v2); // (5, 6)
  Copy

multiplyScalar

• multiplyScalar(scalar: number): Vector2

  Multiplies all elements by scalar (mutates this)

  Parameters

  • scalar: number

  Returns Vector2

  this instance, for method chaining

  Example

  const v = new Vector2(3, 4);
  v.multiplyScalar(2);
  console.log(v); // (6, 8)
  Copy

divideScalar

• divideScalar(scalar: number): Vector2

  Divides all elements by scalar (mutates this)

  Parameters

  • scalar: number

  Returns Vector2

  this instance, for method chaining

  Example

  const v = new Vector2(3, 4);
  v.divideScalar(2);
  console.log(v); // (1.5, 2)
  Copy

length

• length(): number

  Calculates the length of this vector (pure)

  Returns number

  the length of this vector (always non-negative)

  Example

  const v = new Vector2(3, 4);
  console.log(v.length()); // 5
  Copy

normalize

• normalize(): Vector2

  Normalizes this vector to length 1 (mutates this)

  Returns Vector2

  this instance, for method chaining

  Example

  const v = new Vector2(3, 4);
  v.normalize();
  console.log(v); // (0.6, 0.8)
  Copy

rotate

• rotate(radian: number): Vector2

  Rotates vector by given angle in radians (mutates this)

  Parameters

  • radian: number

    angle in radians, measured counter-clockwise from the positive x-axis

  Returns Vector2

  this instance, for method chaining

  Example

  const v = new Vector2(1, 1);
  v.rotate(Math.PI / 2);
  console.log(v); // (-1, 1)
  Copy

applyMatrix3

• applyMatrix3(matrix: Matrix3): Vector2

  Applies matrix to this vector (mutates this)

  Parameters

  • matrix: Matrix3

  Returns Vector2

  this instance, for method chaining

applyMatrix4

• applyMatrix4(matrix: Matrix4): Vector2

  Applies matrix to this vector (mutates this)

  Parameters

  • matrix: Matrix4

  Returns Vector2

  this instance, for method chaining

applyQuaternion

• applyQuaternion(quaternion: Quaternion): Vector2

  Applies quaternion to this vector (mutates this)

  Parameters

  • quaternion: Quaternion

  Returns Vector2

  this instance, for method chaining