Class: MockVector

Mock of the X-Ray engine 3D vector class for jest/node.

Pure-JS implementation of the subset of vector behaviour used by shared utilities, so code that calls new vector() can run under jest when vector is bound to this mock.

Implements

• vector

Constructors

Constructor

new MockVector(): MockVector;

Returns

MockVector

Methods

abs()

abs(vector: TReadonlyVector): MockVector;

Set this vector to absolute component values of another vector.

Parameters

Parameter	Type	Description
vector	TReadonlyVector	Source vector.

Returns

MockVector

This vector.

Implementation of

vector.abs

---

add()

add(first: number | Readonly<vector>, second?: number | Readonly<vector>): MockVector;

Add a scalar to every component.

Parameters

Parameter	Type
first	number | Readonly<vector>
second?	number | Readonly<vector>

Returns

MockVector

This vector.

Implementation of

vector.add

---

align()

align(): MockVector;

Snap components to the engine alignment grid.

Returns

MockVector

This vector.

Implementation of

vector.align

---

asMock()

asMock(): vector;

Returns

vector

---

average()

average(first: TReadonlyVector, second?: Readonly<vector>): MockVector;

Set this vector to the midpoint between two vectors.

Parameters

Parameter	Type
first	TReadonlyVector
second?	Readonly<vector>

Returns

MockVector

This vector.

Implementation of

vector.average

---

clamp()

clamp(min: TReadonlyVector, max?: Readonly<vector>): MockVector;

Clamp this vector between two bounds.

Parameters

Parameter	Type	Description
min	TReadonlyVector	Minimum components.
max?	Readonly<vector>	Maximum components.

Returns

MockVector

This vector.

Implementation of

vector.clamp

---

crossproduct()

crossproduct(first: TReadonlyVector, second: TReadonlyVector): MockVector;

Set this vector to a cross product.

Parameters

Parameter	Type
first	TReadonlyVector
second	TReadonlyVector

Returns

MockVector

This vector.

Implementation of

vector.crossproduct

---

distance_to()

Call Signature

distance_to(target: TReadonlyVector): number;

Get 3D distance to another vector.

Parameters

Parameter	Type
target	TReadonlyVector

Returns

number

Distance.

Implementation of

vector.distance_to

Call Signature

distance_to(): number;

Returns

number

Implementation of

vector.distance_to

---

distance_to_sqr()

Call Signature

distance_to_sqr(target: TReadonlyVector): number;

Get squared 3D distance to another vector.

Parameters

Parameter	Type
target	TReadonlyVector

Returns

number

Squared distance.

Implementation of

vector.distance_to_sqr

Call Signature

distance_to_sqr(): number;

Returns

number

Implementation of

vector.distance_to_sqr

---

distance_to_xz()

distance_to_xz(target: TReadonlyVector): number;

Get distance to another vector on the XZ plane.

Parameters

Parameter	Type
target	TReadonlyVector

Returns

number

XZ-plane distance.

Implementation of

vector.distance_to_xz

---

div()

div(first: number | Readonly<vector>, second?: number | Readonly<vector>): MockVector;

Divide every component by a scalar.

Parameters

Parameter	Type
first	number | Readonly<vector>
second?	number | Readonly<vector>

Returns

MockVector

This vector.

Remarks

The binding performs raw division. Pass a non-zero divisor.

Implementation of

vector.div

---

dotproduct()

dotproduct(target: TReadonlyVector): number;

Get dot product with another vector.

Parameters

Parameter	Type
target	TReadonlyVector

Returns

number

Dot product.

Implementation of

vector.dotproduct

---

getH()

getH(): number;

Get heading angle for this direction vector.

Returns

number

Heading angle in radians.

Remarks

Intended for direction vectors. For arbitrary points, the result is just the angle of that vector from origin.

Implementation of

vector.getH

---

getP()

getP(): number;

Get pitch angle for this direction vector.

Returns

number

Pitch angle in radians.

Remarks

Intended for direction vectors. For arbitrary points, the result is just the angle of that vector from origin.

Implementation of

vector.getP

---

inertion()

inertion(vector: TReadonlyVector, value: number): MockVector;

Smooth this vector toward another vector.

Parameters

Parameter	Type	Description
vector	TReadonlyVector	Target vector.
value	number	Blend factor.

Returns

MockVector

This vector.

Implementation of

vector.inertion

---

invert()

invert(vector?: Readonly<vector>): MockVector;

Negate this vector.

Parameters

Parameter	Type
vector?	Readonly<vector>

Returns

MockVector

This vector.

Implementation of

vector.invert

---

lerp()

lerp(
   from: TReadonlyVector, 
   to: TReadonlyVector, 
   factor: number): MockVector;

Linearly interpolate between two vectors.

Parameters

Parameter	Type	Description
from	TReadonlyVector	Start vector.
to	TReadonlyVector	End vector.
factor	number	Interpolation factor.

Returns

MockVector

This vector.

Implementation of

vector.lerp

---

mad()

mad(
   first: TReadonlyVector, 
   second: number | Readonly<vector>, 
   third?: number | Readonly<vector>): MockVector;

Add two vectors and store the result.

Parameters

Parameter	Type
first	TReadonlyVector
second	number | Readonly<vector>
third?	number | Readonly<vector>

Returns

MockVector

This vector.

Implementation of

vector.mad

---

magnitude()

magnitude(): number;

Get vector length.

Returns

number

3D vector magnitude.

Implementation of

vector.magnitude

---

max()

max(first: TReadonlyVector, second?: Readonly<vector>): MockVector;

Set this vector to component-wise maximum of two vectors.

Parameters

Parameter	Type
first	TReadonlyVector
second?	Readonly<vector>

Returns

MockVector

This vector.

Implementation of

vector.max

---

min()

min(first: TReadonlyVector, second?: Readonly<vector>): MockVector;

Set this vector to component-wise minimum of two vectors.

Parameters

Parameter	Type
first	TReadonlyVector
second?	Readonly<vector>

Returns

MockVector

This vector.

Implementation of

vector.min

---

mul()

mul(first: number | Readonly<vector>, second?: number | Readonly<vector>): MockVector;

Multiply every component by a scalar.

Parameters

Parameter	Type
first	number | Readonly<vector>
second?	number | Readonly<vector>

Returns

MockVector

This vector.

Implementation of

vector.mul

---

normalize()

normalize(): MockVector;

Normalize this vector safely.

Returns

MockVector

This vector.

Remarks

The script binding routes normalize() through the same safe native path as normalize_safe().

Implementation of

vector.normalize

---

normalize_safe()

normalize_safe(vector?: Readonly<vector>): MockVector;

Normalize this vector safely.

Parameters

Parameter	Type
vector?	Readonly<vector>

Returns

MockVector

This vector.

Implementation of

vector.normalize_safe

---

reflect()

reflect(direction: TReadonlyVector, normal: TReadonlyVector): MockVector;

Reflect a direction vector around a normal.

Parameters

Parameter	Type	Description
direction	TReadonlyVector	Incoming direction.
normal	TReadonlyVector	Surface normal.

Returns

MockVector

This vector.

Implementation of

vector.reflect

---

set()

Call Signature

set(
   x: number, 
   y: number, 
   z: number): MockVector;

Copy another vector.

Parameters

Parameter	Type
x	number
y	number
z	number

Returns

MockVector

This vector.

Implementation of

vector.set

Call Signature

set(x: TReadonlyVector): MockVector;

Set components.

Parameters

Parameter	Type	Description
x	TReadonlyVector	X component.

Returns

MockVector

This vector.

Implementation of

vector.set

---

set_length()

set_length(value: number): MockVector;

Change vector length while keeping direction.

Parameters

Parameter	Type	Description
value	number	New length.

Returns

MockVector

This vector.

Remarks

Use on a vector that already has a meaningful direction.

Implementation of

vector.set_length

---

setHP()

setHP(h: number, p: number): MockVector;

Set direction from heading and pitch.

Parameters

Parameter	Type
h	number
p	number

Returns

MockVector

This vector.

Implementation of

vector.setHP

---

similar()

similar(vector: TReadonlyVector, epsilon: number): boolean;

Compare vectors with tolerance.

Parameters

Parameter	Type	Description
vector	TReadonlyVector	Vector to compare.
epsilon	number	Allowed component difference.

Returns

boolean

Whether vectors are similar.

Implementation of

vector.similar

---

slide()

slide(direction: TReadonlyVector, normal: TReadonlyVector): MockVector;

Slide a direction along a surface normal.

Parameters

Parameter	Type	Description
direction	TReadonlyVector	Direction vector.
normal	TReadonlyVector	Surface normal.

Returns

MockVector

This vector.

Implementation of

vector.slide

---

sub()

sub(first: number | Readonly<vector>, second?: number | Readonly<vector>): MockVector;

Subtract a scalar from every component.

Parameters

Parameter	Type
first	number | Readonly<vector>
second?	number | Readonly<vector>

Returns

MockVector

This vector.

Implementation of

vector.sub

---

create()

static create(
   x?: number, 
   y?: number, 
   z?: number): MockVector;

Parameters

Parameter	Type	Default value
x	number	0
y	number	0
z	number	0

Returns

MockVector

---

mock()

static mock(
   x?: number, 
   y?: number, 
   z?: number): vector;

Parameters

Parameter	Type	Default value
x	number	0
y	number	0
z	number	0

Returns

vector

Properties

x

x: number = 0;

X component.

Implementation of

vector.x

---

y

y: number = 0;

Y component.

Implementation of

vector.y

---

z

z: number = 0;

Z component.

Implementation of

vector.z

---

DEFAULT_DISTANCE

static DEFAULT_DISTANCE: number = 20;