Vector2<T>

constructor

• new Vector2<
      T extends
          | "i8"
          | "u8"
          | "i16"
          | "u16"
          | "i32"
          | "u32"
          | "i64"
          | "u64"
          | "f32"
          | "f64",
  >(
      scalarType: T,
      ...args:
          | Vector2Arguments<T>
          | (T extends FloatScalar ? PolarArguments : never),
  ): Vector2<T>

  Create a 2D vector of the specified scalar type; omitted components are zero. A source vector can also be converted and copied.

  Type Parameters

  • T extends "i8" | "u8" | "i16" | "u16" | "i32" | "u32" | "i64" | "u64" | "f32" | "f64"

  Parameters

  scalarType

  T

  Component storage type; i64/u64 use bigint, others use number.

  ...args

  Vector2Arguments<T> | (T extends FloatScalar ? PolarArguments : never)

  x and y components or a source vector; floating-point types also support polar coordinates with a radius and an Angle.

  Returns

  Vector2<T>

  Source & inheritance
• new Vector2<
      T extends
          | "i8"
          | "u8"
          | "i16"
          | "u16"
          | "i32"
          | "u32"
          | "i64"
          | "u64"
          | "f32"
          | "f64",
  >(
      source: ReadonlyValue<Vector2<T>>,
  ): Vector2<T>

  Copy the vector and its scalar type with independent storage.

  Type Parameters

  • T extends "i8" | "u8" | "i16" | "u16" | "i32" | "u32" | "i64" | "u64" | "f32" | "f64"

  Parameters

  source

  ReadonlyValue<Vector2<T>>

  Returns

  Vector2<T>

  Source & inheritance

scalarType

• get scalarType(): T

  The scalar storage type used by the components.

  Returns

  T

  Source & inheritance

x

• get x(): Scalar<T>

  The X component; writes follow the TypedArray conversion rules for scalarType.

  Returns

  Scalar<T>

  Source & inheritance
• set x(value: Scalar<T>): void

  Set the X component.

  Parameters

  value

  Scalar<T>

  Returns

  void

  Source & inheritance

y

• get y(): Scalar<T>

  The Y component; writes follow the TypedArray conversion rules for scalarType.

  Returns

  Scalar<T>

  Source & inheritance
• set y(value: Scalar<T>): void

  Set the Y component.

  Parameters

  value

  Scalar<T>

  Returns

  void

  Source & inheritance

angle

• angle(this: ReadonlyValue<Vector2<FloatScalar>>): Angle

  Return the angle relative to the positive X axis; only for nonzero floating-point vectors.

  Parameters

  this

  ReadonlyValue<Vector2<FloatScalar>>

  Returns

  Angle

  Source & inheritance

angleTo

• angleTo(
      this: ReadonlyValue<Vector2<T & FloatScalar>>,
      rhs: ReadonlyValue<Vector2<T>>,
  ): Angle

  Return the signed angle from this vector to rhs; both must be nonzero floating-point vectors of the same type.

  Parameters

  this

  ReadonlyValue<Vector2<T & FloatScalar>>

  rhs

  ReadonlyValue<Vector2<T>>

  Returns

  Angle

  Source & inheritance

componentWiseDiv

• componentWiseDiv(rhs: ReadonlyValue<Vector2<T>>): Vector2<T>

  Return a new vector divided component-wise by rhs of the same type; throw RangeError if any divisor is zero.

  Parameters

  rhs

  ReadonlyValue<Vector2<T>>

  Returns

  Vector2<T>

  Source & inheritance

componentWiseMul

• componentWiseMul(rhs: ReadonlyValue<Vector2<T>>): Vector2<T>

  Return a new vector multiplied component-wise by rhs of the same type.

  Parameters

  rhs

  ReadonlyValue<Vector2<T>>

  Returns

  Vector2<T>

  Source & inheritance

cross

• cross(rhs: ReadonlyValue<Vector2<T>>): Scalar<T>

  Return the 2D cross-product scalar x·rhs.y−y·rhs.x; rhs must have the same scalar type.

  Parameters

  rhs

  ReadonlyValue<Vector2<T>>

  Returns

  Scalar<T>

  Source & inheritance

dot

• dot(rhs: ReadonlyValue<Vector2<T>>): Scalar<T>

  Return the dot product x·rhs.x+y·rhs.y with rhs of the same type.

  Parameters

  rhs

  ReadonlyValue<Vector2<T>>

  Returns

  Scalar<T>

  Source & inheritance

length

• length(this: ReadonlyValue<Vector2<FloatScalar>>): number

  Return the Euclidean length; only available for floating-point vectors.

  Parameters

  this

  ReadonlyValue<Vector2<FloatScalar>>

  Returns

  number

  Source & inheritance

lengthSquared

• lengthSquared(): Scalar<T>

  Return x²+y², calculated with the current scalar type's precision and range.

  Returns

  Scalar<T>

  Source & inheritance

normalized

• normalized(this: ReadonlyValue<Vector2<T & FloatScalar>>): Vector2<T>

  Return a unit vector in the same direction; only for floating-point vectors. A zero vector throws RangeError.

  Parameters

  this

  ReadonlyValue<Vector2<T & FloatScalar>>

  Returns

  Vector2<T>

  Source & inheritance

perpendicular

• perpendicular(): Vector2<T>

  Return the perpendicular vector (-y, x) with the same scalar type.

  Returns

  Vector2<T>

  Source & inheritance

projectedOnto

• projectedOnto(
      this: ReadonlyValue<Vector2<T & FloatScalar>>,
      axis: ReadonlyValue<Vector2<T>>,
  ): Vector2<T>

  Return the projection onto axis; axis must be a nonzero floating-point vector of the same type.

  Parameters

  this

  ReadonlyValue<Vector2<T & FloatScalar>>

  axis

  ReadonlyValue<Vector2<T>>

  Returns

  Vector2<T>

  Source & inheritance

rotatedBy

• rotatedBy(
      this: ReadonlyValue<Vector2<T & FloatScalar>>,
      phi: ReadonlyValue<Angle>,
  ): Vector2<T>

  Return a new floating-point vector rotated by phi; positive angles are clockwise in screen coordinates.

  Parameters

  this

  ReadonlyValue<Vector2<T & FloatScalar>>

  phi

  ReadonlyValue<Angle>

  Returns

  Vector2<T>

  Source & inheritance

Readonly[mutableValue]

[vector2Native]

• get "[vector2Native]"(): NativeValueHandle<"vector2">

  Returns

  NativeValueHandle<"vector2">

  Source & inheritance

[vector2Storage]

• get "[vector2Storage]"(): ScalarArray<T>

  Returns

  ScalarArray<T>

  Source & inheritance