Class default

Class representing a 2D vector or point. Implements a fluent, mutating API to reduce object allocations.

Index

Constructors

Properties

Accessors

magnitude normalized x y

Methods

add clone copy multiply normalize set subtract distance dot

Constructors

constructor

new default(x?: number, y?: number): default
initialises a new instance of Vector2.
Parameters
- x: number = 0
  Initial x coordinate.
- y: number = 0
  Initial y coordinate.
Returns default
- Defined in packages/dino-ge/src/math/Vector2.ts:35

Properties

`Optional`onChange

onChange?: () => void

Optional callback fired when x or y is modified.

Accessors

magnitude

get magnitude(): number
The length (magnitude) of the vector.

Returns number
- Defined in packages/dino-ge/src/math/Vector2.ts:89

normalized

get normalized(): default
A new normalized (unit length) version of this vector. Does not mutate the original vector.

Returns default
- Defined in packages/dino-ge/src/math/Vector2.ts:97

x

get x(): number
X coordinate.

Returns number
- Defined in packages/dino-ge/src/math/Vector2.ts:13
set x(val: number): void
Parameters
- val: number
Returns void
- Defined in packages/dino-ge/src/math/Vector2.ts:14

y

get y(): number
Y coordinate.

Returns number
- Defined in packages/dino-ge/src/math/Vector2.ts:22
set y(val: number): void
Parameters
- val: number
Returns void
- Defined in packages/dino-ge/src/math/Vector2.ts:23

Methods

add

add(other: default): this
Adds another vector to this one (mutates).
Parameters
- other: default
  The vector to add.
Returns this
This vector for chaining.
- Defined in packages/dino-ge/src/math/Vector2.ts:120

clone

clone(): default
Creates a new vector with the same x and y values as this one.

Returns default
A new Vector2 instance.
- Defined in packages/dino-ge/src/math/Vector2.ts:152

copy

copy(other: default): this
Copies the components of another vector into this one.
Parameters
- other: default
  The vector to copy from.
Returns this
This vector for chaining.
- Defined in packages/dino-ge/src/math/Vector2.ts:60

multiply

multiply(scalar: number): this
Multiplies this vector by a scalar (mutates).
Parameters
- scalar: number
  The value to multiply by.
Returns this
This vector for chaining.
- Defined in packages/dino-ge/src/math/Vector2.ts:142

normalize

normalize(): this
Normalizes this vector in place.

Returns this
This vector for chaining.
- Defined in packages/dino-ge/src/math/Vector2.ts:107

set

set(x: number, y: number): this
Sets the components of this vector.
Parameters
- x: number
  New x coordinate.
- y: number
  New y coordinate.
Returns this
This vector for chaining.
- Defined in packages/dino-ge/src/math/Vector2.ts:46

subtract

subtract(other: default): this
Subtracts another vector from this one (mutates).
Parameters
- other: default
  The vector to subtract.
Returns this
This vector for chaining.
- Defined in packages/dino-ge/src/math/Vector2.ts:131

`Static`distance

distance(v1: default, v2: default): number
Calculates the Euclidean distance between two vectors.
Parameters
- v1: default
  First vector.
- v2: default
  Second vector.
Returns number
The distance between v1 and v2.
- Defined in packages/dino-ge/src/math/Vector2.ts:70

`Static`dot

dot(v1: default, v2: default): number
Calculates the dot product of two vectors.
Parameters
- v1: default
  First vector.
- v2: default
  Second vector.
Returns number
The dot product of v1 and v2.
- Defined in packages/dino-ge/src/math/Vector2.ts:82