Vec3 | cannon-es

3-dimensional vector

example

const v = new Vec3(1, 2, 3)
console.log('x=' + v.x) // x=1

Hierarchy

Vec3

Index

Constructors

constructor

new Vec3(x?: number, y?: number, z?: number): Vec3

- Defined in math/Vec3.ts:19
Parameters
- x: number = 0.0
- y: number = 0.0
- z: number = 0.0
Returns Vec3

Methods

addScaledVector

addScaledVector(scalar: number, vector: Vec3, target?: Vec3): Vec3

- Defined in math/Vec3.ts:220
Scale a vector and add it to this vector. Save the result in "target". (target = this + vector * scalar)

Parameters
- scalar: number
- vector: Vec3
- target: Vec3 = ...
  
  The vector to save the result in.
Returns Vec3

almostEquals

almostEquals(vector: Vec3, precision?: number): boolean

- Defined in math/Vec3.ts:317
Check if a vector equals is almost equal to another one.

Parameters
- vector: Vec3
- precision: number = 1e-6
Returns boolean

almostZero

almostZero(precision?: number): boolean

- Defined in math/Vec3.ts:331
Check if a vector is almost zero

Parameters
- precision: number = 1e-6
Returns boolean

clone

clone(): Vec3

- Defined in math/Vec3.ts:350
Clone the vector

Returns Vec3

copy

copy(vector: Vec3): Vec3

- Defined in math/Vec3.ts:294
Copies value of source to this vector.

Parameters
- vector: Vec3
Returns Vec3

cross

cross(vector: Vec3, target?: Vec3): Vec3

- Defined in math/Vec3.ts:29
Vector cross product

Parameters
- vector: Vec3
- target: Vec3 = ...
  
  Optional target to save in.
Returns Vec3

crossmat

crossmat(): Mat3

- Defined in math/Vec3.ts:97
Get the cross product matrix a_cross from a vector, such that a x b = a_cross * b = c

See Umeå University Lecture

Returns Mat3

distanceSquared

distanceSquared(p: Vec3): number

- Defined in math/Vec3.ts:181
Get squared distance from this point to another point

Parameters
- p: Vec3
Returns number

distanceTo

distanceTo(p: Vec3): number

- Defined in math/Vec3.ts:168
Get distance from this point to another point

Parameters
- p: Vec3
Returns number

dot

dot(vector: Vec3): number

- Defined in math/Vec3.ts:231
Calculate dot product

Parameters
- vector: Vec3
Returns number

isAntiparallelTo

isAntiparallelTo(vector: Vec3, precision?: number): boolean

- Defined in math/Vec3.ts:342
Check if the vector is anti-parallel to another vector.

Parameters
- vector: Vec3
- Optional precision: number
  
  Set to zero for exact comparisons
Returns boolean

length

length(): number

- Defined in math/Vec3.ts:151
Get the length of the vector

Returns number

lengthSquared

lengthSquared(): number

- Defined in math/Vec3.ts:161
Get the squared length of the vector.

Returns number

lerp

lerp(vector: Vec3, t: number, target: Vec3): void

- Defined in math/Vec3.ts:305
Do a linear interpolation between two vectors

Parameters
- vector: Vec3
- t: number
  
  A number between 0 and 1. 0 will make this function return u, and 1 will make it return v. Numbers in between will generate a vector in between them.
- target: Vec3
Returns void

negate

negate(target?: Vec3): Vec3

- Defined in math/Vec3.ts:243
Make the vector point in the opposite direction.

Parameters
- target: Vec3 = ...
  
  Optional target to save in
Returns Vec3

normalize

normalize(): number

- Defined in math/Vec3.ts:106
Normalize the vector. Note that this changes the values in the vector.

Returns number
Returns the norm of the vector

scale

scale(scalar: number, target?: Vec3): Vec3

- Defined in math/Vec3.ts:195
Multiply all the components of the vector with a scalar.

Parameters
- scalar: number
- target: Vec3 = ...
  
  The vector to save the result in.
Returns Vec3

set

set(x: number, y: number, z: number): Vec3

- Defined in math/Vec3.ts:47
Set the vectors' 3 elements

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

setZero

setZero(): void

- Defined in math/Vec3.ts:57
Set all components of the vector to zero.

Returns void

tangents

tangents(t1: Vec3, t2: Vec3): void

- Defined in math/Vec3.ts:255
Compute two artificial tangents to the vector

Parameters
- t1: Vec3
  
  Vector object to save the first tangent in
- t2: Vec3
  
  Vector object to save the second tangent in
Returns void

toArray

toArray(): [number, number, number]

- Defined in math/Vec3.ts:287
Converts to an array

Returns [number, number, number]

toString

toString(): string

- Defined in math/Vec3.ts:280
Converts to a more readable format

Returns string

unit

unit(target?: Vec3): Vec3

- Defined in math/Vec3.ts:130
Get the version of this vector that is of length 1.

Parameters
- target: Vec3 = ...
  
  Optional target to save in
Returns Vec3
Returns the unit vector

vadd

vadd(vector: Vec3): Vec3
vadd(vector: Vec3, target: Vec3): void

- Defined in math/Vec3.ts:64
Vector addition

Parameters
- vector: Vec3
Returns Vec3
- Defined in math/Vec3.ts:65
Parameters
- vector: Vec3
- target: Vec3
Returns void

vmul

vmul(vector: Vec3, target?: Vec3): Vec3

- Defined in math/Vec3.ts:209
Multiply the vector with an other vector, component-wise.

Parameters
- vector: Vec3
- target: Vec3 = ...
  
  The vector to save the result in.
Returns Vec3

vsub

vsub(vector: Vec3): Vec3
vsub(vector: Vec3, target: Vec3): void

- Defined in math/Vec3.ts:80
Vector subtraction

Parameters
- vector: Vec3
Returns Vec3
- Defined in math/Vec3.ts:81
Parameters
- vector: Vec3
- target: Vec3
Returns void

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

x: number = 0.0

y: number = 0.0

z: number = 0.0

Returns Vec3

Methods

addScaledVector

Parameters

scalar: number

vector: Vec3

target: Vec3 = ...

Returns Vec3

almostEquals

Parameters

vector: Vec3

precision: number = 1e-6

Returns boolean

almostZero

Parameters

precision: number = 1e-6

Returns boolean

clone

Returns Vec3

copy

Parameters

vector: Vec3

Returns Vec3

cross

Parameters

vector: Vec3

target: Vec3 = ...

Returns Vec3

crossmat

Returns Mat3

distanceSquared

Parameters

p: Vec3

Returns number

distanceTo

Parameters

p: Vec3

Returns number

dot

Parameters

vector: Vec3

Returns number

isAntiparallelTo

Parameters

vector: Vec3

Optional precision: number

Returns boolean

length

Returns number

lengthSquared

Returns number

lerp

Parameters

vector: Vec3

t: number

target: Vec3

Returns void

negate

Parameters

target: Vec3 = ...

Returns Vec3

normalize

Returns number

scale

Parameters

scalar: number

target: Vec3 = ...

Returns Vec3

set

Parameters