Class Vector3

Hierarchy

Vector3

Implements

Vec3

Index

Constructors

Properties

type x y z Zero

Accessors

Length normalize

Constructors

constructor

new Vector3(x: number, y: number, z: number): Vector3
Parameters
- x: number
- y: number
- z: number
Returns Vector3
- Defined in utils/Vector3.ts:92

Properties

type

type: string = "vec3"

x

x: number

y

y: number

z

z: number

`Static` `Readonly` Zero

Zero: Vector3 = ...

Accessors

Length

get Length(): number
Returns number
- Defined in utils/Vector3.ts:167

normalize

get normalize(): Vector3
Returns Vector3
- Defined in utils/Vector3.ts:119

Methods

add

add(v: number | Vector): Vector3
Parameters
- v: number | Vector
Returns Vector3
- Defined in utils/Vector3.ts:131

addX

addX(x: number): Vector3
Parameters
- x: number
Returns Vector3
- Defined in utils/Vector3.ts:135

addY

addY(y: number): Vector3
Parameters
- y: number
Returns Vector3
- Defined in utils/Vector3.ts:138

addZ

addZ(z: number): Vector3
Parameters
- z: number
Returns Vector3
- Defined in utils/Vector3.ts:141

clone

clone(): Vector3
Returns Vector3
- Defined in utils/Vector3.ts:94

crossProduct

crossProduct(v: Vector): Vector3
Parameters
- v: Vector
Returns Vector3
- Defined in utils/Vector3.ts:123

distance

distance(v: Vector): number
The distance between two Vectors.

Returns
Distance between this and another vector.
Parameters
- v: Vector
  
  Vector3 to find distance between.
Returns number
- Defined in utils/Vector3.ts:115

distanceSquared

distanceSquared(v: Vector): number
The product of the Euclidean magnitudes of this and another Vector3.

Returns
Euclidean magnitude with another vector.
Parameters
- v: Vector
  
  Vector3 to find Euclidean magnitude between.
Returns number
- Defined in utils/Vector3.ts:104

divide

divide(v: number | Vector): Vector3
Parameters
- v: number | Vector
Returns Vector3
- Defined in utils/Vector3.ts:153

dotProduct

dotProduct(v: Vector): number
Parameters
- v: Vector
Returns number
- Defined in utils/Vector3.ts:127

multiply

multiply(v: number | Vector): Vector3
Parameters
- v: number | Vector
Returns Vector3
- Defined in utils/Vector3.ts:149

replace

replace(v: Vector): void
Parameters
- v: Vector
Returns void
- Defined in utils/Vector3.ts:161

subtract

subtract(v: Vector): Vector3
Parameters
- v: Vector
Returns Vector3
- Defined in utils/Vector3.ts:145

toArray

toArray(): [number, number, number]
Returns [number, number, number]
- Defined in utils/Vector3.ts:157

`Static` add

add(v1: Vector, v2: number | Vector): Vector3
Parameters
- v1: Vector
- v2: number | Vector
Returns Vector3
- Defined in utils/Vector3.ts:45

`Static` addX

addX(vec: Vector, x: number): Vector3
Parameters
- vec: Vector
- x: number
Returns Vector3
- Defined in utils/Vector3.ts:50

`Static` addY

addY(vec: Vector, y: number): Vector3
Parameters
- vec: Vector
- y: number
Returns Vector3
- Defined in utils/Vector3.ts:54

`Static` addZ

addZ(vec: Vector, z: number): Vector3
Parameters
- vec: Vector
- z: number
Returns Vector3
- Defined in utils/Vector3.ts:58

`Static` clone

clone(v1: Vec3): Vector3
Parameters
- v1: Vec3
Returns Vector3
- Defined in utils/Vector3.ts:41

`Static` create

create(v1: number | Vec3): Vector3
Parameters
- v1: number | Vec3
Returns Vector3
- Defined in utils/Vector3.ts:14

`Static` crossProduct

crossProduct(v1: Vector, v2: Vector): Vector3
Parameters
- v1: Vector
- v2: Vector
Returns Vector3
- Defined in utils/Vector3.ts:81

`Static` divide

divide(v1: Vector, v2: number | Vector): Vector3
Parameters
- v1: Vector
- v2: number | Vector
Returns Vector3
- Defined in utils/Vector3.ts:72

`Static` dotProduct

dotProduct(v1: Vector, v2: Vector): number
Parameters
- v1: Vector
- v2: Vector
Returns number
- Defined in utils/Vector3.ts:77

`Static` fromArray

fromArray(primitive: number[] | [number, number, number]): Vector3
Creates a vector from an array of numbers

Example
```
const entityPos = Vector3.fromArray(GetEntityCoords(entity))
```
Parameters
- primitive: number[] | [number, number, number]
  
  An array of numbers (usually returned by a native)
Returns Vector3
- Defined in utils/Vector3.ts:26

`Static` fromArrays

fromArrays(primitives: number[][] | [number, number, number][]): Vector3[]
Creates an array of vectors from an array number arrays

Example
```
const [forward, right, up, position] = Vector3.fromArrays(GetEntityMatrix(entity))
```
Parameters
- primitives: number[][] | [number, number, number][]
  
  A multi-dimensional array of number arrays
Returns Vector3[]
- Defined in utils/Vector3.ts:37

`Static` multiply

multiply(v1: Vector, v2: number | Vector): Vector3
Parameters
- v1: Vector
- v2: number | Vector
Returns Vector3
- Defined in utils/Vector3.ts:67

`Static` normalize

normalize(v: Vector3): Vector3
Parameters
- v: Vector3
Returns Vector3
- Defined in utils/Vector3.ts:88

`Static` subtract

subtract(v1: Vector, v2: number | Vector): Vector3
Parameters
- v1: Vector
- v2: number | Vector
Returns Vector3
- Defined in utils/Vector3.ts:62

Generated using TypeDoc