Class Vector3

Stores and manipulates a threedimensional vector comprised of the components x, y and z

Authors

Jascha Karagöl, HFU, 2019 | Jirka Dell'Oro-Friedl, HFU, 2019-2022 | Jonas Plotzky, HFU, 2023-2025

Hierarchy (view full)

Mutable
- Vector3

Implements

Constructors

constructor

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

Properties

x

x: number

y

y: number

z

z: number

`Static` `Readonly` keys

keys: readonly ["x", "y", "z"] = ...

Array of the keys of a vector. Allows to translate an index (0, 1, 2) to a key ("x", "y", "z") or to iterate over a vector.

Accessors

clone

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

Returns Vector3
- Defined in Source/Core/Math/Vector3.ts:407

geo

get geo(): Geo3
- get: Returns a geographic representation of this vector
- set: Adjusts the cartesian values of this vector to represent the given as geographic coordinates
Returns Geo3
- Defined in Source/Core/Math/Vector3.ts:382
set geo(_geo): void
Parameters
- _geo: Geo3
Returns void
- Defined in Source/Core/Math/Vector3.ts:394

isArrayConvertible

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

magnitude

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

Returns number
- Defined in Source/Core/Math/Vector3.ts:361

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/Vector3.ts:371

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): Vector3
Adds the given vector to this vector.
Parameters
- _addend: Vector3
Returns Vector3
A reference to this vector.
- Defined in Source/Core/Math/Vector3.ts:494

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 Source/Core/Event/Event.ts:91

animate

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

copy

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

deserialize

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

dispatchEvent

dispatchEvent(_event): 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, _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: Vector3
- _tolerance: number = Number.EPSILON
Returns boolean
- Defined in Source/Core/Math/Vector3.ts:445

fromArray

fromArray(_array, _offset?): 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/Vector3.ts:638

getDistance

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

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/Vector3.ts:693

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! 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?): 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?): 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

isInsideCube

isInsideCube(_corner1, _corner2): boolean
Returns true if the position described by this is within a cube with the opposite corners 1 and 2.
Parameters
- _corner1: Vector3
- _corner2: Vector3
Returns boolean
- Defined in Source/Core/Math/Vector3.ts:455

isInsideSphere

isInsideSphere(_center, _radius): boolean
Returns true if the position described by this is within a sphere with the given center and radius.
Parameters
- _center: Vector3
- _radius: number
Returns boolean
- Defined in Source/Core/Math/Vector3.ts:474

map

map(_function, _out?): Vector3
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, _index, _component, _vector) => number)
  - - (_value, _index, _component, _vector): number
    - Parameters
      _value: number
      _index: number
      _component: "x" | "y" | "z"
      _vector: Vector3
      Returns number
- _out: Vector3 = ...
  (optional) the receiving vector.
Returns Vector3
_out or a new vector if none is provided.
- Defined in Source/Core/Math/Vector3.ts:620

max

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

min

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

mutate

mutate(_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/Vector3.ts:684

negate

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

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

normalize

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

project

project(_on): Vector3
Projects this vector onto the given vector.
Parameters
- _on: Vector3
Returns Vector3
A reference to this vector.
- Defined in Source/Core/Math/Vector3.ts:559

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/Vector3.ts:437

reflect

reflect(_normal): Vector3
Reflects this vector at a given normal. See Vector3.REFLECTION.
Parameters
- _normal: Vector3
Returns Vector3
A reference to this vector.
- Defined in Source/Core/Math/Vector3.ts:551

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 Source/Core/Event/Event.ts:98

scale

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

serialize

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

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

set

set(_x?, _y?, _z?): Vector3
Sets the components of this vector and returns it.
Parameters
- _x: number = 0
- _y: number = 0
- _z: number = 0
Returns Vector3
A reference to this vector.
- Defined in Source/Core/Math/Vector3.ts:428

shuffle

shuffle(): Vector3
Shuffles the components of this vector.

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

subtract

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

toArray

toArray<T>(_out?, _offset?): 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/Vector3.ts:645

toString

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

Returns string
- Defined in Source/Core/Math/Vector3.ts:663

toVector2

toVector2(_out?): Vector2
Drops the z-component and returns a Vector2 consisting of the x- and y-components.
Parameters
- _out: Vector2 = ...
  Optional vector to store the result in.
Returns Vector2
- Defined in Source/Core/Math/Vector3.ts:656

transform

transform(_transform, _includeTranslation?): Vector3
Transforms this vector by the given matrix or rotation quaternion. Including or exluding the translation if a matrix is passed. Including is the default, excluding will only rotate and scale this vector.
Parameters
- _transform: Quaternion | Matrix4x4
- _includeTranslation: boolean = true
Returns Vector3
A reference to this vector.
- Defined in Source/Core/Math/Vector3.ts:573

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

`Static` ANGLE

ANGLE(_from, _to): number
Return the angle in degrees between the two given vectors.
Parameters
- _from: Vector3
- _to: Vector3
Returns number
- Defined in Source/Core/Math/Vector3.ts:227

`Static` CROSS

CROSS(_a, _b, _out?): Vector3
Computes the crossproduct of 2 vectors.
Parameters
- _a: Vector3
- _b: Vector3
- _out: Vector3 = ...
  Optional vector to store the result in.
Returns Vector3
- Defined in Source/Core/Math/Vector3.ts:174

`Static` DIFFERENCE

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

`Static` DOT

DOT(_a, _b): number
Computes the dotproduct of 2 vectors.
Parameters
- _a: Readonly<Vector3Like>
- _b: Readonly<Vector3Like>
Returns number
- Defined in Source/Core/Math/Vector3.ts:191

`Static` GEO

GEO(_longitude?, _latitude?, _magnitude?, _out?): Vector3
Creates a cartesian vector from geographic coordinates.
Parameters
- _longitude: number = 0
- _latitude: number = 0
- _magnitude: number = 1
- _out: Vector3 = ...
  Optional vector to store the result in.
Returns Vector3
- Defined in Source/Core/Math/Vector3.ts:217

`Static` LERP

LERP(_a, _b, _t, _out?): Vector3
Performs a linear interpolation between between two vectors. When t is 0 the result is a, when t is 1 the result is b.
Parameters
- _a: Readonly<Vector3>
  the first operand.
- _b: Readonly<Vector3>
  the second operand.
- _t: number
  interpolation amount, in the range [0-1], between the two inputs.
- Optional _out: Vector3
  (optional) the receiving vector.
Returns Vector3
_out or a new vector if none is provided.

Source
https://github.com/toji/gl-matrix
- Defined in Source/Core/Math/Vector3.ts:257
LERP<T>(_a, _b, _t, _out): T
Type Parameters
- T extends Vector3Like
Parameters
- _a: Readonly<T>
- _b: Readonly<T>
- _t: number
- _out: T
Returns T
- Defined in Source/Core/Math/Vector3.ts:258

`Static` NEGATION

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

`Static` NORMALIZATION

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

`Static` ONE

ONE(_scale?): Vector3
Creates and returns a vector of the given size on each of the three axis
Parameters
- _scale: number = 1
Returns Vector3
- Defined in Source/Core/Math/Vector3.ts:66

`Static` PROJECTION

PROJECTION(_a, _b, _out?): Vector3
Return the projection of a onto b.
Parameters
- _a: Vector3
- _b: Vector3
- _out: Vector3 = ...
  Optional vector to store the result in.
Returns Vector3
- Defined in Source/Core/Math/Vector3.ts:243

`Static` RATIO

RATIO(_dividend, _divisor, _out?): Vector3
Divides the dividend by the divisor component by component and returns the result.
Parameters
- _dividend: Vector3
- _divisor: Vector3
- _out: Vector3 = ...
  Optional vector to store the result in.
Returns Vector3
- Defined in Source/Core/Math/Vector3.ts:163

`Static` REFLECTION

REFLECTION(_incoming, _normal, _out?): Vector3
Calculates and returns the reflection of the incoming vector at the given normal vector. The length of normal should be 1.
```
_________________________
          /|\
incoming / | \ reflection
        /  |  \   
         normal
```
Parameters
- _incoming: Vector3
- _normal: Vector3
- _out: Vector3 = ...
  Optional vector to store the result in.
Returns Vector3
- Defined in Source/Core/Math/Vector3.ts:206

`Static` SCALE

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

`Static` SLERP

SLERP(_a, _b, _t, _out?): Vector3
Performs a spherical linear interpolation between two vectors.
Parameters
- _a: Readonly<Vector3>
  the first operand.
- _b: Readonly<Vector3>
  the second operand.
- _t: number
  interpolation amount, in the range [0-1], between the two inputs.
- Optional _out: Vector3
  (optional) the receiving vector.
Returns Vector3
_out or a new vector if none is provided.

Source
https://github.com/toji/gl-matrix
- Defined in Source/Core/Math/Vector3.ts:278
SLERP<T>(_a, _b, _t, _out): T
Type Parameters
- T extends Vector3Like
Parameters
- _a: Readonly<T>
- _b: Readonly<T>
- _t: number
- _out: T
Returns T
- Defined in Source/Core/Math/Vector3.ts:279

`Static` SMOOTHDAMP

SMOOTHDAMP(_current, _target, _velocity, _smoothTime, _timeFrame, _maxSpeed?, _out?): Vector3
Smoothly interpolates between two vectors based on a critically damped spring model. Allows to smooth toward a moving target with an ease-in/ease-out motion maintaining a continuous velocity. Does not overshoot.
Parameters
- _current: Vector3
  The current value.
- _target: Vector3
  The target value.
- _velocity: Vector3
  The velocity at which the value is moving. This value is modified by the function and must be maintained in the outside context.
- _smoothTime: number
  The time it would take for the value to reach the target if it were moving at maximum velocity for the entire duration. When following a moving target the smooth time equals the lag time allowing to calculate the lag distance = target velocity * smooth time.
- _timeFrame: number
  The elapsed time since the last call to the function.
- _maxSpeed: number = Infinity
  An optional maximum speed that limits the velocity of the value. Defaults to Infinity.
- _out: Vector3 = ...
  Optional vector to store the result in.
Returns Vector3
Source
from Andrew Kirmse, Game Programming Gems 4, Chapter 1.10
- Defined in Source/Core/Math/Vector3.ts:306

`Static` SUM

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

`Static` TRANSFORMATION

TRANSFORMATION(_vector, _transform, _includeTranslation?, _out?): Vector3
Creates and returns a vector through transformation of the given vector by the given matrix or rotation quaternion.
Parameters
- _vector: Vector3
- _transform: Quaternion | Matrix4x4
- _includeTranslation: boolean = true
- _out: Vector3 = ...
  Optional vector to store the result in.
Returns Vector3
- Defined in Source/Core/Math/Vector3.ts:74

`Static` X

X(_scale?): Vector3
Creates and returns a vector with the given length pointing in x-direction
Parameters
- _scale: number = 1
Returns Vector3
- Defined in Source/Core/Math/Vector3.ts:38

`Static` Y

Y(_scale?): Vector3
Creates and returns a vector with the given length pointing in y-direction
Parameters
- _scale: number = 1
Returns Vector3
- Defined in Source/Core/Math/Vector3.ts:45

`Static` Z

Z(_scale?): Vector3
Creates and returns a vector with the given length pointing in z-direction
Parameters
- _scale: number = 1
Returns Vector3
- Defined in Source/Core/Math/Vector3.ts:52

`Static` ZERO

ZERO(): Vector3
Creates and returns a vector with the value 0 on each axis

Returns Vector3
- Defined in Source/Core/Math/Vector3.ts:59

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

Class Vector3

Authors

Hierarchy (view full)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns Vector3

Properties

x

y

z

Static Readonly keys

Accessors

clone

Returns Vector3

geo

Returns Geo3

Parameters

Returns void

isArrayConvertible

Returns true

magnitude

Returns number

magnitudeSquared

Returns number

type

Returns string

Methods

add

Parameters

Returns Vector3

addEventListener

Parameters

Returns void

animate

Parameters

Returns void

apply

Parameters

Parameters

Returns number

Returns Vector3

copy

Parameters

Returns Vector3

deserialize

Parameters

Returns Promise<Vector3>

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

`Static` `Readonly` keys

`Static` ANGLE

`Static` CROSS