Class Vector3

A 3D vector.

Hierarchy

Vector3

Implements

FileVector3

Index

Constructors

Properties

Methods

add cross div dot magnitude mul negate sub toFileVec3 unit fromFileVec3

Constructors

constructor

new Vector3(x: number, y: number, z: number): Vector3
Constructs a new vector from the given x, y, and z values.
Parameters
- x: number
  
  The x coordinate.
- y: number
  
  The y coordinate.
- z: number
  
  The z coordinate.
Returns Vector3
- Defined in class/vector3.ts:13

Properties

`Readonly` x

x: number

X coordinate.

`Readonly` y

y: number

Y coordinate.

`Readonly` z

z: number

Z coordinate.

`Static` one

one: Vector3 = ...

A vector with all components set to 1.

`Static` zero

zero: Vector3 = ...

A vector with all components set to 0.

Methods

add

add(other: Vector3): Vector3
Adds two vectors together.

Returns
The sum of the two vectors.
Parameters
- other: Vector3
  
  The other vector to add.
Returns Vector3
- Defined in class/vector3.ts:40

cross

cross(other: Vector3): Vector3
Calculates the cross product of two vectors.

Returns
The cross product of the two vectors.
Parameters
- other: Vector3
  
  The other vector to calculate the cross product with.
Returns Vector3
- Defined in class/vector3.ts:116

div

div(other: number | Vector3): Vector3
Divides a vector by another, or by a scalar.

Returns
The quotient of the two values.
Parameters
- other: number | Vector3
  
  The other vector to divide by, or a scalar.
Returns Vector3
- Defined in class/vector3.ts:79

dot

dot(other: Vector3): number
Calculates the dot product of two vectors.

Returns
The dot product of the two vectors.
Parameters
- other: Vector3
  
  The other vector to calculate the dot product with.
Returns number
- Defined in class/vector3.ts:129

magnitude

magnitude(): number
Calculates the magnitude of the vector.

Returns
The magnitude of the vector.

Returns number
- Defined in class/vector3.ts:101

mul

mul(other: number | Vector3): Vector3
Multiplies a vector by another, or by a scalar.

Returns
The product of the two values.
Parameters
- other: number | Vector3
  
  The other vector to multiply by, or a scalar.
Returns Vector3
- Defined in class/vector3.ts:64

negate

negate(): Vector3
Negates a vector.

Returns
The negated vector.

Returns Vector3
- Defined in class/vector3.ts:93

sub

sub(other: Vector3): Vector3
Subtracts two vectors.

Returns
The difference of the two vectors.
Parameters
- other: Vector3
  
  The other vector to subtract.
Returns Vector3
- Defined in class/vector3.ts:52

toFileVec3

toFileVec3(): FileVector3
Converts the vector to a FileVector3, which is the format used in blueprints.

Returns
The FileVector3.

Returns FileVector3
- Defined in class/vector3.ts:137

unit

unit(): Vector3
Normalizes the vector.

Returns
The normalized vector.

Returns Vector3
- Defined in class/vector3.ts:108

`Static` fromFileVec3

fromFileVec3(vec: FileVector3): Vector3
Constructs a new vector from a FileVector3, which is the format used in blueprints.

Returns
The new vector.
Parameters
- vec: FileVector3
  
  The FileVector3 to construct from.
Returns Vector3
- Defined in class/vector3.ts:23

Generated using TypeDoc