Class Vector2

A point or direction in 2D, such as a UV coordinate, a screen position or stick input

Math methods change the vector they're called on and return it, so calls chain. Pass an out point as the last argument to write the result there instead and leave this one as it is; Vector3 explains why to reuse out points in code that runs every frame. Where a method takes a point, any pixi.js PointData works, such as a pixi Point or a plain { x, y } object.

Example

const input = new Vector2(stick.x, stick.y);

if (input.magnitudeSquared() > 1) input.normalize();
player.position.x += input.x * speed * dt;
player.position.z += input.y * speed * dt;

Implements

PointLike

Index

Constructors

constructor

new Vector2(x?: number, y?: number): Vector2
Creates a new Vector2
Parameters
- x: number = 0
  The x component
- y: number = 0
  The y component
Returns Vector2

Properties

x

x: number = 0

The x component

Example

cursor.x = event.global.x;

y

y: number = 0

The y component

Example

cursor.y = event.global.y;

Accessors

`Static`shared

get shared(): Vector2
A static Vector2 reset to (0, 0) on every access, for a result used straight away

Important
This vector is shared and temporary. Do not store references to it.

Returns Vector2
Example
```
const dragged = Vector2.shared.copyFrom(event.global).distanceTo(dragStart) > dragThreshold;
```

Methods

add

add(v: PointData, out?: PointLike): this
Adds v to this vector
Parameters
- v: PointData
  The point to add
- out: PointLike = ...
  The target to write the result into, defaults to this vector
Returns this
The vector the result was written into
Example
```
scroll.add(scrollStep);
anchor.add(labelOffset, labelPosition);
```

addScaledVector

addScaledVector(v: PointData, s: number, out?: PointLike): this
Adds v * s to this vector, such as a speed times the frame time
Parameters
- v: PointData
  The point to scale and add
- s: number
  The scalar to multiply v by
- out: PointLike = ...
  The target to write the result into, defaults to this vector
Returns this
The vector the result was written into
Example
```
uvOffset.addScaledVector(scrollSpeed, dt);
```

angle

angle(): number
Computes the angle from the +x axis to this vector, turning toward +y

Returns number
The angle in radians, from -π to π
Example
```
cursor.subtract(arrow.position, toCursor);
arrow.rotation = toCursor.angle();
```

applyMatrix3

applyMatrix3(m: Matrix3, out?: PointLike): this
Transforms this point by m as a 2D transform: rotation, scale and translation

The matrix's bottom row is not used, so there is no divide.
Parameters
- m: Matrix3
  The matrix to apply
- out: PointLike = ...
  The target to write the result into, defaults to this vector
Returns this
The vector the result was written into
Example
```
const uvTransform = new Matrix3().setUvTransform(0.25, 0, 2, 2, 0, 0.5, 0.5);

uv.applyMatrix3(uvTransform);
```

clamp

clamp(min: PointData, max: PointData, out?: PointLike): this
Clamps each component of this vector between the matching components of min and max

Assumes min <= max componentwise.
Parameters
- min: PointData
  The lower bound per component
- max: PointData
  The upper bound per component
- out: PointLike = ...
  The target to write the result into, defaults to this vector
Returns this
The vector the result was written into
Example
```
cursor.clamp(minimapMin, minimapMax, minimapMarker);
```

clone

clone(): Vector2
Creates a copy of this vector

Returns Vector2
Example
```
const dragStart = cursor.clone();
```

copyFrom

copyFrom(p: PointData): this
Copies x, y from the given point into this vector
Parameters
- p: PointData
  The point to copy from
Returns this
Example
```
dragStart.copyFrom(event.global);
```
Implementation of PointLike.copyFrom

copyTo

copyTo<T extends PointLike>(p: T): T
Copies this vector's x, y into the given point
Type Parameters
- T extends PointLike
Parameters
- p: T
  The point to copy into
Returns T
The given point with values updated
Example
```
cursor.copyTo(crosshair.position);
```
Implementation of PointLike.copyTo

cross

cross(v: PointData): number
Computes x * v.y - y * v.x, the z of the 3D cross product with both vectors at z = 0

The sign says which way to turn from this vector to v: positive is the way +x turns toward +y (counter-clockwise when y points up, clockwise on a pixi screen, where y points down), negative the other way, and zero when they are parallel.
Parameters
- v: PointData
  The other vector
Returns number
Example
```
const turnDirection = Math.sign(heading.cross(toTarget));
```

distanceTo

distanceTo(v: PointData): number
Computes the distance from this point to v
Parameters
- v: PointData
  The point to measure to
Returns number
Example
```
if (cursor.distanceTo(dragStart) > dragThreshold) startDrag();
```

distanceToSquared

distanceToSquared(v: PointData): number
Computes the squared distance from this point to v

Cheaper than Vector2#distanceTo and enough to compare distances.
Parameters
- v: PointData
  The point to measure to
Returns number
Example
```
const hovered = cursor.distanceToSquared(button.center) < button.radius * button.radius;
```

divide

divide(v: PointData, out?: PointLike): this
Divides each component of this vector by the matching component of v
Parameters
- v: PointData
  The point to divide by
- out: PointLike = ...
  The target to write the result into, defaults to this vector
Returns this
The vector the result was written into
Example
```
pixel.divide({ x: texture.width, y: texture.height }, uv);
```

divideScalar

divideScalar(s: number, out?: PointLike): this
Divides each component of this vector by the scalar s
Parameters
- s: number
  The scalar to divide by
- out: PointLike = ...
  The target to write the result into, defaults to this vector
Returns this
The vector the result was written into
Example
```
thumbOffset.divideScalar(stickRadius, stick);
```

dot

dot(v: PointData): number
Computes the dot product of this vector and v

For unit vectors it's the cosine of the angle between them: 1 when they point the same way, 0 at right angles and -1 when opposite.
Parameters
- v: PointData
  The other vector
Returns number
Example
```
const targetIsAhead = heading.dot(toTarget) > 0;
```

equals

equals(p: PointData): boolean
Checks whether x and y both match p exactly, with no tolerance
Parameters
- p: PointData
  The point to compare against
Returns boolean
Example
```
if (!cursor.equals(lastCursor)) updateHover(cursor);
```
Implementation of PointLike.equals

fromArray

fromArray(
array: Float32Array<ArrayBufferLike> | number[],
offset?: number,
): this
Reads x, y from array starting at offset
Parameters
- array: Float32Array<ArrayBufferLike> | number[]
  The array to read from
- offset: number = 0
  The index of the first component
Returns this
Example
```
uv.fromArray(uvs, vertexIndex * 2);
```

magnitude

magnitude(): number
Computes the length of this vector

Returns number
Example
```
const stickTilt = stick.magnitude();
```

magnitudeSquared

magnitudeSquared(): number
Computes the squared length of this vector

Cheaper than Vector2#magnitude, since it skips the square root, and enough to compare lengths.

Returns number
Example
```
if (stick.magnitudeSquared() < deadZone * deadZone) stick.set(0);
```

max

max(v: PointData, out?: PointLike): this
Sets each component to the larger of this vector's and v's
Parameters
- v: PointData
  The point to compare with
- out: PointLike = ...
  The target to write the result into, defaults to this vector
Returns this
The vector the result was written into
Example
```
selectionMax.max(cursor);
```

min

min(v: PointData, out?: PointLike): this
Sets each component to the smaller of this vector's and v's
Parameters
- v: PointData
  The point to compare with
- out: PointLike = ...
  The target to write the result into, defaults to this vector
Returns this
The vector the result was written into
Example
```
selectionMin.min(cursor);
```

multiply

multiply(v: PointData, out?: PointLike): this
Multiplies each component of this vector by the matching component of v
Parameters
- v: PointData
  The point to multiply by
- out: PointLike = ...
  The target to write the result into, defaults to this vector
Returns this
The vector the result was written into
Example
```
uv.multiply(tiling);
```

multiplyScalar

multiplyScalar(s: number, out?: PointLike): this
Multiplies each component of this vector by the scalar s
Parameters
- s: number
  The scalar to multiply by
- out: PointLike = ...
  The target to write the result into, defaults to this vector
Returns this
The vector the result was written into
Example
```
input.multiplyScalar(speed * dt, step);
```

negate

negate(out?: PointLike): this
Negates each component of this vector, reversing its direction
Parameters
- out: PointLike = ...
  The target to write the result into, defaults to this vector
Returns this
The vector the result was written into
Example
```
hitDirection.negate(knockback);
```

normalize

normalize(out?: PointLike): this
Scales this vector to unit length, keeping its direction

A zero vector stays zero.
Parameters
- out: PointLike = ...
  The target to write the result into, defaults to this vector
Returns this
The vector the result was written into
Example
```
input.normalize();
```

rotate

rotate(angle: number, out?: PointLike): this
Rotates this vector around the origin by angle radians, turning +x toward +y
Parameters
- angle: number
  The rotation angle in radians
- out: PointLike = ...
  The target to write the result into, defaults to this vector
Returns this
The vector the result was written into
Example
```
stick.rotate(-cameraYaw, moveDirection);
```

rotateAround

rotateAround(center: PointData, angle: number, out?: PointLike): this
Rotates this point around center by angle radians, turning +x toward +y
Parameters
- center: PointData
  The point to rotate around
- angle: number
  The rotation angle in radians
- out: PointLike = ...
  The target to write the result into, defaults to this vector
Returns this
The vector the result was written into
Example
```
moon.rotateAround(planet, orbitSpeed * dt);
```

set

set(x?: number, y?: number): this
Sets the x and y components
Parameters
- x: number = 0
  The x component
- y: number = x
  The y component, defaults to x
Returns this
Example
```
uvOffset.set(0.5, 0);
tiling.set(4); // (4, 4)
```
Implementation of PointLike.set

setLength

setLength(length: number, out?: PointLike): this
Scales this vector so its length equals length, keeping its direction

A zero vector stays zero.
Parameters
- length: number
  The target length
- out: PointLike = ...
  The target to write the result into, defaults to this vector
Returns this
The vector the result was written into
Example
```
dashDirection.setLength(dashDistance, dashOffset);
```

subtract

subtract(v: PointData, out?: PointLike): this
Subtracts v from this vector
Parameters
- v: PointData
  The point to subtract
- out: PointLike = ...
  The target to write the result into, defaults to this vector
Returns this
The vector the result was written into
Example
```
cursor.subtract(dragStart, dragDelta);
```

toArray

toArray<T extends Float32Array<ArrayBufferLike> | number[] = number[]>(
array?: T,
offset?: number,
): T
Writes this vector's values into array starting at offset

Allocates a new array when one is not supplied.
Type Parameters
- T extends Float32Array<ArrayBufferLike> | number[] = number[]
Parameters
- array: T = ...
  The array to write into
- offset: number = 0
  The index to write the first component at
Returns T
The array the values were written into
Example
```
uv.toArray(uvs, vertexIndex * 2);
```

toString

toString(): string
Returns a readable string representation of this vector

Returns string
Example
```
console.log(cursor.toString());
```

Class Vector2

Example

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns Vector2

Properties

x

Example

y

Example

Accessors

Staticshared

Returns Vector2

Example

Methods

add

Parameters

Returns this

Example

addScaledVector

Parameters

Returns this

Example

angle

Returns number

Example

applyMatrix3

Parameters

Returns this

Example

clamp

Parameters

Returns this

Example

clone

Returns Vector2

Example

copyFrom

Parameters

Returns this

Example

copyTo

Type Parameters

Parameters

Returns T

Example

cross

Parameters

Returns number

Example

distanceTo

Parameters

Returns number

Example

distanceToSquared

Parameters

Returns number

Example

divide

Parameters

Returns this

Example

divideScalar

Parameters

Returns this

Example

dot

Parameters

Returns number

Example

equals

Parameters

Returns boolean

`Static`shared