Class Vector3

This class represents a threedimensional real Vector

export

Hierarchy

Vector3

Index

Constructors

constructor

Properties

x
y
z

Methods

Constructors

constructor

new Vector3(x: number, y: number, z: number): Vector3

- Defined in math/Vector3.ts:65
Creates an instance of Vector3 with given coordinates.

memberof

Vector3

Parameters
- x: number
- y: number
- z: number
Returns Vector3

Properties

x

x: number

The x coordinate

memberof: Vector2

y

y: number

The y coordinate

memberof: Vector2

z

z: number

The z coordinate

memberof: Vector3

Methods

add

add(v: Vector3): Vector3

- Defined in math/Vector3.ts:116
Returns a new Vector calculated by adding the given vector v to the current one.

memberof

Vector3

Parameters
- v: Vector3
Returns Vector3

cross

cross(v: Vector3): Vector3

- Defined in math/Vector3.ts:157
Cross product Calculates the cross product using the first three components

Parameters
- v: Vector3
  
  The vector to calculate the cross product with
Returns Vector3

The result of the cross product as new Vector

distance

distance(v: Vector3): number

- Defined in math/Vector3.ts:97
Calculates the distance between this vector another one given as parameter.

memberof

Vector3

Parameters
- v: Vector3
Returns number

dot

dot(v: Vector3): number

- Defined in math/Vector3.ts:147
Dot product

Parameters
- v: Vector3
  
  The vector to calculate the dot product with
Returns number

The result of the dot product

length

length(): number

- Defined in math/Vector3.ts:86
Returns the length of the current vector.

memberof

Vector3

Returns number

multiply

multiply(s: number): Vector3

- Defined in math/Vector3.ts:138
Returns a new vector with the coordinates multiplied by the parameter s.

memberof

Vector3

Parameters
- s: number
Returns Vector3

normalised

normalised(): Vector3

- Defined in math/Vector3.ts:104
Returns the normalised vector.

Returns Vector3

substract

substract(v: Vector3): Vector3

- Defined in math/Vector3.ts:127
Returns a new Vector calculated by subtracting the given vector v from the current one.

memberof

Vector3

Parameters
- v: Vector3
Returns Vector3

transform

transform(mat: Matrix3): Vector3

- Defined in math/Vector3.ts:172
Calculates a new Vector by multiplying a Matrix with the current vector.

If x is the current vector and mat is A the resulting vector t is:

Ax = t

memberof

Vector3

Parameters
- mat: Matrix3
Returns Vector3

Static XAxis

XAxis(): Vector3

- Defined in math/Vector3.ts:25
Returns a new Vector were only the X-axis is 1 and the rest is 0.

Returns Vector3

Static YAxis

YAxis(): Vector3

- Defined in math/Vector3.ts:32
Returns a new Vector were only the Y-axis is 1 and the rest is 0.

Returns Vector3

Static ZAxis

ZAxis(): Vector3

- Defined in math/Vector3.ts:39
Returns a new Vector were only the Z-axis is 1 and the rest is 0.

Returns Vector3

Static Zero

Zero(): Vector3

- Defined in math/Vector3.ts:18
Returns a new instance with all components set to zero.

static

memberof

Vector3

Returns Vector3

Generated using TypeDoc