Class Vector3

Readonlydimension

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

Readonlyelements

const v = new Vector3(4, 5, 6);
console.log(v.elements); // [4, 5, 6]
Copy

x

• get x(): number

  Returns number

  Example

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

• set x(x: number): void

  Parameters

  • x: number

  Returns void

  Example

  const v = new Vector3(4, 5, 6);
  v.x = 7;
  console.log(v.x); // 7
  Copy

y

• get y(): number

  Returns number

  Example

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

• set y(y: number): void

  Parameters

  • y: number

  Returns void

  Example

  const v = new Vector3(4, 5, 6);
  v.y = 7;
  console.log(v.y); // 7
  Copy

z

• get z(): number

  Returns number

  Example

  const v = new Vector3(4, 5, 6);
  console.log(v.z); // 6
  Copy

• set z(z: number): void

  Parameters

  • z: number

  Returns void

  Example

  const v = new Vector3(4, 5, 6);
  v.z = 7;
  console.log(v.z); // 7
  Copy

constructor

• new Vector3(x: number, y: number, z: number): Vector3

  Parameters

  • x: number
  • y: number
  • z: number

  Returns Vector3

  Example

  const v = new Vector3(4, 5, 6);
  Copy

Staticzero

• zero(): Vector3

  Creates a zero vector instance

  Returns Vector3

  new zero vector instance

  Example

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

Staticone

• one(): Vector3

  Creates all ones vector instance

  Returns Vector3

  new all ones vector instance

  Example

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

setX

• setX(x: number): Vector3

  Sets x component (mutate this)

  Parameters

  • x: number

  Returns Vector3

  this instance, for method chaining

setY

• setY(y: number): Vector3

  Sets y component (mutate this)

  Parameters

  • y: number

  Returns Vector3

  this instance, for method chaining

setZ

• setZ(z: number): Vector3

  Sets z component (mutate this)

  Parameters

  • z: number

  Returns Vector3

  this instance, for method chaining

clone

• clone(): Vector3

  Creates new instance has same elements (pure)

  Returns Vector3

  new cloned vector instance

  Example

  const v = new Vector3(4, 5, 6);
  const c = v.clone();
  console.log(c); // (4, 5, 6)
  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 = Vector3.zero();
  const ones = Vector3.one();
  console.log(zero.isZero()); // true
  console.log(ones.isZero()); // false
  Copy

set

• set(x: number, y: number, z: number): Vector3

  Sets all elements (mutates this)

  Parameters

  • x: number
  • y: number
  • z: number

  Returns Vector3

  this instance, for method chaining

  Example

  const v = new Vector3(4, 5, 6);
  v.set(7, 8, 9);
  console.log(v); // (7, 8, 9)
  Copy

copy

• copy(other: Vector3): Vector3

  Copies all elements from other vector (mutates this)

  Parameters

  • other: Vector3

  Returns Vector3

  this instance, for method chaining

  Example

  const v1 = new Vector3(4, 5, 6);
  const v2 = new Vector3(7, 8, 9);
  v1.copy(v2);
  console.log(v1); // (7, 8, 9)
  console.log(v2); // (7, 8, 9)
  Copy

add

• add(other: Vector3): Vector3

  Adds by other vector (mutates this)

  Parameters

  • other: Vector3

    other vector

  Returns Vector3

  this instance, for method chaining

  Example

  const v1 = new Vector3(4, 5, 6);
  const v2 = new Vector3(7, 8, 9);
  v1.add(v2);
  console.log(v1); // (11, 13, 15)
  console.log(v2); // (7, 8, 9)
  Copy

subtract

• subtract(other: Vector3): Vector3

  Subtracts by other vector (mutates this)

  Parameters

  • other: Vector3

    other vector

  Returns Vector3

  this instance, for method chaining

  Example

  const v1 = new Vector3(4, 5, 6);
  const v2 = new Vector3(7, 8, 9);
  v1.subtract(v2);
  console.log(v1); // (-3, -3, -3)
  console.log(v2); // (7, 8, 9)
  Copy

multiplyScalar

• multiplyScalar(scalar: number): Vector3

  Multiplies all elements by scalar (mutates this)

  Parameters

  • scalar: number

  Returns Vector3

  this instance, for method chaining

  Example

  const v = new Vector3(4, 5, 6);
  v.multiplyScalar(2);
  console.log(v); // (8, 10, 12)
  Copy

divideScalar

• divideScalar(scalar: number): Vector3

  Divides all elements by scalar (mutates this)

  Parameters

  • scalar: number

  Returns Vector3

  this instance, for method chaining

  Example

  const v = new Vector3(4, 5, 6);
  v.divideScalar(2);
  console.log(v); // (2, 2.5, 3)
  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 Vector3(2, 3, 6);
  console.log(v.length()); // 7
  Copy

normalize

• normalize(): Vector3

  Normalizes this vector to length 1 (mutates this)

  Returns Vector3

  this instance, for method chaining

  Example

  const v = new Vector3(2, 3, 6);
  v.normalize();
  console.log(v); // (2/7, 3/7, 6/7)
  Copy

cross

• cross(other: Vector3): Vector3

  Calculates the cross product of this and other (mutates this)

  Parameters

  • other: Vector3

    other vector

  Returns Vector3

  this instance, for method chaining

  Example

  const v1 = new Vector3(1, 0, 0);
  const v2 = Vector3.zero();
  v1.cross(v2);
  console.log(v1); // (0, 0, 1);
  
  const v3 = new Vector3(1, 0, 0);
  const v4 = Vector3.zero();
  const out = Vector3.zero();
  v3.cross(v4, out);
  console.log(v3); // (1, 0, 0)
  console.log(out); // (0, 0, 1)
  Copy

crossTo

• crossTo(other: Vector3, out: Vector3): Vector3

  Calculates the cross product of this and other (mutates out)

  Parameters

  • other: Vector3

    other vector

  • out: Vector3

    vector instance to receive cross

  Returns Vector3

applyMatrix3

• applyMatrix3(matrix: Matrix3): Vector3

  Applies matrix to this vector (mutates this)

  Parameters

  • matrix: Matrix3

  Returns Vector3

  this instance, for method chaining

applyMatrix4

• applyMatrix4(matrix: Matrix4, options?: ApplyMatrix4Options): Vector3

  Applies matrix to this vector (mutates this)

  Parameters

  • matrix: Matrix4
  • Optionaloptions: ApplyMatrix4Options

  Returns Vector3

  this instance, for method chaining

applyQuaternion

• applyQuaternion(quaternion: Quaternion): Vector3

  Applies quaternion to this vector (mutates this)

  Parameters

  • quaternion: Quaternion

  Returns Vector3

  this instance, for method chaining