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.).

author: Liam Egan liam@wethecollective.com
version: 1.0.0
created: Jan 07, 2020

Hierarchy

Vec3

Index

Constructors

constructor

Properties

#x
#y
#z

Accessors

Methods

Constructors

constructor

new Vec3(...args: number[]): Vec3

- Defined in Vec3.ts:16
The Vector Class constructor

Parameters
- Rest ...args: number[]
Returns Vec3

Properties

Private #x

#x: number = 0

(getter/setter) The x value of the vector.

default: 0

Private #y

#y: number = 0

(getter/setter) The y value of the vector.

default: 0

Private #z

#z: number = 0

(getter/setter) The y value of the vector.

default: 0

Accessors

area

get area(): number

- Defined in Vec3.ts:803
(getter) Vector area.

readonly

Returns number

array

get array(): number[]

- Defined in Vec3.ts:813
(getter) Returns the basic array representation of this vector.

readonly

Returns number[]

depth

get depth(): number
set depth(h: number): void

- Defined in Vec3.ts:793
(getter/setter) Vector height. Alias of {@link Vector#x x}

Returns number
- Defined in Vec3.ts:790
(getter/setter) Vector height. Alias of {@link Vector#x x}

Parameters
- h: number
Returns void

height

get height(): number
set height(h: number): void

- Defined in Vec3.ts:780
(getter/setter) Vector height. Alias of {@link Vector#x x}

Returns number
- Defined in Vec3.ts:777
(getter/setter) Vector height. Alias of {@link Vector#x x}

Parameters
- h: number
Returns void

length

get length(): number
set length(length: number): void

- Defined in Vec3.ts:715
(getter/setter) The length of the vector

Returns number
- Defined in Vec3.ts:706
(getter/setter) The length of the vector

default

0

Parameters
- length: number
Returns void

lengthSquared

get lengthSquared(): number
set lengthSquared(length: number): void

- Defined in Vec3.ts:696
(getter/setter) The length of the vector presented as a square. If you're using length for comparison, this is quicker.

Returns number
- Defined in Vec3.ts:687
(getter/setter) The length of the vector presented as a square. If you're using length for comparison, this is quicker.

default

0

Parameters
- length: number
Returns void

phi

get phi(): number
set phi(p: number): void

- Defined in Vec3.ts:741
(getter/setter) Spherical phi. For using a vec3 as spherical coordinates. Alias of {@link Vector#y y}

Returns number
- Defined in Vec3.ts:738
(getter/setter) Spherical phi. For using a vec3 as spherical coordinates. Alias of {@link Vector#y y}

Parameters
- p: number
Returns void

radius

get radius(): number
set radius(s: number): void

- Defined in Vec3.ts:728
(getter/setter) Spherical radius. For using a vec3 as spherical coordinates. Alias of {@link Vector#x x}

Returns number
- Defined in Vec3.ts:725
(getter/setter) Spherical radius. For using a vec3 as spherical coordinates. Alias of {@link Vector#x x}

Parameters
- s: number
Returns void

theta

get theta(): number
set theta(t: number): void

- Defined in Vec3.ts:754
(getter/setter) Spherical theta. For using a vec3 as spherical coordinates. Alias of {@link Vector#z z}

Returns number
- Defined in Vec3.ts:751
(getter/setter) Spherical theta. For using a vec3 as spherical coordinates. Alias of {@link Vector#z z}

Parameters
- t: number
Returns void

width

get width(): number
set width(w: number): void

- Defined in Vec3.ts:767
(getter/setter) Vector width. Alias of {@link Vector#x x}

Returns number
- Defined in Vec3.ts:764
(getter/setter) Vector width. Alias of {@link Vector#x x}

Parameters
- w: number
Returns void

x

get x(): number
set x(x: number): void

- Defined in Vec3.ts:640
Returns number
- Defined in Vec3.ts:633
Parameters
- x: number
Returns void

xx

get xx(): any
set xx(v: any): void

- Defined in Vec3.ts:934
(getter/sette) Swizzle XX

Returns any
- Defined in Vec3.ts:937
(getter/sette) Swizzle XX

Parameters
- v: any
Returns void

xy

get xy(): any
set xy(v: any): void

- Defined in Vec3.ts:864
(getter/sette) Swizzle XY

Returns any
- Defined in Vec3.ts:867
(getter/sette) Swizzle XY

Parameters
- v: any
Returns void

xyz

get xyz(): any
set xyz(v: any): void

- Defined in Vec3.ts:822
(getter/sette) Swizzle XYZ

Returns any
- Defined in Vec3.ts:825
(getter/sette) Swizzle XYZ

Parameters
- v: any
Returns void

y

get y(): number
set y(y: number): void

- Defined in Vec3.ts:658
Returns number
- Defined in Vec3.ts:651
Parameters
- y: number
Returns void

yx

get yx(): any
set yx(v: any): void

- Defined in Vec3.ts:906
(getter/sette) Swizzle YX

Returns any
- Defined in Vec3.ts:909
(getter/sette) Swizzle YX

Parameters
- v: any
Returns void

yy

get yy(): any
set yy(v: any): void

- Defined in Vec3.ts:947
(getter/sette) Swizzle YY

Returns any
- Defined in Vec3.ts:950
(getter/sette) Swizzle YY

Parameters
- v: any
Returns void

yz

get yz(): any
set yz(v: any): void

- Defined in Vec3.ts:878
(getter/sette) Swizzle YZ

Returns any
- Defined in Vec3.ts:881
(getter/sette) Swizzle YZ

Parameters
- v: any
Returns void

yzx

get yzx(): any
set yzx(v: any): void

- Defined in Vec3.ts:840
(getter/sette) Swizzle YZX

Returns any
- Defined in Vec3.ts:843
(getter/sette) Swizzle YZX

Parameters
- v: any
Returns void

z

get z(): number
set z(z: number): void

- Defined in Vec3.ts:676
Returns number
- Defined in Vec3.ts:669
Parameters
- z: number
Returns void

zx

get zx(): any
set zx(v: any): void

- Defined in Vec3.ts:892
(getter/sette) Swizzle zx

Returns any
- Defined in Vec3.ts:895
(getter/sette) Swizzle zx

Parameters
- v: any
Returns void

zxy

get zxy(): any
set zxy(v: any): void

- Defined in Vec3.ts:852
(getter/sette) Swizzle ZXY

Returns any
- Defined in Vec3.ts:855
(getter/sette) Swizzle ZXY

Parameters
- v: any
Returns void

zy

get zy(): any
set zy(v: any): void

- Defined in Vec3.ts:920
(getter/sette) Swizzle ZY

Returns any
- Defined in Vec3.ts:923
(getter/sette) Swizzle ZY

Parameters
- v: any
Returns void

zz

get zz(): any
set zz(v: any): void

- Defined in Vec3.ts:960
(getter/sette) Swizzle ZZ

Returns any
- Defined in Vec3.ts:963
(getter/sette) Swizzle ZZ

Parameters
- v: any
Returns void

Methods

[iterator]

[iterator](): { next: any }

- Defined in Vec3.ts:1108
Adds iteration to the object, allowing it to be destructured and iterated upon in various useful ways.

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

add

add(vector: Vec3): Vec3

- Defined in Vec3.ts:83
Adds one vector to another.

chainable

Parameters
- vector: Vec3
  
  The vector to add to this one
Returns Vec3

Returns itself, modified

addNew

addNew(vector: Vec3): Vec3

- Defined in Vec3.ts:97
Clones the vector and adds the vector to it instead

chainable

Parameters
- vector: Vec3
  
  The vector to add to this one
Returns Vec3

Returns the clone of itself, modified

addScalar

addScalar(scalar: number): Vec3

- Defined in Vec3.ts:109
Adds a scalar to the vector, modifying both the x and y

chainable

Parameters
- scalar: number
  
  The scalar to add to the vector
Returns Vec3

Returns itself, modified

addScalarNew

addScalarNew(scalar: number): Vec3

- Defined in Vec3.ts:120
Clones the vector and adds the scalar to it instead

chainable

Parameters
- scalar: number
  
  The scalar to add to the vector
Returns Vec3

Returns the clone of itself, modified

ceil

ceil(): Vec3

- Defined in Vec3.ts:578
Returns Vec3

ceilNew

ceilNew(): Vec3

- Defined in Vec3.ts:585
Returns Vec3

clone

clone(): Vec3

- Defined in Vec3.ts:71
Clones the vector

Returns Vec3

The cloned vector

cross

cross(vector: Vec3): Vec3

- Defined in Vec3.ts:566
Calculates the cross product between this and the supplied vector.

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))

Parameters
- vector: Vec3
  
  The vector object against which to calculate the cross product
Returns Vec3

The cross product of the two vectors

crossNew

crossNew(vector: Vec3): Vec3

- Defined in Vec3.ts:574
Parameters
- vector: Vec3
Returns Vec3

distance

distance(vector: Vec3): number

- Defined in Vec3.ts:503
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

distanceX

distanceX(vector: Vec3): number

- Defined in Vec3.ts:513
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

distanceY

distanceY(vector: Vec3): number

- Defined in Vec3.ts:523
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

distanceZ

distanceZ(vector: Vec3): number

- Defined in Vec3.ts:533
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

divide

divide(vector: Vec3): Vec3

- Defined in Vec3.ts:181
Divides one vector by another.

chainable

Parameters
- vector: Vec3
  
  The vector to divide this by
Returns Vec3

Returns itself, modified

divideNew

divideNew(vector: Vec3): Vec3

- Defined in Vec3.ts:207
Clones the vector and divides it by the vector instead

chainable

Parameters
- vector: Vec3
  
  The vector to divide the clone by
Returns Vec3

Returns the clone of itself, modified

divideScalar

divideScalar(scalar: number): Vec3

- Defined in Vec3.ts:219
Divides the vector by a scalar.

chainable

Parameters
- scalar: number
  
  The scalar to divide both x and y by
Returns Vec3

Returns itself, modified

divideScalarNew

divideScalarNew(scalar: number): Vec3

- Defined in Vec3.ts:231
Clones the vector and divides it by the provided scalar.

chainable

Parameters
- scalar: number
  
  The scalar to divide both x and y by
Returns Vec3

Returns the clone of itself, modified

dot

dot(vector: Vec3): number

- Defined in Vec3.ts:549
Calculates the dot product between this and a supplied vector

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))

Parameters
- vector: Vec3
  
  The vector object against which to calculate the dot product
Returns number

The dot product of the two vectors

floor

floor(): Vec3

- Defined in Vec3.ts:589
Returns Vec3

floorNew

floorNew(): Vec3

- Defined in Vec3.ts:596
Returns Vec3

fract

fract(): Vec3

- Defined in Vec3.ts:611
Returns Vec3

fractNew

fractNew(): Vec3

- Defined in Vec3.ts:618
Returns Vec3

inverse

inverse(): Vec3

- Defined in Vec3.ts:454
Inverses the vector.

chainable

Returns Vec3

Returns itself, modified

inverseNew

inverseNew(): Vec3

- Defined in Vec3.ts:468
Clones the vector and then inverses it.

chainable

Returns Vec3

Returns itself, modified

multiply

multiply(vector: Vec3): Vec3

- Defined in Vec3.ts:243
Multiplies one vector by another.

chainable

Parameters
- vector: Vec3
  
  The vector to multiply this by
Returns Vec3

Returns itself, modified

multiplyNew

multiplyNew(vector: Vec3): Vec3

- Defined in Vec3.ts:257
Clones the vector and multiplies it by the vector instead

chainable

Parameters
- vector: Vec3
  
  The vector to multiply the clone by
Returns Vec3

Returns the clone of itself, modified

multiplyScalar

multiplyScalar(scalar: number): Vec3

- Defined in Vec3.ts:269
Multiplies the vector by a scalar.

chainable

Parameters
- scalar: number
  
  The scalar to multiply both x and y by
Returns Vec3

Returns itself, modified

multiplyScalarNew

multiplyScalarNew(scalar: number): Vec3

- Defined in Vec3.ts:281
Clones the vector and multiplies it by the provided scalar.

chainable

Parameters
- scalar: number
  
  The scalar to multiply both x and y by
Returns Vec3

Returns the clone of itself, modified

negate

negate(): Vec3

- Defined in Vec3.ts:432
Negates the vector.

chainable

Returns Vec3

Returns itself, modified

negateNew

negateNew(): Vec3

- Defined in Vec3.ts:443
Clones the vector and negates it.

chainable

Returns Vec3

Returns itself, modified

normalise

normalise(): Vec3

- Defined in Vec3.ts:483
Normalises the vector down to a length of 1 unit

chainable

Returns Vec3

Returns itself, modified

normaliseNew

normaliseNew(): Vec3

- Defined in Vec3.ts:493
Clones the vector and normalises it

chainable

Returns Vec3

Returns a clone of itself, modified

reset

reset(...args: number[]): Vec3

- Defined in Vec3.ts:38
Resets the vector coordinates

chainable

Parameters
- Rest ...args: number[]
Returns Vec3

resetToVector

resetToVector(v: Vec3): Vec3

- Defined in Vec3.ts:56
Resets the vector coordinates to another vector object

chainable

Parameters
- v: Vec3
  
  The vector object to use to reset the coordinates
Returns Vec3

rotateX

rotateX(origin: Vec3, radian: number): Vec3

- Defined in Vec3.ts:298
Parameters
- origin: Vec3
- radian: number
Returns Vec3

rotateXNew

rotateXNew(origin: Vec3, radian: number): Vec3

- Defined in Vec3.ts:317
Parameters
- origin: Vec3
- radian: number
Returns Vec3

rotateY

rotateY(origin: Vec3, radian: number): Vec3

- Defined in Vec3.ts:321
Parameters
- origin: Vec3
- radian: number
Returns Vec3

rotateZ

rotateZ(origin: Vec3, radian: number): Vec3

- Defined in Vec3.ts:344
Parameters
- origin: Vec3
- radian: number
Returns Vec3

rotateZNew

rotateZNew(origin: Vec3, radian: number): Vec3

- Defined in Vec3.ts:363
Parameters
- origin: Vec3
- radian: number
Returns Vec3

rotateyNew

rotateyNew(origin: Vec3, radian: number): Vec3

- Defined in Vec3.ts:340
Parameters
- origin: Vec3
- radian: number
Returns Vec3

round

round(): Vec3

- Defined in Vec3.ts:600
Returns Vec3

roundNew

roundNew(): Vec3

- Defined in Vec3.ts:607
Returns Vec3

scale

scale(scalar: number): Vec3

- Defined in Vec3.ts:288
Alias of {@link Vector#multiplyScalar__anchor multiplyScalar}

Parameters
- scalar: number
Returns Vec3

scaleNew

scaleNew(scalar: number): Vec3

- Defined in Vec3.ts:294
Alias of {@link Vector#multiplyScalarNew__anchor multiplyScalarNew}

Parameters
- scalar: number
Returns Vec3

subtract

subtract(vector: Vec3): Vec3

- Defined in Vec3.ts:132
Subtracts one vector from another.

chainable

Parameters
- vector: Vec3
  
  The vector to subtract from this one
Returns Vec3

Returns itself, modified

subtractNew

subtractNew(vector: Vec3): Vec3

- Defined in Vec3.ts:146
Clones the vector and subtracts the vector from it instead

chainable

Parameters
- vector: Vec3
  
  The vector to subtract from this one
Returns Vec3

Returns the clone of itself, modified

subtractScalar

subtractScalar(scalar: number): Vec3

- Defined in Vec3.ts:158
Subtracts a scalar from the vector, modifying both the x and y

chainable

Parameters
- scalar: number
  
  The scalar to subtract from the vector
Returns Vec3

Returns itself, modified

subtractScalarNew

subtractScalarNew(scalar: number): Vec3

- Defined in Vec3.ts:169
Clones the vector and subtracts the scalar from it instead

chainable

Parameters
- scalar: number
  
  The scalar to add to the vector
Returns Vec3

Returns the clone of itself, modified

transformByMat3

transformByMat3(m: any): Vec3

- Defined in Vec3.ts:383
Parameters
- m: any
Returns Vec3

transformByMat3New

transformByMat3New(m: any): Vec3

- Defined in Vec3.ts:394
Parameters
- m: any
Returns Vec3

transformByMat4

transformByMat4(m: any): Vec3

- Defined in Vec3.ts:367
Parameters
- m: any
Returns Vec3

transformByMat4New

transformByMat4New(m: any): Vec3

- Defined in Vec3.ts:379
Parameters
- m: any
Returns Vec3

transformByQuat

transformByQuat(q: any): Vec3

- Defined in Vec3.ts:398
Parameters
- q: any
Returns Vec3

transformByQuatNew

transformByQuatNew(q: any): Vec3

- Defined in Vec3.ts:421
Parameters
- q: any
Returns Vec3

Static fromRotationMatrix

fromRotationMatrix(m: any, order?: String): void | Vec3

- Defined in Vec3.ts:1040
Parameters
- m: any
- order: String = "YXZ"
Returns void | Vec3

Static getAngle

getAngle(a: Vec3, b: Vec3): number

- Defined in Vec3.ts:1013
Parameters
- a: Vec3
- b: Vec3
Returns number

Static interpolate

interpolate(v: any): Vec3

- Defined in Vec3.ts:977
Iterpolates a provided anonymous value into a vew Vec3

Parameters
- v: any
  
  The value to interpolate
Returns Vec3

out

Static lerp

lerp(v1: Vec3, v2: Vec3, d: any): Vec3

- Defined in Vec3.ts:1005
Performs a linear interpolation between two Vec3's

Parameters
- v1: Vec3
  
  the first operand
- v2: Vec3
  
  the second operand
- d: any
  
  interpolation amount in the range of 0 - 1
Returns Vec3

Generated using TypeDoc