Class Vector2

Stores and manipulates a twodimensional vector comprised of the components x and y

           +y
            |__ +x

Authors

Lukas Scheuerle, Jirka Dell'Oro-Friedl, HFU, 2019 | Jonas Plotzky, HFU, 2025

Hierarchy (View Summary)

Mutable
- Vector2

Implements

Constructors

constructor

new Vector2(_x?: number, _y?: number): Vector2
Parameters
- _x: number = 0
- _y: number = 0
Returns Vector2
Overrides Mutable.constructor
- Defined in Source/Core/Math/Vector2.ts:14

Properties

x

x: number

y

y: number

Accessors

clone

get clone(): Vector2
Creates and returns a clone of this vector.

Returns Vector2
- Defined in Source/Core/Math/Vector2.ts:200

geo

get geo(): Geo2
- get: Returns a polar representation of this vector
- set: Adjusts the cartesian values of this vector to represent the given as polar coordinates
Returns Geo2
- Defined in Source/Core/Math/Vector2.ts:179
set geo(_geo: Geo2): void
Parameters
- _geo: Geo2
Returns void
- Defined in Source/Core/Math/Vector2.ts:190

isArrayConvertible

get isArrayConvertible(): true
Returns true
Implementation of ArrayConvertible.isArrayConvertible
- Defined in Source/Core/Math/Vector2.ts:157

magnitude

get magnitude(): number
Returns the length of the vector

Returns number
- Defined in Source/Core/Math/Vector2.ts:164

magnitudeSquared

get magnitudeSquared(): number
Returns the square of the magnitude of the vector without calculating a square root. Faster for simple proximity evaluation.

Returns number
- Defined in Source/Core/Math/Vector2.ts:171

type

get type(): string
Retrieves the type of this mutable subclass as the name of the runtime class

Returns string
The type of the mutable
Inherited from Mutable.type
- Defined in Source/Core/Serialization/Mutable.ts:193

Methods

add

add(_addend: Vector2): Vector2
Adds the given vector to this vector.
Parameters
- _addend: Vector2
Returns Vector2
A reference to this vector.
- Defined in Source/Core/Math/Vector2.ts:253

addEventListener

addEventListener(
    _type: string,
    _handler: EventListenerUnified,
    _options?: boolean | AddEventListenerOptions,
): void
See EventTarget.addEventListener for reference. Works with EventListenerUnified and EventUnified
Parameters
- _type: string
- _handler: EventListenerUnified
- Optional_options: boolean | AddEventListenerOptions
Returns void
Inherited from Mutable.addEventListener
- Defined in Source/Core/Event/Event.ts:91

animate

animate(_mutator: AnimationMutator): void
Updates the property values of the instance according to the state of the animation mutator. Override to implement custom animation behavior.
Parameters
- _mutator: AnimationMutator
Returns void
Inherited from Mutable.animate
- Defined in Source/Core/Serialization/Mutable.ts:329

apply

apply(
    _function: (
        _value: number,
        _index: number,
        _component: "x" | "y",
        _vector: Vector2,
    ) => number,
): Vector2
Calls a defined callback function on each component of the vector and assigns the result to the component. Similar to Vector2.map but mutates this vector instead of creating a new one.
Parameters
- _function: (
      _value: number,
      _index: number,
      _component: "x" | "y",
      _vector: Vector2,
  ) => number
Returns Vector2
A reference to this vector.
- Defined in Source/Core/Math/Vector2.ts:345

copy

copy(_original: Vector2): Vector2
Copies the components of the given vector into this vector.
Parameters
- _original: Vector2
Returns Vector2
A reference to this vector.
- Defined in Source/Core/Math/Vector2.ts:210

deserialize

deserialize(_serialization: Serialization): Promise<Vector2>
Recreates this instance of Serializable with the information from the given Serialization.
Parameters
- _serialization: Serialization
Returns Promise<Vector2>
Implementation of Serializable.deserialize
- Defined in Source/Core/Math/Vector2.ts:387

dispatchEvent

dispatchEvent(_event: EventUnified): boolean
See EventTarget.dispatchEvent for reference. Works with with EventUnified
Parameters
- _event: EventUnified
Returns boolean
Inherited from Mutable.dispatchEvent
- Defined in Source/Core/Event/Event.ts:105

equals

equals(_compare: Vector2, _tolerance?: number): boolean
Returns true if the coordinates of this and the given vector are to be considered identical within the given tolerance TODO: examine, if tolerance as criterium for the difference is appropriate with very large coordinate values or if _tolerance should be multiplied by coordinate value
Parameters
- _compare: Vector2
- _tolerance: number = Number.EPSILON
Returns boolean
- Defined in Source/Core/Math/Vector2.ts:234

fromArray

fromArray(_array: ArrayLike<number>, _offset?: number): this
Set the values of this object from the given array starting at the given offset.
Parameters
- _array: ArrayLike<number>
  The array to read the values from.
- _offset: number = 0
  (optional) The offset to start reading from.
Returns this
A reference to this instance.
Implementation of ArrayConvertible.fromArray
- Defined in Source/Core/Math/Vector2.ts:351

getDistance

getDistance(_to: Vector2): number
Returns the distance bewtween this vector and the given vector.
Parameters
- _to: Vector2
Returns number
- Defined in Source/Core/Math/Vector2.ts:243

getMetaAttributeTypes

getMetaAttributeTypes(): MetaAttributeTypes
Retrieves the specified attribute types from the metadata of this instance's class.

Returns MetaAttributeTypes
Inherited from Mutable.getMetaAttributeTypes
- Defined in Source/Core/Serialization/Mutable.ts:289

getMetadata

getMetadata(): Metadata
Retrieves the metadata of this instance's class.

Returns Metadata
Inherited from Mutable.getMetadata
- Defined in Source/Core/Serialization/Mutable.ts:296

getMutator

getMutator(): Mutator
Collect applicable attributes of the instance and copies of their values in a Mutator-object. By default, a mutator cannot be extended, since extensions are not available in the object the mutator belongs to. A mutator may be reduced by the descendants of Mutable to contain only the properties needed.

Returns Mutator
Overrides Mutable.getMutator
- Defined in Source/Core/Math/Vector2.ts:395

getMutatorAttributeTypes

getMutatorAttributeTypes(_mutator: Mutator): MutatorAttributeTypes
Returns an associative array with the same attributes as the given mutator, but with the corresponding types as string-values. Does not recurse into objects! This will return the decorated meta-type instead of the runtime-type of the object, if available.
Parameters
- _mutator: Mutator
Returns MutatorAttributeTypes
Inherited from Mutable.getMutatorAttributeTypes
- Defined in Source/Core/Serialization/Mutable.ts:260

getMutatorForAnimation

getMutatorForAnimation(_extendable?: boolean): MutatorForAnimation
Collect the attributes of the instance and their values applicable for animation. Basic functionality is identical to getMutator, returned mutator should then be reduced by the subclassed instance
Parameters
- _extendable: boolean = false
Returns MutatorForAnimation
Inherited from Mutable.getMutatorForAnimation
- Defined in Source/Core/Serialization/Mutable.ts:237

getMutatorForUserInterface

getMutatorForUserInterface(_extendable?: boolean): MutatorForUserInterface
Collect the attributes of the instance and their values applicable for the user interface. Basic functionality is identical to getMutator, returned mutator should then be reduced by the subclassed instance
Parameters
- _extendable: boolean = false
Returns MutatorForUserInterface
Inherited from Mutable.getMutatorForUserInterface
- Defined in Source/Core/Serialization/Mutable.ts:245

map

map(
    _function: (
        _value: number,
        _index: number,
        _component: "x" | "y",
        _vector: Vector2,
    ) => number,
    _out?: Vector2,
): Vector2
Calls a defined callback function on each component of the vector, and returns a new vector that contains the results. Similar to Array.map.
Parameters
- _function: (
      _value: number,
      _index: number,
      _component: "x" | "y",
      _vector: Vector2,
  ) => number
- _out: Vector2 = ...
  Optional vector to store the result in.
Returns Vector2
- Defined in Source/Core/Math/Vector2.ts:335

max

max(_compare: Vector2): Vector2
For each dimension, moves the component to the maximum of this and the given vector.
Parameters
- _compare: Vector2
Returns Vector2
A reference to this vector.
- Defined in Source/Core/Math/Vector2.ts:325

min

min(_compare: Vector2): Vector2
For each dimension, moves the component to the minimum of this and the given vector.
Parameters
- _compare: Vector2
Returns Vector2
A reference to this vector.
- Defined in Source/Core/Math/Vector2.ts:315

mutate

mutate(_mutator: Mutator): void
Updates the attribute values of the instance according to the state of the mutator. The mutation may be restricted to a subset of the mutator and the event dispatching suppressed. Uses mutateBase, but can be overwritten in subclasses
Parameters
- _mutator: Mutator
Returns void
Overrides Mutable.mutate
- Defined in Source/Core/Math/Vector2.ts:402

negate

negate(): Vector2
Negates this vector by flipping the signs of its components

Returns Vector2
A reference to this vector.
- Defined in Source/Core/Math/Vector2.ts:283

normalize

normalize(_length?: number): Vector2
Normalizes this to the given length, 1 by default
Parameters
- _length: number = 1
Returns Vector2
A reference to this vector.
- Defined in Source/Core/Math/Vector2.ts:293

recycle

recycle(): void
Recycles the object for the next reuse by setting its properties to their default states.

Returns void
Implementation of Recycable.recycle
- Defined in Source/Core/Math/Vector2.ts:226

removeEventListener

removeEventListener(
    _type: string,
    _handler: EventListenerUnified,
    _options?: boolean | AddEventListenerOptions,
): void
See EventTarget.removeEventListener for reference. Works with EventListenerUnified and EventUnified
Parameters
- _type: string
- _handler: EventListenerUnified
- Optional_options: boolean | AddEventListenerOptions
Returns void
Inherited from Mutable.removeEventListener
- Defined in Source/Core/Event/Event.ts:98

scale

scale(_scalar: number): Vector2
Scales the Vector by the given _scalar.
Parameters
- _scalar: number
Returns Vector2
A reference to this vector.
- Defined in Source/Core/Math/Vector2.ts:273

serialize

serialize(): Serialization
Returns a Serialization of this object.

Returns Serialization
Implementation of Serializable.serialize
- Defined in Source/Core/Math/Vector2.ts:380

set

set(_x?: number, _y?: number): Vector2
Sets the components of this vector.
Parameters
- _x: number = 0
- _y: number = 0
Returns Vector2
A reference to this vector.
- Defined in Source/Core/Math/Vector2.ts:220

subtract

subtract(_subtrahend: Vector2): Vector2
Subtracts the given vector from this vector.
Parameters
- _subtrahend: Vector2
Returns Vector2
A reference to this vector.
- Defined in Source/Core/Math/Vector2.ts:263

toArray

toArray<T extends { [n: number]: number } = number[]>(
_out?: T,
_offset?: number,
): T
Copy the values of this object into the given array starting at the given offset. Creates a new array if none is provided.
Type Parameters
- T extends { [n: number]: number } = number[]
Parameters
- _out: T = ...
  (optional) The receiving array.
- _offset: number = 0
  (optional) The offset to start writing to.
Returns T
_out or a new array if none is provided.
Implementation of ArrayConvertible.toArray
- Defined in Source/Core/Math/Vector2.ts:357

toString

toString(): string
Returns a formatted string representation of this vector.

Returns string
- Defined in Source/Core/Math/Vector2.ts:374

toVector3

toVector3(_z?: number, _out?: Vector3): Vector3
Adds a z-component of the given magnitude (default=0) to the vector and returns a new Vector3.
Parameters
- _z: number = 0
- _out: Vector3 = ...
  Optional vector to store the result in.
Returns Vector3
- Defined in Source/Core/Math/Vector2.ts:367

transform

transform(_mtxTransform: Matrix3x3, _includeTranslation?: boolean): Vector2
Transforms this vector by the given matrix, including or exluding the translation. Including is the default, excluding will only rotate and scale this vector.
Parameters
- _mtxTransform: Matrix3x3
- _includeTranslation: boolean = true
Returns Vector2
A reference to this vector.
- Defined in Source/Core/Math/Vector2.ts:307

updateMutator

updateMutator(_mutator: Mutator): void
Updates the values of the given mutator according to the current state of the instance
Parameters
- _mutator: Mutator
Returns void
Inherited from Mutable.updateMutator
- Defined in Source/Core/Serialization/Mutable.ts:304

`Static`CROSS

CROSS(_a: Vector2, _b: Vector2): number
Calculates the cross product of two Vectors. Due to them being only 2 Dimensional, the result is a single number, which implicitly is on the Z axis. It is also the signed magnitude of the result.
Parameters
- _a: Vector2
- _b: Vector2
Returns number
- Defined in Source/Core/Math/Vector2.ts:116

`Static`DIFFERENCE

DIFFERENCE(_minuend: Vector2, _subtrahend: Vector2, _out?: Vector2): Vector2
Returns the result of the subtraction of two vectors.
Parameters
- _minuend: Vector2
- _subtrahend: Vector2
- _out: Vector2 = ...
  Optional vector to store the result in.
Returns Vector2
- Defined in Source/Core/Math/Vector2.ts:100

`Static`DOT

DOT(_a: Vector2, _b: Vector2): number
Computes the dotproduct of 2 vectors.
Parameters
- _a: Vector2
- _b: Vector2
Returns number
- Defined in Source/Core/Math/Vector2.ts:123

`Static`GEO

GEO(_angle?: number, _magnitude?: number, _out?: Vector2): Vector2
Creates a cartesian vector from polar coordinates.
Parameters
- _angle: number = 0
- _magnitude: number = 1
- _out: Vector2 = ...
  Optional vector to store the result in.
Returns Vector2
- Defined in Source/Core/Math/Vector2.ts:148

`Static`getMutatorFromPath

getMutatorFromPath(_mutator: Mutator, _path: string[]): Mutator
Decorator allows to attach Mutable functionality to existing classes.
Parameters
- _mutator: Mutator
- _path: string[]
Returns Mutator
Inherited from Mutable.getMutatorFromPath
- Defined in Source/Core/Serialization/Mutable.ts:178

`Static`NEGATION

NEGATION(_vector: Vector2, _out?: Vector2): Vector2
Returns a new vector representing the given vector scaled by the given scaling factor.
Parameters
- _vector: Vector2
- _out: Vector2 = ...
  Optional vector to store the result in.
Returns Vector2
- Defined in Source/Core/Math/Vector2.ts:108

`Static`NORMALIZATION

NORMALIZATION(_vector: Vector2, _length?: number, _out?: Vector2): Vector2
Creates and returns a vector which is a copy of the given vector scaled to the given length.
Parameters
- _vector: Vector2
- _length: number = 1
- _out: Vector2 = ...
  Optional vector to store the result in.
Returns Vector2
- Defined in Source/Core/Math/Vector2.ts:76

`Static`ONE

ONE(_scale?: number): Vector2
A shorthand for writing new Vector2(_scale, _scale).
Parameters
- _scale: number = 1
  the scale of the vector. Default: 1
Returns Vector2
- Defined in Source/Core/Math/Vector2.ts:32

`Static`ORTHOGONAL

ORTHOGONAL(_vector: Vector2, _clockwise?: boolean, _out?: Vector2): Vector2
Calculates the orthogonal vector to the given vector. Rotates counterclockwise by default.
```
↑ => ← => ↓ => → => ↑
```
Parameters
- _vector: Vector2
  Vector to get the orthogonal equivalent of
- _clockwise: boolean = false
  Should the rotation be clockwise instead of the default counterclockwise? default: false
- _out: Vector2 = ...
  Optional vector to store the result in.
Returns Vector2
A Vector that is orthogonal to and has the same magnitude as the given Vector.
- Defined in Source/Core/Math/Vector2.ts:137

`Static`SCALE

SCALE(_vector: Vector2, _scale: number, _out?: Vector2): Vector2
Returns a new vector representing the given vector scaled by the given scaling factor
Parameters
- _vector: Vector2
- _scale: number
- _out: Vector2 = ...
  Optional vector to store the result in.
Returns Vector2
- Defined in Source/Core/Math/Vector2.ts:84

`Static`SUM

SUM(_a: Vector2, _b: Vector2, _out?: Vector2): Vector2
Returns the result of the addition of two vectors.
Parameters
- _a: Vector2
- _b: Vector2
- _out: Vector2 = ...
  Optional vector to store the result in.
Returns Vector2
- Defined in Source/Core/Math/Vector2.ts:92

`Static`TRANSFORMATION

TRANSFORMATION(
    _vector: Vector2,
    _mtxTransform: Matrix3x3,
    _includeTranslation?: boolean,
    _out?: Vector2,
): Vector2
Creates and returns a vector through transformation of the given vector by the given matrix
Parameters
- _vector: Vector2
- _mtxTransform: Matrix3x3
- _includeTranslation: boolean = true
- _out: Vector2 = ...
  Optional vector to store the result in.
Returns Vector2
- Defined in Source/Core/Math/Vector2.ts:58

`Static`X

X(_scale?: number): Vector2
A shorthand for writing new Vector2(x, 0).
Parameters
- _scale: number = 1
  The number to write in the x coordinate. Default: 1
Returns Vector2
A new vector with the values (_scale, 0)
- Defined in Source/Core/Math/Vector2.ts:41

`Static`Y

Y(_scale?: number): Vector2
A shorthand for writing new Vector2(0, y).
Parameters
- _scale: number = 1
  The number to write in the y coordinate. Default: 1
Returns Vector2
A new vector with the values (0, _scale)
- Defined in Source/Core/Math/Vector2.ts:50

`Static`ZERO

ZERO(): Vector2
A shorthand for writing new Vector2(0, 0).

Returns Vector2
A new vector with the values (0, 0)
- Defined in Source/Core/Math/Vector2.ts:24

Class Vector2

Authors

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns Vector2

Properties

x

y

Accessors

clone

Returns Vector2

geo

Returns Geo2

Parameters

Returns void

isArrayConvertible

Returns true

magnitude

Returns number

magnitudeSquared

Returns number

type

Returns string

Methods

add

Parameters

Returns Vector2

addEventListener

Parameters

Returns void

animate

Parameters

Returns void

apply

Parameters

Returns Vector2

copy

Parameters

Returns Vector2

deserialize

Parameters

Returns Promise<Vector2>

dispatchEvent

Parameters

Returns boolean

equals

Parameters

Returns boolean

fromArray

Parameters

Returns this

getDistance

Parameters

Returns number

getMetaAttributeTypes

Returns MetaAttributeTypes

getMetadata

Returns Metadata

getMutator

Returns Mutator

getMutatorAttributeTypes

Parameters

Returns MutatorAttributeTypes

getMutatorForAnimation

Parameters

Returns MutatorForAnimation

getMutatorForUserInterface

Parameters

Returns MutatorForUserInterface

map

Parameters

Returns Vector2

`Static`CROSS

`Static`DIFFERENCE

`Static`DOT

`Static`GEO

`Static`getMutatorFromPath

`Static`NEGATION

`Static`NORMALIZATION

`Static`ONE

`Static`ORTHOGONAL