Class Vec2

Two-dimensional vector (point).

Methods (like Vec2.multiply, Vec2.add) generally mutate the instance. Create new instances with Vec2.clone.

Implements

ReadonlyVec2

Constructors

constructor

new Vec2(x?: number, y?: number): Vec2
Parameters
- x: number = 0
- y: number = 0
Returns Vec2
- Defined in math/vec2.ts:212

Properties

x

x: number = 0

X component.

y

y: number = 0

Y component.

Accessors

degrees

get degrees(): number
Degrees relativ to X axis.

Returns number
Implementation of ReadonlyVec2.degrees
- Defined in math/vec2.ts:195

length

get length(): number
Length.

Returns number
Implementation of ReadonlyVec2.length
- Defined in math/vec2.ts:175

lengthSquared

get lengthSquared(): number
Squared length.

Returns number
Implementation of ReadonlyVec2.lengthSquared
- Defined in math/vec2.ts:179

max

get max(): number
Get greater of x or y.

Returns number
Implementation of ReadonlyVec2.max
- Defined in math/vec2.ts:208

min

get min(): number
Get lesser of x or y.

Returns number
Implementation of ReadonlyVec2.min
- Defined in math/vec2.ts:204

radians

get radians(): number
Radians relativ to X axis.

Returns number
Implementation of ReadonlyVec2.radians
- Defined in math/vec2.ts:183

xy

set xy(xy: number): void
Set both x and y.
Parameters
- xy: number
Returns void
- Defined in math/vec2.ts:200

Methods

add

add(x: number, y?: number): this
Add components.
Parameters
- x: number
- Optionaly: number
Returns this
Self
- Defined in math/vec2.ts:236

addVec

addVec(vec: Vec2Like): this
Add a vector.
Parameters
- vec: Vec2Like
Returns this
Self
- Defined in math/vec2.ts:248

asReadonly

asReadonly(): ReadonlyVec2
Get a read-only version of this vector. Does not clone.

Returns ReadonlyVec2
Read-only vector
- Defined in math/vec2.ts:763

ceil

ceil(): this
Ceil all components.

Returns this
Self
- Defined in math/vec2.ts:621

clamp

clamp(min?: number, max?: number): this
Clamp all components.
Parameters
- min: number = 0
  Min
- max: number = 1
  Max
Returns this
Self
- Defined in math/vec2.ts:645

clampSeparate

clampSeparate(minX?: number, minY?: number, maxX?: number, maxY?: number): this
Clamp x and y separately.
Parameters
- minX: number = 0
  Min X
- minY: number = 0
  Min Y
- maxX: number = 0
  Max X
- maxY: number = 0
  Max Y
Returns this
Self
- Defined in math/vec2.ts:660

clone

clone(): Vec2
Create a new instance with equal components.

Returns Vec2
New instance
Implementation of ReadonlyVec2.clone
- Defined in math/vec2.ts:679

componentsEqual

componentsEqual(epsilon?: number): boolean
Parameters
- epsilon: number = Number.EPSILON
Returns boolean
- Defined in math/vec2.ts:675

copyAnchorPointFrom

copyAnchorPointFrom(rect: RectLike, anchor: Vec2Like): this
Apply anchor relative to rects dimensions to this vec.
Parameters
- rect: RectLike
  Rect
- anchor: Vec2Like
  Anchor
Returns this
Self
Example
```
const r = new Rect(10, 10, 20, 20);

// v.x === 30, v.y === 20
const v = new Vec2().copyAnchorPointFrom(r, { x: 1, y: 0.5 });
```
- Defined in math/vec2.ts:749

copyCenterFrom

copyCenterFrom(rect: RectLike): this
Copy center coordinates from rect.
Parameters
- rect: RectLike
  Rect
Returns this
Self
- Defined in math/vec2.ts:725

copyFrom

copyFrom(other: Vec2Like): this
Copy components from other.
Parameters
- other: Vec2Like
Returns this
Self
- Defined in math/vec2.ts:688

copyTo

copyTo(array: TypedArray, offset?: number): void
Copy components into a typed array.
Parameters
- array: TypedArray
  Typed array
- offset: number = 0
  Element offset
Returns void
- Defined in math/vec2.ts:700

copyTopRightFrom

copyTopRightFrom(rect: RectLike): this
Copy top right coordinates from rect.
Parameters
- rect: RectLike
  Rect
Returns this
Self
- Defined in math/vec2.ts:710

cross

cross(x: number, y?: number): number
Cross product.
Parameters
- x: number
- Optionaly: number
Returns number
Cross product
Implementation of ReadonlyVec2.cross
- Defined in math/vec2.ts:426

crossVec

crossVec(vec: Vec2Like): number
Cross product.
Parameters
- vec: Vec2Like
Returns number
Cross product
Implementation of ReadonlyVec2.crossVec
- Defined in math/vec2.ts:430

degreesBetween

degreesBetween(x: number, y?: number): number
Get angle between this and (x, y) from origin.
Parameters
- x: number
- Optionaly: number
Returns number
Angle in degrees
Implementation of ReadonlyVec2.degreesBetween
- Defined in math/vec2.ts:462

degreesBetweenVec

degreesBetweenVec(vec: Vec2Like): number
Get angle between this and vec from origin.
Parameters
- vec: Vec2Like
Returns number
Angle in radians
Implementation of ReadonlyVec2.degreesBetweenVec
- Defined in math/vec2.ts:466

degreesTo

degreesTo(x: number, y?: number): number
Get angle of the vector between this and (x, y).
Parameters
- x: number
- Optionaly: number
Returns number
Angle in degrees
Implementation of ReadonlyVec2.degreesTo
- Defined in math/vec2.ts:444

degreesToVec

degreesToVec(vec: Vec2Like): number
Get angle of the vector between this and vec.
Parameters
- vec: Vec2Like
Returns number
Angle in degrees
Implementation of ReadonlyVec2.degreesToVec
- Defined in math/vec2.ts:448

divide

divide(x: number, y?: number): this
Divide by components.
Parameters
- x: number
- Optionaly: number
Returns this
- Defined in math/vec2.ts:374

divideFrom

divideFrom(x: number, y?: number): this
Make this vector the result of (x, y) / this vector.
Parameters
- x: number
- Optionaly: number
Returns this
Self
- Defined in math/vec2.ts:387

divideFromVec

divideFromVec(vec: Vec2Like): this
Make this vector the result of vec / this vector.
Parameters
- vec: Vec2Like
Returns this
Self
- Defined in math/vec2.ts:411

divideVec

divideVec(vec: Vec2Like): this
Divide by a vec.
Parameters
- vec: Vec2Like
Returns this
Self
- Defined in math/vec2.ts:399

dot

dot(x: number, y?: number): number
Dot product.
Parameters
- x: number
- Optionaly: number
Returns number
Dot product.
Implementation of ReadonlyVec2.dot
- Defined in math/vec2.ts:418

dotVec

dotVec(vec: Vec2Like): number
Dot product.
Parameters
- vec: Vec2Like
Returns number
Dot product
Implementation of ReadonlyVec2.dotVec
- Defined in math/vec2.ts:422

equals

equals(x: number, y: number, epsilon?: number): boolean
Check equality of components.
Parameters
- x: number
- y: number
- epsilon: number = Number.EPSILON
  Tolerance
Returns boolean
true if equal within tolerance
Implementation of ReadonlyVec2.equals
- Defined in math/vec2.ts:667

equalsVec

equalsVec(other: Vec2Like, epsilon?: number): boolean
Check equality of vectors.
Parameters
- other: Vec2Like
- Optionalepsilon: number
  Tolerance
Returns boolean
true if equal within tolerance
Implementation of ReadonlyVec2.equalsVec
- Defined in math/vec2.ts:671

floor

floor(): this
Floor all components.

Returns this
Self
- Defined in math/vec2.ts:610

makeAbsolute

makeAbsolute(): this
Make all components absolute.

Returns this
Self
- Defined in math/vec2.ts:586

makeDirTo

makeDirTo(x: number, y?: number): this
Make this vector the direction vector between this and (x, y).
Parameters
- x: number
- Optionaly: number
Returns this
Self
- Defined in math/vec2.ts:540

makeDirToVec

makeDirToVec(vec: Vec2Like): this
Make this vector the direction vector between this and vec.
Parameters
- vec: Vec2Like
Returns this
Self
- Defined in math/vec2.ts:549

multiply

multiply(x: number, y?: number): this
Multiply components.
Parameters
- x: number
- Optionaly: number
Returns this
Self
- Defined in math/vec2.ts:311

multiplyMat

multiplyMat(mat: Mat2DLike): this
Multiply with matrix.
Parameters
- mat: Mat2DLike
Returns this
Self
- Defined in math/vec2.ts:335

multiplyMatInverse

multiplyMatInverse(mat: Mat2DLike): this
Inverse multiply with matrix.
Parameters
- mat: Mat2DLike
Returns this
Self
- Defined in math/vec2.ts:350

multiplyVec

multiplyVec(vec: Vec2Like): this
Multiply with a vec.
Parameters
- vec: Vec2Like
Returns this
Self
- Defined in math/vec2.ts:323

normalize

normalize(): this
Normalize.

Returns this
Self
- Defined in math/vec2.ts:597

projectOn

projectOn(x: number, y?: number): this
Project this vector onto the vector defined by x and y.
Parameters
- x: number
  X
- Optionaly: number
  Y
Returns this
Self
- Defined in math/vec2.ts:559

projectOnVec

projectOnVec(vec: Vec2Like): this
Project this vector onto vec.
Parameters
- vec: Vec2Like
  Vector
Returns this
Self
- Defined in math/vec2.ts:578

radiansBetween

radiansBetween(x: number, y?: number): number
Get angle between this and (x, y) from origin.
Parameters
- x: number
- Optionaly: number
Returns number
Angle in radians
Implementation of ReadonlyVec2.radiansBetween
- Defined in math/vec2.ts:452

radiansBetweenVec

radiansBetweenVec(vec: Vec2Like): number
Get angle between this and vec from origin.
Parameters
- vec: Vec2Like
Returns number
Angle in radians
Implementation of ReadonlyVec2.radiansBetweenVec
- Defined in math/vec2.ts:458

radiansTo

radiansTo(x: number, y?: number): number
Get angle of the vector between this and (x, y).
Parameters
- x: number
- Optionaly: number
Returns number
Angle in radians
Implementation of ReadonlyVec2.radiansTo
- Defined in math/vec2.ts:434

radiansToVec

radiansToVec(vec: Vec2Like): number
Get angle of the vector between this and vec.
Parameters
- vec: Vec2Like
Returns number
Angle in radians
Implementation of ReadonlyVec2.radiansToVec
- Defined in math/vec2.ts:440

rotateDegrees

rotateDegrees(degrees: number, cx?: number, cy?: number): this
Rotate this vector around a point.
Parameters
- degrees: number
  Amount to rotate in degrees
- Optionalcx: number
  Center x
- Optionalcy: number
  Center y
Returns this
Self
- Defined in math/vec2.ts:509

rotateDegreesVec

rotateDegreesVec(degrees: number, center: Vec2Like): this
Rotate this vector around a point.
Parameters
- degrees: number
  Amount to rotate in radians
- center: Vec2Like
  Center
Returns this
Self
- Defined in math/vec2.ts:530

rotateRadians

rotateRadians(radians: number, cx?: number, cy?: number): this
Rotate this vector around a point.
Parameters
- radians: number
  Amount to rotate in radians
- Optionalcx: number
  Center x
- Optionalcy: number
  Center y
Returns this
Self
- Defined in math/vec2.ts:477

rotateRadiansVec

rotateRadiansVec(radians: number, center: Vec2Like): this
Rotate this vector around a point.
Parameters
- radians: number
  Amount to rotate in radians
- center: Vec2Like
  Center
Returns this
Self
- Defined in math/vec2.ts:498

round

round(): this
Round all components.

Returns this
Self
- Defined in math/vec2.ts:632

set

set(x: number, y?: number): this
Set components.
Parameters
- x: number
  X value
- Optionaly: number
  Y value, uses x if omitted
Returns this
Self
- Defined in math/vec2.ts:223

subtract

subtract(x: number, y?: number): this
Subtract components.
Parameters
- x: number
- Optionaly: number
Returns this
Self
- Defined in math/vec2.ts:261

subtractFrom

subtractFrom(x: number, y?: number): this
Make this vector the result of (x, y) - this vector.
Parameters
- x: number
- Optionaly: number
Returns this
Self
- Defined in math/vec2.ts:274

subtractFromVec

subtractFromVec(vec: Vec2Like): this
Make this vector the result of vec - this vector.
Parameters
- vec: Vec2Like
Returns this
Self
- Defined in math/vec2.ts:298

subtractVec

subtractVec(vec: Vec2Like): this
Subtract a vector.
Parameters
- vec: Vec2Like
Returns this
Self
- Defined in math/vec2.ts:286

toString

toString(): string
Returns a string representation of an object.

Returns string
- Defined in math/vec2.ts:767

`Static`from

from(v: Vec2Like): Vec2
Parameters
- v: Vec2Like
Returns Vec2
- Defined in math/vec2.ts:771

`Static`one

one(): Vec2
A new Vec2 initialized to 1,1.

Returns Vec2
- Defined in math/vec2.ts:785

`Static`zero

zero(): Vec2
A new Vec2 initialized to 0,0.

Returns Vec2
- Defined in math/vec2.ts:778