Class Vec3

A basic 3D Vector class that provides simple algebraic functionality in the form of 3D Vectors.

We use Getters/setters for both principle properties (x & y) as well as virtual properties (rotation, length etc.).

Vec3

Author

Liam Egan liam@wethecollective.com

Version

1.0.0

Created

Jan 07, 2020

Constructors

constructor

new Vec3(...args: number[]): Vec3
The Vector Class constructor
Parameters
- ...args: number[]
  The x, y and z coordinates
Returns Vec3
- Defined in Vec3.ts:23

Accessors

area

get area(): number
(getter) Vector area.

Returns number
- Defined in Vec3.ts:774

array

get array(): number[]
(getter) Returns the basic array representation of this vector.

Returns number[]
- Defined in Vec3.ts:784

depth

get depth(): number
Returns number
- Defined in Vec3.ts:764
set depth(h: number): void
(getter/setter) Vector depth. Alias of z
Parameters
- h: number
Returns void
- Defined in Vec3.ts:761

height

get height(): number
Returns number
- Defined in Vec3.ts:751
set height(h: number): void
(getter/setter) Vector height. Alias of y
Parameters
- h: number
Returns void
- Defined in Vec3.ts:748

length

get length(): number
Returns number
- Defined in Vec3.ts:686
set length(length: number): void
(getter/setter) The length of the vector
Parameters
- length: number
Returns void
Default
```
0
```
- Defined in Vec3.ts:677

lengthSquared

get lengthSquared(): number
Returns number
- Defined in Vec3.ts:667
set lengthSquared(length: number): void
(getter/setter) The length of the vector presented as a square. If you're using length for comparison, this is quicker.
Parameters
- length: number
Returns void
Default
```
0
```
- Defined in Vec3.ts:658

phi

get phi(): number
Returns number
- Defined in Vec3.ts:712
set phi(p: number): void
(getter/setter) Spherical phi. For using a vec3 as spherical coordinates. Alias of y
Parameters
- p: number
Returns void
- Defined in Vec3.ts:709

radius

get radius(): number
Returns number
- Defined in Vec3.ts:699
set radius(s: number): void
(getter/setter) Spherical radius. For using a vec3 as spherical coordinates. Alias of x
Parameters
- s: number
Returns void
- Defined in Vec3.ts:696

theta

get theta(): number
Returns number
- Defined in Vec3.ts:725
set theta(t: number): void
(getter/setter) Spherical theta. For using a vec3 as spherical coordinates. Alias of z
Parameters
- t: number
Returns void
- Defined in Vec3.ts:722

width

get width(): number
Returns number
- Defined in Vec3.ts:738
set width(w: number): void
(getter/setter) Vector width. Alias of x
Parameters
- w: number
Returns void
- Defined in Vec3.ts:735

x

get x(): number
Returns number
- Defined in Vec3.ts:611
set x(x: number): void
Parameters
- x: number
Returns void
- Defined in Vec3.ts:604

xx

get xx(): Vec2
(getter/sette) Swizzle XX

Returns Vec2
- Defined in Vec3.ts:905
set xx(v: Vec2Like): void
Parameters
- v: Vec2Like
Returns void
- Defined in Vec3.ts:908

xy

get xy(): Vec2
(getter/sette) Swizzle XY

Returns Vec2
- Defined in Vec3.ts:835
set xy(v: Vec2Like): void
Parameters
- v: Vec2Like
Returns void
- Defined in Vec3.ts:838

xyz

get xyz(): Vec3
(getter/sette) Swizzle XYZ

Returns Vec3
- Defined in Vec3.ts:793
set xyz(v: Vec3Like): void
Parameters
- v: Vec3Like
Returns void
- Defined in Vec3.ts:796

y

get y(): number
Returns number
- Defined in Vec3.ts:629
set y(y: number): void
Parameters
- y: number
Returns void
- Defined in Vec3.ts:622

yx

get yx(): Vec2
(getter/sette) Swizzle YX

Returns Vec2
- Defined in Vec3.ts:877
set yx(v: Vec2Like): void
Parameters
- v: Vec2Like
Returns void
- Defined in Vec3.ts:880

yy

get yy(): Vec2
(getter/sette) Swizzle YY

Returns Vec2
- Defined in Vec3.ts:918
set yy(v: Vec2Like): void
Parameters
- v: Vec2Like
Returns void
- Defined in Vec3.ts:921

yz

get yz(): Vec2
(getter/sette) Swizzle YZ

Returns Vec2
- Defined in Vec3.ts:849
set yz(v: Vec2Like): void
Parameters
- v: Vec2Like
Returns void
- Defined in Vec3.ts:852

yzx

get yzx(): Vec3
(getter/sette) Swizzle YZX

Returns Vec3
- Defined in Vec3.ts:811
set yzx(v: Vec3Like): void
Parameters
- v: Vec3Like
Returns void
- Defined in Vec3.ts:814

z

get z(): number
Returns number
- Defined in Vec3.ts:647
set z(z: number): void
Parameters
- z: number
Returns void
- Defined in Vec3.ts:640

zx

get zx(): Vec2
(getter/sette) Swizzle zx

Returns Vec2
- Defined in Vec3.ts:863
set zx(v: Vec2Like): void
Parameters
- v: Vec2Like
Returns void
- Defined in Vec3.ts:866

zxy

get zxy(): Vec3
(getter/sette) Swizzle ZXY

Returns Vec3
- Defined in Vec3.ts:823
set zxy(v: Vec3Like): void
Parameters
- v: Vec3Like
Returns void
- Defined in Vec3.ts:826

zy

get zy(): Vec2
(getter/sette) Swizzle ZY

Returns Vec2
- Defined in Vec3.ts:891
set zy(v: Vec2Like): void
Parameters
- v: Vec2Like
Returns void
- Defined in Vec3.ts:894

zz

get zz(): Vec2
(getter/sette) Swizzle ZZ

Returns Vec2
- Defined in Vec3.ts:931
set zz(v: Vec2Like): void
Parameters
- v: Vec2Like
Returns void
- Defined in Vec3.ts:934

Methods

[iterator]

"[iterator]"(): {
next(): | { done: boolean; value: number }
| { done: boolean; value?: undefined };
}
Adds iteration to the object, allowing it to be destructured and iterated upon in various useful ways.

Returns {
next(): | { done: boolean; value: number }
| { done: boolean; value?: undefined };
}
- Defined in Vec3.ts:1078

add

add(vector: Vec3): Vec3
Chainable
Adds one vector to another.
Parameters
- vector: Vec3
  The vector to add to this one
Returns Vec3
Returns itself, modified
- Defined in Vec3.ts:79

addNew

addNew(vector: Vec3): Vec3
Chainable
Clones the vector and adds the vector to it instead
Parameters
- vector: Vec3
  The vector to add to this one
Returns Vec3
Returns the clone of itself, modified
- Defined in Vec3.ts:93

addScalar

addScalar(scalar: number): Vec3
Chainable
Adds a scalar to the vector, modifying both the x and y
Parameters
- scalar: number
  The scalar to add to the vector
Returns Vec3
Returns itself, modified
- Defined in Vec3.ts:105

addScalarNew

addScalarNew(scalar: number): Vec3
Chainable
Clones the vector and adds the scalar to it instead
Parameters
- scalar: number
  The scalar to add to the vector
Returns Vec3
Returns the clone of itself, modified
- Defined in Vec3.ts:116

ceil

ceil(): Vec3
Returns Vec3
- Defined in Vec3.ts:549

ceilNew

ceilNew(): Vec3
Returns Vec3
- Defined in Vec3.ts:556

clone

clone(): Vec3
Clones the vector

Returns Vec3
The cloned vector
- Defined in Vec3.ts:67

cross

cross(vector: Vec3): Vec3
Calculates the cross product between this and the supplied vector.
Parameters
- vector: Vec3
  The vector object against which to calculate the cross product
Returns Vec3
The cross product of the two vectors
Example
```
// returns -2
new Vector(2, -3).cross(new Vector(-4, 2))
new Vector(-4, 2).cross(new Vector(2, -3))
// returns 2
new Vector(2, -4).cross(new Vector(-3, 2))
```
- Defined in Vec3.ts:537

crossNew

crossNew(vector: Vec3): Vec3
Parameters
- vector: Vec3
Returns Vec3
- Defined in Vec3.ts:545

distance

distance(vector: Vec3): number
Calculates the distance between this and the supplied vector
Parameters
- vector: Vec3
  The vector to calculate the distance from
Returns number
The distance between this and the supplied vector
- Defined in Vec3.ts:474

distanceX

distanceX(vector: Vec3): number
Calculates the distance on the X axis between this and the supplied vector
Parameters
- vector: Vec3
  The vector to calculate the distance from
Returns number
The distance, along the x axis, between this and the supplied vector
- Defined in Vec3.ts:484

distanceY

distanceY(vector: Vec3): number
Calculated the distance on the Y axis between this and the supplied vector
Parameters
- vector: Vec3
  The vector to calculate the distance from
Returns number
The distance, along the y axis, between this and the supplied vector
- Defined in Vec3.ts:494

distanceZ

distanceZ(vector: Vec3): number
Calculated the distance on the Z axis between this and the supplied vector
Parameters
- vector: Vec3
  The vector to calculate the distance from
Returns number
The distance, along the y axis, between this and the supplied vector
- Defined in Vec3.ts:504

divide

divide(vector: Vec3): Vec3
Chainable
Divides one vector by another.
Parameters
- vector: Vec3
  The vector to divide this by
Returns Vec3
Returns itself, modified
- Defined in Vec3.ts:177

divideNew

divideNew(vector: Vec3): Vec3
Chainable
Clones the vector and divides it by the vector instead
Parameters
- vector: Vec3
  The vector to divide the clone by
Returns Vec3
Returns the clone of itself, modified
- Defined in Vec3.ts:203

divideScalar

divideScalar(scalar: number): Vec3
Chainable
Divides the vector by a scalar.
Parameters
- scalar: number
  The scalar to divide both x and y by
Returns Vec3
Returns itself, modified
- Defined in Vec3.ts:215

divideScalarNew

divideScalarNew(scalar: number): Vec3
Chainable
Clones the vector and divides it by the provided scalar.
Parameters
- scalar: number
  The scalar to divide both x and y by
Returns Vec3
Returns the clone of itself, modified
- Defined in Vec3.ts:227

dot

dot(vector: Vec3): number
Calculates the dot product between this and a supplied vector
Parameters
- vector: Vec3
  The vector object against which to calculate the dot product
Returns number
The dot product of the two vectors
Example
```
// returns -14
new Vector(2, -3).dot(new Vector(-4, 2))
new Vector(-4, 2).dot(new Vector(2, -3))
new Vector(2, -4).dot(new Vector(-3, 2))
```
- Defined in Vec3.ts:520

floor

floor(): Vec3
Returns Vec3
- Defined in Vec3.ts:560

floorNew

floorNew(): Vec3
Returns Vec3
- Defined in Vec3.ts:567

fract

fract(): Vec3
Returns Vec3
- Defined in Vec3.ts:582

fractNew

fractNew(): Vec3
Returns Vec3
- Defined in Vec3.ts:589

inverse

inverse(): Vec3
Chainable
Inverses the vector.

Returns Vec3
Returns itself, modified
- Defined in Vec3.ts:425

inverseNew

inverseNew(): Vec3
Chainable
Clones the vector and then inverses it.

Returns Vec3
Returns itself, modified
- Defined in Vec3.ts:439

multiply

multiply(vector: Vec3): Vec3
Chainable
Multiplies one vector by another.
Parameters
- vector: Vec3
  The vector to multiply this by
Returns Vec3
Returns itself, modified
- Defined in Vec3.ts:239

multiplyNew

multiplyNew(vector: Vec3): Vec3
Chainable
Clones the vector and multiplies it by the vector instead
Parameters
- vector: Vec3
  The vector to multiply the clone by
Returns Vec3
Returns the clone of itself, modified
- Defined in Vec3.ts:253

multiplyScalar

multiplyScalar(scalar: number): Vec3
Chainable
Multiplies the vector by a scalar.
Parameters
- scalar: number
  The scalar to multiply both x and y by
Returns Vec3
Returns itself, modified
- Defined in Vec3.ts:265

multiplyScalarNew

multiplyScalarNew(scalar: number): Vec3
Chainable
Clones the vector and multiplies it by the provided scalar.
Parameters
- scalar: number
  The scalar to multiply both x and y by
Returns Vec3
Returns the clone of itself, modified
- Defined in Vec3.ts:277

negate

negate(): Vec3
Chainable
Negates the vector.

Returns Vec3
Returns itself, modified
- Defined in Vec3.ts:403

negateNew

negateNew(): Vec3
Chainable
Clones the vector and negates it.

Returns Vec3
Returns itself, modified
- Defined in Vec3.ts:414

normalise

normalise(): Vec3
Chainable
Normalises the vector down to a length of 1 unit

Returns Vec3
Returns itself, modified
- Defined in Vec3.ts:454

normaliseNew

normaliseNew(): Vec3
Chainable
Clones the vector and normalises it

Returns Vec3
Returns a clone of itself, modified
- Defined in Vec3.ts:464

reset

reset(...args: number[]): Vec3
Chainable
Resets the vector coordinates
Parameters
- ...args: number[]
  The x, y and z coordinates
Returns Vec3
- Defined in Vec3.ts:34

resetToVector

resetToVector(v: Vec3): Vec3
Chainable
Resets the vector coordinates to another vector object
Parameters
- v: Vec3
  The vector object to use to reset the coordinates
Returns Vec3
- Defined in Vec3.ts:52

rotateX

rotateX(origin: Vec3, radian: number): Vec3
Parameters
- origin: Vec3
- radian: number
Returns Vec3
- Defined in Vec3.ts:294

rotateXNew

rotateXNew(origin: Vec3, radian: number): Vec3
Parameters
- origin: Vec3
- radian: number
Returns Vec3
- Defined in Vec3.ts:307

rotateY

rotateY(origin: Vec3, radian: number): Vec3
Parameters
- origin: Vec3
- radian: number
Returns Vec3
- Defined in Vec3.ts:311

rotateYNew

rotateYNew(origin: Vec3, radian: number): Vec3
Parameters
- origin: Vec3
- radian: number
Returns Vec3
- Defined in Vec3.ts:324

rotateZ

rotateZ(origin: Vec3, radian: number): Vec3
Parameters
- origin: Vec3
- radian: number
Returns Vec3
- Defined in Vec3.ts:328

rotateZNew

rotateZNew(origin: Vec3, radian: number): Vec3
Parameters
- origin: Vec3
- radian: number
Returns Vec3
- Defined in Vec3.ts:341

round

round(): Vec3
Returns Vec3
- Defined in Vec3.ts:571

roundNew

roundNew(): Vec3
Returns Vec3
- Defined in Vec3.ts:578

scale

scale(scalar: number): Vec3
Alias of multiplyScalar
Parameters
- scalar: number
Returns Vec3
- Defined in Vec3.ts:284

scaleNew

scaleNew(scalar: number): Vec3
Alias of multiplyScalarNew
Parameters
- scalar: number
Returns Vec3
- Defined in Vec3.ts:290

subtract

subtract(vector: Vec3): Vec3
Chainable
Subtracts one vector from another.
Parameters
- vector: Vec3
  The vector to subtract from this one
Returns Vec3
Returns itself, modified
- Defined in Vec3.ts:128

subtractNew

subtractNew(vector: Vec3): Vec3
Chainable
Clones the vector and subtracts the vector from it instead
Parameters
- vector: Vec3
  The vector to subtract from this one
Returns Vec3
Returns the clone of itself, modified
- Defined in Vec3.ts:142

subtractScalar

subtractScalar(scalar: number): Vec3
Chainable
Subtracts a scalar from the vector, modifying both the x and y
Parameters
- scalar: number
  The scalar to subtract from the vector
Returns Vec3
Returns itself, modified
- Defined in Vec3.ts:154

subtractScalarNew

subtractScalarNew(scalar: number): Vec3
Chainable
Clones the vector and subtracts the scalar from it instead
Parameters
- scalar: number
  The scalar to add to the vector
Returns Vec3
Returns the clone of itself, modified
- Defined in Vec3.ts:165

transformByMat3

transformByMat3(m: Mat3Like): Vec3
Parameters
- m: Mat3Like
Returns Vec3
- Defined in Vec3.ts:359

transformByMat3New

transformByMat3New(m: Mat3Like): Vec3
Parameters
- m: Mat3Like
Returns Vec3
- Defined in Vec3.ts:368

transformByMat4

transformByMat4(m: Mat4Like): Vec3
Parameters
- m: Mat4Like
Returns Vec3
- Defined in Vec3.ts:345

transformByMat4New

transformByMat4New(m: Mat4Like): Vec3
Parameters
- m: Mat4Like
Returns Vec3
- Defined in Vec3.ts:355

transformByQuat

transformByQuat(q: Vec4Like): Vec3
Parameters
- q: Vec4Like
Returns Vec3
- Defined in Vec3.ts:372

transformByQuatNew

transformByQuatNew(q: Vec4Like): Vec3
Parameters
- q: Vec4Like
Returns Vec3
- Defined in Vec3.ts:392

`Static`fromRotationMatrix

fromRotationMatrix(m: Mat4Like, order?: string): Vec3
Parameters
- m: Mat4Like
- order: string = "YXZ"
Returns Vec3
- Defined in Vec3.ts:1012

`Static`getAngle

getAngle(a: Vec3, b: Vec3): number
Parameters
- a: Vec3
- b: Vec3
Returns number
- Defined in Vec3.ts:994

`Static`interpolate

interpolate(v: string | number | Vec3Like): Vec3
Iterpolates a provided anonymous value into a vew Vec3
Parameters
- v: string | number | Vec3Like
  The value to interpolate
Returns Vec3
out
- Defined in Vec3.ts:948

`Static`lerp

lerp(v1: Vec3, v2: Vec3, d: number): Vec3
Performs a linear interpolation between two Vec3's
Parameters
- v1: Vec3
  the first operand
- v2: Vec3
  the second operand
- d: number
  interpolation amount in the range of 0 - 1
Returns Vec3
- Defined in Vec3.ts:986