Class Vector4

Stores and manipulates a fourdimensional vector comprised of the components x, y, z and w.

Authors

Jonas Plotzky, HFU, 2023

Hierarchy (view full)

Mutable
- Vector4

Implements

Index

Constructors

constructor

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

Properties

w

w: number

x

x: number

y

y: number

z

z: number

Accessors

clone

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

Returns Vector4
- Defined in Core/Source/Math/Vector4.ts:34

magnitude

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

Returns number
- Defined in Core/Source/Math/Vector4.ts:20

magnitudeSquared

get magnitudeSquared(): number
The squared magnitude (length) of the vector. Faster for simple proximity evaluation.

Returns number
- Defined in Core/Source/Math/Vector4.ts:27

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

Methods

add

add(_addend): Vector4
Adds the given vector to this vector.
Parameters
- _addend: Vector4
Returns Vector4
- Defined in Core/Source/Math/Vector4.ts:64

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 vector.
Parameters
- _original: Vector4
Returns void
- Defined in Core/Source/Math/Vector4.ts:57

deserialize

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

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

dot

dot(_other): number
Calculates the dot product of this instance and another vector.
Parameters
- _other: Vector4
Returns number
- Defined in Core/Source/Math/Vector4.ts:99

get

get(): [number, number, number, number]
Returns an array with the components of this vector.

Returns [number, number, number, number]
- Defined in Core/Source/Math/Vector4.ts:50

getMutator

getMutator(_extendable?): 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.
Parameters
- _extendable: boolean = false
Returns Mutator
Inherited from Mutable.getMutator
- Defined in Core/Source/Serialization/Mutable.ts:81

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

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?): Vector4
Normalizes this vector to the given length, 1 by default.
Parameters
- _length: number = 1
Returns Vector4
- Defined in Core/Source/Math/Vector4.ts:88

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/Vector4.ts:103

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): Vector4
Scales this vector by the given scalar.
Parameters
- _scalar: number
Returns Vector4
- Defined in Core/Source/Math/Vector4.ts:80

serialize

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

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

set

set(_x, _y, _z, _w): void
Sets the components of this vector.
Parameters
- _x: number
- _y: number
- _z: number
- _w: number
Returns void
- Defined in Core/Source/Math/Vector4.ts:43

subtract

subtract(_subtrahend): Vector4
Subtracts the given vector from this vector.
Parameters
- _subtrahend: Vector4
Returns Vector4
- Defined in Core/Source/Math/Vector4.ts:72

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` 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 Vector4

Authors

Hierarchy (view full)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns Vector4

Properties

w

x

y

z

Accessors

clone

Returns Vector4

magnitude

Returns number

magnitudeSquared

Returns number

type

Returns string

Methods

add

Parameters

Returns Vector4

addEventListener

Parameters

Returns void

copy

Parameters

Returns void

deserialize

Parameters

Returns Promise<Vector4>

dispatchEvent

Parameters

Returns boolean

dot

Parameters

Returns number

get

Returns [number, number, number, number]

getMutator

Parameters

Returns Mutator

getMutatorAttributeTypes

Parameters

Returns MutatorAttributeTypes

getMutatorForAnimation

Returns MutatorForAnimation

getMutatorForUserInterface

Returns MutatorForUserInterface

mutate

Parameters

Returns Promise<void>

normalize

Parameters

Returns Vector4

recycle

Returns void

removeEventListener

Parameters

Returns void

scale

Parameters

Returns Vector4

serialize

Returns Serialization

set

Parameters

Returns void

subtract

Parameters

Returns Vector4

`Static` getMutatorFromPath