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

Hierarchy (view full)

Mutable
- Vector2

Implements

Constructors

constructor

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

Accessors

clone

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

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

geo

get geo(): Geo2
Returns a polar representation of this vector

Returns Geo2
- Defined in Core/Source/Math/Vector2.ts:216
set geo(_geo): void
Adjust the cartesian values of this vector to represent the given as polar coordinates
Parameters
- _geo: Geo2
Returns void
- Defined in Core/Source/Math/Vector2.ts:230

magnitude

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

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

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 Core/Source/Math/Vector2.ts:200

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 Core/Source/Serialization/Mutable.ts:73

x

get x(): number
Returns number
- Defined in Core/Source/Math/Vector2.ts:176
set x(_x): void
Parameters
- _x: number
Returns void
- Defined in Core/Source/Math/Vector2.ts:183

y

get y(): number
Returns number
- Defined in Core/Source/Math/Vector2.ts:179
set y(_y): void
Parameters
- _y: number
Returns void
- Defined in Core/Source/Math/Vector2.ts:186

Methods

add

add(_addend): void
Adds the given vector to the executing vector, changing the executor.
Parameters
- _addend: Vector2
  The vector to add.
Returns void
- Defined in Core/Source/Math/Vector2.ts:261

addEventListener

addEventListener(_type, _handler, _options?): 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 Core/Source/Event/Event.ts:91

copy

copy(_original): void
Copies the values of the given vector into this
Parameters
- _original: Vector2
Returns void
- Defined in Core/Source/Math/Vector2.ts:243

deserialize

deserialize(_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 Core/Source/Math/Vector2.ts:358

dispatchEvent

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

equals

equals(_compare, _tolerance?): 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 Core/Source/Math/Vector2.ts:251

get

get(): Float32Array
Returns Float32Array
An array of the data of the vector
- Defined in Core/Source/Math/Vector2.ts:298

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 Core/Source/Math/Vector2.ts:366

getMutatorAttributeTypes

getMutatorAttributeTypes(_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!
Parameters
- _mutator: Mutator
Returns MutatorAttributeTypes
Inherited from Mutable.getMutatorAttributeTypes
- Defined in Core/Source/Serialization/Mutable.ts:137

getMutatorForAnimation

getMutatorForAnimation(): 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

Returns MutatorForAnimation
Inherited from Mutable.getMutatorForAnimation
- Defined in Core/Source/Serialization/Mutable.ts:116

getMutatorForUserInterface

getMutatorForUserInterface(): 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

Returns MutatorForUserInterface
Inherited from Mutable.getMutatorForUserInterface
- Defined in Core/Source/Serialization/Mutable.ts:123

map

map(_function): Vector2
Uses the standard array.map functionality to perform the given function on all components of this vector and return a new vector with the results
Parameters
- _function: ((value, index, array) => number)
  - - (value, index, array): number
    - Parameters
      value: number
      index: number
      array: Float32Array
      Returns number
Returns Vector2
- Defined in Core/Source/Math/Vector2.ts:344

max

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

min

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

mutate

mutate(_mutator, _selection?, _dispatchMutate?): Promise<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
- _selection: string[] = null
- _dispatchMutate: boolean = true
Returns Promise<void>
Inherited from Mutable.mutate
- Defined in Core/Source/Serialization/Mutable.ts:171

normalize

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

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 Core/Source/Math/Vector2.ts:236

removeEventListener

removeEventListener(_type, _handler, _options?): 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 Core/Source/Event/Event.ts:98

scale

scale(_scalar): void
Scales the Vector by the given _scalar.
Parameters
- _scalar: number
Returns void
- Defined in Core/Source/Math/Vector2.ts:276

serialize

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

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

set

set(_x?, _y?): void
Defines the components of this vector with the given numbers
Parameters
- _x: number = 0
- _y: number = 0
Returns void
- Defined in Core/Source/Math/Vector2.ts:290

subtract

subtract(_subtrahend): void
Subtracts the given vector from the executing vector, changing the executor.
Parameters
- _subtrahend: Vector2
  The vector to subtract.
Returns void
- Defined in Core/Source/Math/Vector2.ts:269

toString

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

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

toVector3

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

transform

transform(_mtxTransform, _includeTranslation?): void
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 void
- Defined in Core/Source/Math/Vector2.ts:306

updateMutator

updateMutator(_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 Core/Source/Serialization/Mutable.ts:157

`Static` CROSS

CROSS(_a, _b): 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
  Vector to compute the cross product on
- _b: Vector2
  Vector to compute the cross product with
Returns number
A number representing result of the cross product.
- Defined in Core/Source/Math/Vector2.ts:139

`Static` DIFFERENCE

DIFFERENCE(_minuend, _subtrahend): Vector2
Returns the result of the subtraction of two vectors.
Parameters
- _minuend: Vector2
- _subtrahend: Vector2
Returns Vector2
- Defined in Core/Source/Math/Vector2.ts:118

`Static` DOT

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

`Static` GEO

GEO(_angle?, _magnitude?): Vector2
Creates a cartesian vector from polar coordinates
Parameters
- _angle: number = 0
- _magnitude: number = 1
Returns Vector2
- Defined in Core/Source/Math/Vector2.ts:165

`Static` NORMALIZATION

NORMALIZATION(_vector, _length?): Vector2
Normalizes a given vector to the given length without editing the original vector.
Parameters
- _vector: Vector2
  the vector to normalize
- _length: number = 1
  the length of the resulting vector. defaults to 1
Returns Vector2
a new vector representing the normalised vector scaled by the given length
- Defined in Core/Source/Math/Vector2.ts:84

`Static` ONE

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

`Static` ORTHOGONAL

ORTHOGONAL(_vector, _clockwise?): 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
Returns Vector2
A Vector that is orthogonal to and has the same magnitude as the given Vector.
- Defined in Core/Source/Math/Vector2.ts:153

`Static` SCALE

SCALE(_vector, _scale): Vector2
Returns a new vector representing the given vector scaled by the given scaling factor
Parameters
- _vector: Vector2
- _scale: number
Returns Vector2
- Defined in Core/Source/Math/Vector2.ts:99

`Static` SUM

SUM(..._vectors): Vector2
Returns the resulting vector attained by addition of all given vectors.
Parameters
- Rest ..._vectors: Vector2[]
Returns Vector2
- Defined in Core/Source/Math/Vector2.ts:108

`Static` TRANSFORMATION

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

`Static` X

X(_scale?): 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 Core/Source/Math/Vector2.ts:55

`Static` Y

Y(_scale?): 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 Core/Source/Math/Vector2.ts:44

`Static` ZERO

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

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

`Static` getMutatorFromPath

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

Class Vector2

Authors

Hierarchy (view full)

Implements

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

Returns Vector2

Accessors

clone

Returns Vector2

geo

Returns Geo2

Parameters

Returns void

magnitude

Returns number

magnitudeSquared

Returns number

type

Returns string

x

Returns number

Parameters

Returns void

y

Returns number

Parameters

Returns void

Methods

add

Parameters

Returns void

addEventListener

Parameters

Returns void

copy

Parameters

Returns void

deserialize

Parameters

Returns Promise<Vector2>

dispatchEvent

Parameters

Returns boolean

equals

Parameters

Returns boolean

get

Returns Float32Array

getMutator

Returns Mutator

getMutatorAttributeTypes

Parameters

Returns MutatorAttributeTypes

getMutatorForAnimation

Returns MutatorForAnimation

getMutatorForUserInterface

Returns MutatorForUserInterface

map

Parameters

Parameters

Returns number

Returns Vector2

max

Parameters

Returns void

min

Parameters

Returns void

mutate

Parameters

Returns Promise<void>

normalize

Parameters

Returns void

`Static` CROSS

`Static` DIFFERENCE

`Static` DOT

`Static` GEO

`Static` NORMALIZATION

`Static` ONE

`Static` ORTHOGONAL

`Static` SCALE

`Static` SUM

`Static` TRANSFORMATION

`Static` X

`Static` Y

`Static` ZERO

`Static` getMutatorFromPath