Vector4 | gametest-maths

Contains the definition of a Vector comprising 4 numbers and associated transformations.

author: Richard Greenlees
author: Kai Burjack
author: F. Neurath

Hierarchy

Vector4

Constructors

constructor

new Vector4(): Vector4
new Vector4(v: Vector4): Vector4
new Vector4(v: Vector3, w: number): Vector4
new Vector4(v: Vector2, z: number, w: number): Vector4
new Vector4(d: number): Vector4
new Vector4(x: number, y: number, z: number, w: number): Vector4
new Vector4(xyzw: number[]): Vector4

- Defined in jomlvector4.ts:60
Create a new Vector4 of (0, 0, 0, 1).

Returns Vector4
- Defined in jomlvector4.ts:68
Create a new Vector4 with the same values as v.

Parameters
- v: Vector4
```
     the <a href="Vector4.html">Vector4</a> to copy the values from
```
Returns Vector4
- Defined in jomlvector4.ts:79
Create a new Vector4 with the first three components from the given v and the given w.

Parameters
- v: Vector3
```
     the <a href="Vector3.html">Vector3</a>
```
- w: number
```
     the w component
```
Returns Vector4
- Defined in jomlvector4.ts:92
Create a new Vector4 with the first two components from the given v and the given z and w.

Parameters
- v: Vector2
```
     the <a href="Vector2.html">Vector2</a>
```
- z: number
```
     the z component
```
- w: number
```
     the w component
```
Returns Vector4
- Defined in jomlvector4.ts:100
Create a new Vector4 and initialize all four components with the given value.

Parameters
- d: number
```
     the value of all four components
```
Returns Vector4
- Defined in jomlvector4.ts:114
Create a new Vector4 with the given component values.

Parameters
- x: number
```
     the x component
```
- y: number
```
     the y component
```
- z: number
```
     the z component
```
- w: number
```
     the w component
```
Returns Vector4
- Defined in jomlvector4.ts:122
Create a new Vector4 and initialize its four components from the first four elements of the given array.

Parameters
- xyzw: number[]
```
     the array containing at least four elements
```
Returns Vector4

Properties

w

w: number

The w component of the vector.

x

x: number

The x component of the vector.

y

y: number

The y component of the vector.

z

z: number

The z component of the vector.

Methods

absolute

absolute(dest?: Vector4): Vector4

- Defined in jomlvector4.ts:1096
Compute the absolute of each of this vector's components.

Parameters
- Optional dest: Vector4
Returns Vector4
this

add

add(v: Vector4, dest?: Vector4): Vector4
add(x: number, y: number, z: number, w: number, dest?: Vector4): Vector4

- Defined in jomlvector4.ts:323
Add the supplied vector to this one.

Parameters
- v: Vector4
```
     the vector to add
```
- Optional dest: Vector4
Returns Vector4
this

Add (x, y, z, w) to this.

Parameters

x: number
```
     the x component to add
```
y: number
```
     the y component to add
```
z: number
```
     the z component to add
```
w: number
```
     the w component to add
```
Optional dest: Vector4

Returns Vector4

this

angle

angle(v: Vector4): number

- Defined in jomlvector4.ts:846
Parameters
- v: Vector4
Returns number

angleCos

angleCos(v: Vector4): number

- Defined in jomlvector4.ts:839
Parameters
- v: Vector4
Returns number

applyFunction

applyFunction(func: (x: number) => number, dest?: Vector4): Vector4

- Defined in jomlvector4.ts:1050
Parameters
- func: (x: number) => number
  - - (x: number): number
    - Parameters
      - x: number
      Returns number
- Optional dest: Vector4
Returns Vector4

ceil

ceil(dest?: Vector4): Vector4

- Defined in jomlvector4.ts:1077
Set each component of this vector to the smallest (to: closest negative infinity) {@code number} value that is greater than or equal to that component and is equal to a mathematical integer.

Parameters
- Optional dest: Vector4
Returns Vector4
this

clone

clone(): Vector4

- Defined in jomlvector4.ts:1105
Returns Vector4

distance

distance(v: Vector4): number
distance(x: number, y: number, z: number, w: number): number

- Defined in jomlvector4.ts:758
Parameters
- v: Vector4
Returns number
- Defined in jomlvector4.ts:759
Parameters
- x: number
- y: number
- z: number
- w: number
Returns number

distanceSquared

distanceSquared(v: Vector4): number
distanceSquared(x: number, y: number, z: number, w: number): number

- Defined in jomlvector4.ts:767
Parameters
- v: Vector4
Returns number
- Defined in jomlvector4.ts:768
Parameters
- x: number
- y: number
- z: number
- w: number
Returns number

div

div(v: Vector4, dest?: Vector4): Vector4
div(scalar: number, dest: Vector4): Vector4

- Defined in jomlvector4.ts:458
Divide this Vector4 component-wise by the given Vector4.

Parameters
- v: Vector4
```
     the vector to divide by
```
- Optional dest: Vector4
Returns Vector4
this
- Defined in jomlvector4.ts:466
Divide this Vector4 by the given scalar value.

Parameters
- scalar: number
```
     the scalar to divide by
```
- dest: Vector4
Returns Vector4
this

dot

dot(v: Vector4): number
dot(x: number, y: number, z: number, w: number): number

- Defined in jomlvector4.ts:830
Parameters
- v: Vector4
Returns number
- Defined in jomlvector4.ts:831
Parameters
- x: number
- y: number
- z: number
- w: number
Returns number

equals

equals(v: Vector4, delta: number): boolean
equals(x: number, y: number, z: number, w: number, delta?: number): boolean

- Defined in jomlvector4.ts:938
Parameters
- v: Vector4
- delta: number
Returns boolean
- Defined in jomlvector4.ts:939
Parameters
- x: number
- y: number
- z: number
- w: number
- Optional delta: number
Returns boolean

floor

floor(dest?: Vector4): Vector4

- Defined in jomlvector4.ts:1066
Set each component of this vector to the largest (to: closest positive infinity) {@code number} value that is less than or equal to that component and is equal to a mathematical integer.

Parameters
- Optional dest: Vector4
Returns Vector4
this

fma

fma(a: Vector4, b: Vector4, dest?: Vector4): Vector4
fma(a: number, b: Vector4, dest?: Vector4): Vector4

- Defined in jomlvector4.ts:362
Add the component-wise multiplication of a * b to this vector.

Parameters
- a: Vector4
```
     the first multiplicand
```
- b: Vector4
```
     the second multiplicand
```
- Optional dest: Vector4
Returns Vector4
this
- Defined in jomlvector4.ts:363
Parameters
- a: number
- b: Vector4
- Optional dest: Vector4
Returns Vector4

get

get(component: number): number
get(dest: Vector4): Vector4

- Defined in jomlvector4.ts:995
Parameters
- component: number
Returns number
- Defined in jomlvector4.ts:996
Parameters
- dest: Vector4
Returns Vector4

hermite

hermite(t0: Vector4, v1: Vector4, t1: Vector4, t: number, dest: Vector4): Vector4

- Defined in jomlvector4.ts:963
Parameters
- t0: Vector4
- v1: Vector4
- t1: Vector4
- t: number
- dest: Vector4
Returns Vector4

isFinite

isFinite(): boolean

- Defined in jomlvector4.ts:1101
Returns boolean

length

length(): number

- Defined in jomlvector4.ts:695
Returns number

lengthSquared

lengthSquared(): number

- Defined in jomlvector4.ts:675
Returns number

lerp

lerp(other: Vector4, t: number, dest?: Vector4): Vector4

- Defined in jomlvector4.ts:986
Linearly numbererpolate this and other using the given numbererpolation factor t and store the result in this.

If t is 0.0 then the result is this. If the numbererpolation factor is 1.0 then the result is other.
Parameters
- other: Vector4
```
     the other vector
```
- t: number
```
     the numbererpolation factor between 0.0 and 1.0
```
- Optional dest: Vector4
Returns Vector4
this

max

max(v: Vector4, dest?: Vector4): Vector4

- Defined in jomlvector4.ts:899
Set the components of this vector to be the component-wise maximum of this and the other vector.

Parameters
- v: Vector4
```
     the other vector
```
- Optional dest: Vector4
Returns Vector4
this

maxComponent

maxComponent(): number

- Defined in jomlvector4.ts:1020
Returns number

min

min(v: Vector4, dest?: Vector4): Vector4

- Defined in jomlvector4.ts:883
Set the components of this vector to be the component-wise minimum of this and the other vector.

Parameters
- v: Vector4
```
     the other vector
```
- Optional dest: Vector4
Returns Vector4
this

minComponent

minComponent(): number

- Defined in jomlvector4.ts:1035
Returns number

mul

mul(v: Vector4, dest?: Vector4): Vector4
mul(mat: Matrix4, dest?: Vector4): Vector4
mul(scalar: number, dest?: Vector4): Vector4

- Defined in jomlvector4.ts:417
Multiply this Vector4 component-wise by the given Vector4.

Parameters
- v: Vector4
```
     the vector to multiply by
```
- Optional dest: Vector4
Returns Vector4
this
- Defined in jomlvector4.ts:426
Multiply the given matrix mat with this Vector4.

Parameters
- mat: Matrix4
```
     the matrix to multiply by
```
- Optional dest: Vector4
Returns Vector4
this
- Defined in jomlvector4.ts:435
Multiply this Vector4 by the given scalar value.

Parameters
- scalar: number
```
     the scalar to multiply by
```
- Optional dest: Vector4
Returns Vector4
this

mulAdd

mulAdd(a: Vector4, b: Vector4, dest?: Vector4): Vector4
mulAdd(a: number, b: Vector4, dest?: Vector4): Vector4

- Defined in jomlvector4.ts:386
Add the component-wise multiplication of this * a to b and store the result in this.

Parameters
- a: Vector4
```
     the multiplicand
```
- b: Vector4
```
     the addend
```
- Optional dest: Vector4
Returns Vector4
this
- Defined in jomlvector4.ts:397
Add the component-wise multiplication of this * a to b and store the result in this.

Parameters
- a: number
```
     the multiplicand
```
- b: Vector4
```
     the addend
```
- Optional dest: Vector4
Returns Vector4
this

mulAffine

mulAffine(mat: Matrix4, dest?: Vector4): Vector4

- Defined in jomlvector4.ts:501
Parameters
- mat: Matrix4
- Optional dest: Vector4
Returns Vector4

mulAffineTranspose

mulAffineTranspose(mat: Matrix4, dest: Vector4): Vector4

- Defined in jomlvector4.ts:525
Parameters
- mat: Matrix4
- dest: Vector4
Returns Vector4

mulProject

mulProject(mat: Matrix4): Vector4
mulProject(mat: Matrix4, dest: Vector3): Vector3

- Defined in jomlvector4.ts:549
Multiply the given matrix mat with this Vector4, perspective: perform division.

Parameters
- mat: Matrix4
```
     the matrix to multiply this vector by
```
Returns Vector4
this
- Defined in jomlvector4.ts:550
Parameters
- mat: Matrix4
- dest: Vector3
Returns Vector3

mulTranspose

mulTranspose(mat: Matrix4, dest?: Vector4): Vector4

- Defined in jomlvector4.ts:495
Multiply the transpose of the given matrix mat with this Vector4 and store the result in this.

Parameters
- mat: Matrix4
```
     the matrix whose transpose to multiply the vector with
```
- Optional dest: Vector4
Returns Vector4
this

negate

negate(dest?: Vector4): Vector4

- Defined in jomlvector4.ts:872
Negate this vector.

Parameters
- Optional dest: Vector4
Returns Vector4
this

normalize

normalize(dest?: Vector4): Vector4
normalize(length: number, dest?: Vector4): Vector4

- Defined in jomlvector4.ts:720
Normalizes this vector.

Parameters
- Optional dest: Vector4
Returns Vector4
this
- Defined in jomlvector4.ts:729
Scale this vector to have the given length.

Parameters
- length: number
```
     the desired length
```
- Optional dest: Vector4
Returns Vector4
this

normalize3

normalize3(dest?: Vector4): Vector4

- Defined in jomlvector4.ts:748
Normalize this vector by computing only the norm of (x, y, z).

Parameters
- Optional dest: Vector4
Returns Vector4
this

rotate

rotate(quat: Quaternion, dest?: Vector4): Vector4

- Defined in jomlvector4.ts:578
Transform this vector by the given quaternion quat and store the result in this.

see
Quaterniond#transform(Vector4)

Parameters
- quat: Quaternion
```
     the quaternion to transform this vector
```
- Optional dest: Vector4
Returns Vector4
this

rotateAxis

rotateAxis(angle: number, x: number, y: number, z: number, dest?: Vector4): Vector4

Rotate this vector the specified radians around the given rotation axis.

Parameters

angle: number
```
     the angle in radians
```

x: number

     the x component of the rotation axis

y: number

     the y component of the rotation axis

z: number

     the z component of the rotation axis

Optional dest: Vector4

Returns Vector4

this

rotateX

rotateX(angle: number, dest: Vector4): Vector4

- Defined in jomlvector4.ts:628
Rotate this vector the specified radians around the X axis.

Parameters
- angle: number
```
     the angle in radians
```
- dest: Vector4
Returns Vector4
this

rotateY

rotateY(angle: number, dest: Vector4): Vector4

- Defined in jomlvector4.ts:646
Rotate this vector the specified radians around the Y axis.

Parameters
- angle: number
```
     the angle in radians
```
- dest: Vector4
Returns Vector4
this

rotateZ

rotateZ(angle: number, dest: Vector4): Vector4

- Defined in jomlvector4.ts:664
Rotate this vector the specified radians around the Z axis.

Parameters
- angle: number
```
     the angle in radians
```
- dest: Vector4
Returns Vector4
this

round

round(dest?: Vector4): Vector4

- Defined in jomlvector4.ts:1087
Set each component of this vector to the closest number that is equal to a mathematical integer with rounding to positive infinity.

Parameters
- Optional dest: Vector4
Returns Vector4
this

set

set(v: Vector4): Vector4
set(v: Vector3, w: number): Vector4
set(v: Vector2, z: number, w: number): Vector4
set(d: number): Vector4
set(x: number, y: number, z: number, w: number): Vector4
set(x: number, y: number, z: number): Vector4
set(xyzw: number[]): Vector4

- Defined in jomlvector4.ts:156
Set this Vector4 to the values of the given v.

Parameters
- v: Vector4
```
     the vector whose values will be copied numbero this
```
Returns Vector4
this
- Defined in jomlvector4.ts:167
Set the x, y, z: and components of this to the components of v and the w component to w.

Parameters
- v: Vector3
```
     the <a href="Vector3.html">Vector3</a> to copy
```
- w: number
```
     the w component
```
Returns Vector4
this
- Defined in jomlvector4.ts:181
Set the x and y components from the given v and the z and w components to the given z and w.

Parameters
- v: Vector2
```
     the <a href="Vector2.html">Vector2</a>
```
- z: number
```
     the z component
```
- w: number
```
     the w component
```
Returns Vector4
this
- Defined in jomlvector4.ts:190
Set the x, y, z, w: and components to the supplied value.

Parameters
- d: number
```
     the value of all four components
```
Returns Vector4
this
- Defined in jomlvector4.ts:205
Set the x, y, z, w: and components to the supplied values.

Parameters
- x: number
```
     the x component
```
- y: number
```
     the y component
```
- z: number
```
     the z component
```
- w: number
```
     the w component
```
Returns Vector4
this
- Defined in jomlvector4.ts:218
Set the x, y, components: z to the supplied values.

Parameters
- x: number
```
     the x component
```
- y: number
```
     the y component
```
- z: number
```
     the z component
```
Returns Vector4
this
- Defined in jomlvector4.ts:227
Set the four components of this vector to the first four elements of the given array.

Parameters
- xyzw: number[]
```
     the array containing at least four elements
```
Returns Vector4
this

setComponent

setComponent(component: number, value: number): Vector4

- Defined in jomlvector4.ts:258
Set the value of the specified component of this vector.

throws
IllegalArgumentException if component is not within [0..3]

Parameters
- component: number
```
     the component whose value to set, : within<code>[0..3]</code>
```
- value: number
```
     the value to set
```
Returns Vector4
this

smoothStep

smoothStep(v: Vector4, t: number, dest: Vector4): Vector4

- Defined in jomlvector4.ts:953
Parameters
- v: Vector4
- t: number
- dest: Vector4
Returns Vector4

sub

sub(v: Vector4, dest?: Vector4): Vector4
sub(x: number, y: number, z: number, w: number, dest?: Vector4): Vector4

- Defined in jomlvector4.ts:287
Subtract the supplied vector from this one and store the result in dest.

Parameters
- v: Vector4
```
     the vector to subtract
```
- Optional dest: Vector4
```
     will hold the result
```
Returns Vector4
dest

Subtract (x, y, z, w) from this one and store the result in dest.

Parameters

x: number
```
     the x component to subtract
```
y: number
```
     the y component to subtract
```
z: number
```
     the z component to subtract
```
w: number
```
     the w component to subtract
```
Optional dest: Vector4

Returns Vector4

dest

toBlockLocation

toBlockLocation(): BlockLocation

- Defined in jomlvector4.ts:145
Returns BlockLocation

toLocation

toLocation(): Location

- Defined in jomlvector4.ts:142
Returns Location

toString

toString(formatter?: (x: number) => string): String

- Defined in jomlvector4.ts:914
Return a string representation of this vector by formatting the vector components with the given {@link NumberFormat}.

Parameters
- Optional formatter: (x: number) => string
```
     the {@link NumberFormat} used to format the vector components with
```
  - - (x: number): string
    - Parameters
      - x: number
      Returns string
Returns String
the string representation

zero

zero(): Vector4

- Defined in jomlvector4.ts:859
Set all components to zero.

Returns Vector4
this

Static distance

distance(x1: number, y1: number, z1: number, w1: number, x2: number, y2: number, z2: number, w2: number): number

Return the distance between (x1, y1, z1, w1) and (x2, y2, z2, w2).

Parameters

x1: number

     the x component of the first vector

y1: number

     the y component of the first vector

z1: number

     the z component of the first vector

w1: number

     the w component of the first vector

x2: number

     the x component of the second vector

y2: number

     the y component of the second vector

z2: number

     the z component of the second vector

w2: number

     the 2 component of the second vector

Returns number

the euclidean distance

Static distanceSquared

distanceSquared(x1: number, y1: number, z1: number, w1: number, x2: number, y2: number, z2: number, w2: number): number

Return the squared distance between (x1, y1, z1, w1) and (x2, y2, z2, w2).

Parameters

x1: number

     the x component of the first vector

y1: number

     the y component of the first vector

z1: number

     the z component of the first vector

w1: number

     the w component of the first vector

x2: number

     the x component of the second vector

y2: number

     the y component of the second vector

z2: number

     the z component of the second vector

w2: number

     the w component of the second vector

Returns number

the euclidean distance squared

Static lengthSquared

lengthSquared(x: number, y: number, z: number, w: number): number

- Defined in jomlvector4.ts:691
Get the length squared of a 4-dimensional number-precision vector.

author
F. Neurath

Parameters
- x: number
  
  The vector's x component
- y: number
  
  The vector's y component
- z: number
  
  The vector's z component
- w: number
  
  The vector's w component
Returns number
the length squared of the given vector

Static magnitude

magnitude(x: number, y: number, z: number, w: number): number

- Defined in jomlvector4.ts:711
Get the length of a 4-dimensional number-precision vector.

author
F. Neurath

Parameters
- x: number
  
  The vector's x component
- y: number
  
  The vector's y component
- z: number
  
  The vector's z component
- w: number
  
  The vector's w component
Returns number
the length of the given vector

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Returns Vector4

Parameters

v: Vector4

Returns Vector4

Parameters

v: Vector3

w: number

Returns Vector4

Parameters

v: Vector2

z: number

w: number

Returns Vector4

Parameters

d: number

Returns Vector4

Parameters

x: number

y: number

z: number

w: number

Returns Vector4

Parameters

xyzw: number[]

Returns Vector4

Properties

w

x

y

z

Methods

absolute

Parameters

Optional dest: Vector4

Returns Vector4

add

Parameters

v: Vector4

Optional dest: Vector4

Returns Vector4

Parameters

x: number

y: number

z: number

w: number

Optional dest: Vector4

Returns Vector4

angle

Parameters

v: Vector4

Returns number

angleCos

Parameters

v: Vector4

Returns number

applyFunction

Parameters

func: (x: number) => number

Parameters

x: number

Returns number

Optional dest: Vector4

Returns Vector4

ceil

Parameters

Optional dest: Vector4

Returns Vector4

clone

Returns Vector4

distance

Parameters

v: Vector4

Returns number