Class Vector2

Represents a 2D vector with x and y components. Provides various vector operations for 2D mathematics and transformations.

Index

Constructors

Properties

x y

Methods

add angleTo clone copy cross distanceTo distanceToSquared divide divideScalar dot equal length lengthSquared multiply multiplyScalar normal rotate set setX setY subtract toArray unit

Constructors

constructor

new Vector2(x?: number, y?: number): Vector2
Creates a new Vector2 instance
Parameters
- x: number = 0
  The x component of the vector. Defaults to 0
- y: number = 0
  The y component of the vector. Defaults to 0
Returns Vector2
- Defined in src/Vector2.ts:24

Properties

x

x: number

The x component of the vector

y

y: number

The y component of the vector

Methods

add

add(vector: Vector2): this
Adds another vector to this vector
Parameters
- vector: Vector2
  The vector to add
Returns this
Returns this vector for method chaining
- Defined in src/Vector2.ts:123

angleTo

angleTo(vector: Vector2): number
Returns the angle between two vectors
Parameters
- vector: Vector2
  The vector to measure angle against
Returns number
The angle between the vectors in radians
- Defined in src/Vector2.ts:167

clone

clone(): Vector2
Creates a new vector with the same values as this vector

Returns Vector2
A new Vector2 instance with copied values
- Defined in src/Vector2.ts:259

copy

copy(source: Vector2): this
Copies values from another vector into this vector
Parameters
- source: Vector2
  The vector to copy from
Returns this
Returns this vector for method chaining
- Defined in src/Vector2.ts:235

cross

cross(vector: Vector2): number
Computes the cross product of this vector with another vector
Parameters
- vector: Vector2
  The other vector for the cross product
Returns number
The cross product result (scalar in 2D)
- Defined in src/Vector2.ts:217

distanceTo

distanceTo(vector: Vector2): number
Computes the distance between this vector and another vector
Parameters
- vector: Vector2
  The other vector to measure distance to
Returns number
The distance between the vectors
- Defined in src/Vector2.ts:82

distanceToSquared

distanceToSquared(vector: Vector2): number
Computes the squared distance between this vector and another vector (avoids sqrt for performance)
Parameters
- vector: Vector2
  The other vector to measure distance to
Returns number
The squared distance between the vectors
- Defined in src/Vector2.ts:92

divide

divide(vector: Vector2): this
Divides this vector component-wise by another vector
Parameters
- vector: Vector2
  The vector to divide by
Returns this
Returns this vector for method chaining
- Defined in src/Vector2.ts:156

divideScalar

divideScalar(num: number): this
Divides this vector by a scalar
Parameters
- num: number
  The scalar value to divide by
Returns this
Returns this vector for method chaining
- Defined in src/Vector2.ts:112

dot

dot(vector: Vector2): number
Computes the dot product of this vector with another vector
Parameters
- vector: Vector2
  The other vector for the dot product
Returns number
The dot product result
- Defined in src/Vector2.ts:208

equal

equal(vector: Vector2): boolean
Compares this vector with another vector for equality
Parameters
- vector: Vector2
  The vector to compare with
Returns boolean
True if vectors are equal, false otherwise
- Defined in src/Vector2.ts:226

length

length(): number
Computes the length (magnitude) of this vector

Returns number
The length of the vector
- Defined in src/Vector2.ts:65

lengthSquared

lengthSquared(): number
Computes the squared length of this vector (avoids sqrt for performance)

Returns number
The squared length of the vector
- Defined in src/Vector2.ts:73

multiply

multiply(vector: Vector2): this
Multiplies this vector component-wise by another vector
Parameters
- vector: Vector2
  The vector to multiply by
Returns this
Returns this vector for method chaining
- Defined in src/Vector2.ts:145

multiplyScalar

multiplyScalar(num: number): this
Multiplies this vector by a scalar
Parameters
- num: number
  The scalar value to multiply by
Returns this
Returns this vector for method chaining
- Defined in src/Vector2.ts:101

normal

normal(): this
Converts to normal vector (y, -x)

Returns this
This vector as a normal vector for method chaining
- Defined in src/Vector2.ts:185

rotate

rotate(angle: number): this
Rotates the vector by a given angle
Parameters
- angle: number
  The rotation angle in radians
Returns this
Returns this vector for method chaining
- Defined in src/Vector2.ts:244

set

set(x: number, y: number): this
Sets the components of this vector
Parameters
- x: number
  The new x component
- y: number
  The new y component
Returns this
Returns this vector for method chaining
- Defined in src/Vector2.ts:35

setX

setX(x: number): this
Sets the x component of this vector
Parameters
- x: number
  The new x component
Returns this
Returns this vector for method chaining
- Defined in src/Vector2.ts:46

setY

setY(y: number): this
Sets the y component of this vector
Parameters
- y: number
  The new y component
Returns this
Returns this vector for method chaining
- Defined in src/Vector2.ts:56

subtract

subtract(vector: Vector2): this
Subtracts another vector from this vector
Parameters
- vector: Vector2
  The vector to subtract
Returns this
Returns this vector for method chaining
- Defined in src/Vector2.ts:134

toArray

toArray(): [number, number]
Converts this vector to an array of its components

Returns [number, number]
An array containing the vector's components [x, y]
- Defined in src/Vector2.ts:267

unit

unit(): this
Normalizes this vector to unit length (length = 1)

Returns this
Returns this vector for method chaining
- Defined in src/Vector2.ts:196