Class Vector3

Constructors

constructor

new Vector3(coords?, modified?): Vector3
Initializes the vector to the specified coordinates and modification state. The returned vector is not locked.
Parameters
- coords: [number, number, number] = ...
  Three numbers corresponding to the x, y, and z coordinates. Default is [0, 0, 0].
- modified: boolean = false
  The modification state. Default is false.
Returns Vector3
- Defined in src/lib/math/Vector3.ts:87

Accessors

length

get length(): number
Returns number
- Defined in src/lib/math/Vector3.ts:92

maskG3

get maskG3(): number
Returns number
- Defined in src/lib/math/Vector3.ts:158
set maskG3(unused): void
Parameters
- unused: number
Returns void
- Defined in src/lib/math/Vector3.ts:161

modified

get modified(): boolean
Returns boolean
- Defined in src/lib/math/Vector3.ts:96
set modified(modified): void
Parameters
- modified: boolean
Returns void
- Defined in src/lib/math/Vector3.ts:99

x

get x(): number
The coordinate corresponding to the e1 basis vector.

Returns number
- Defined in src/lib/math/Vector3.ts:113
set x(value): void
Parameters
- value: number
Returns void
- Defined in src/lib/math/Vector3.ts:116

y

get y(): number
The coordinate corresponding to the e2 basis vector.

Returns number
- Defined in src/lib/math/Vector3.ts:128
set y(value): void
Parameters
- value: number
Returns void
- Defined in src/lib/math/Vector3.ts:131

z

get z(): number
The coordinate corresponding to the e3 basis vector.

Returns number
- Defined in src/lib/math/Vector3.ts:143
set z(value): void
Parameters
- value: number
Returns void
- Defined in src/lib/math/Vector3.ts:146

Methods

add

__add__(rhs): Vector3
Parameters
- rhs: Vector3
Returns Vector3
- Defined in src/lib/math/Vector3.ts:667

div

__div__(rhs): Vector3
Parameters
- rhs: number
Returns Vector3
- Defined in src/lib/math/Vector3.ts:717

mul

__mul__(rhs): Vector3
Parameters
- rhs: number
Returns Vector3
- Defined in src/lib/math/Vector3.ts:699

neg

__neg__(): Vector3
Returns Vector3
- Defined in src/lib/math/Vector3.ts:734

pos

__pos__(): Vector3
Returns Vector3
- Defined in src/lib/math/Vector3.ts:730

radd

__radd__(lhs): Vector3
Parameters
- lhs: Vector3
Returns Vector3
- Defined in src/lib/math/Vector3.ts:675

rdiv

__rdiv__(lhs): Vector3
Parameters
- lhs: any
Returns Vector3
- Defined in src/lib/math/Vector3.ts:726

rmul

__rmul__(lhs): Vector3
Parameters
- lhs: number | Matrix3
Returns Vector3
- Defined in src/lib/math/Vector3.ts:707

rsub

__rsub__(lhs): Vector3
Parameters
- lhs: Vector3
Returns Vector3
- Defined in src/lib/math/Vector3.ts:691

sub

__sub__(rhs): Vector3
Parameters
- rhs: Vector3
Returns Vector3
- Defined in src/lib/math/Vector3.ts:683

add

add(vector, α?): this
this ⟼ this + vector * α
Parameters
- vector: VectorE3
- α: number = 1
Returns this
this

Chainable
- Defined in src/lib/math/Vector3.ts:175

applyMatrix

applyMatrix(σ): this
this ⟼ σ * this^T
Parameters
- σ: Matrix3
Returns this
- Defined in src/lib/math/Vector3.ts:189

applyMatrix4

applyMatrix4(σ): Vector3
Pre-multiplies the column vector corresponding to this vector by the matrix. The result is applied to this vector. Strictly speaking, this method does not make much sense because the dimensions of the square matrix and column vector don't match. TODO: Used by TubeSimplexGeometry.
Parameters
- σ: Matrix4
  The 4x4 matrix that pre-multiplies this column vector.
Returns Vector3
this

Method
applyMatrix4

Chainable
- Defined in src/lib/math/Vector3.ts:215

approx

approx(n): Vector3
Parameters
- n: number
Returns Vector3
- Defined in src/lib/math/Vector3.ts:232

clone

clone(): Vector3
Returns Vector3
copy(this)

Method
clone
- Defined in src/lib/math/Vector3.ts:290

copy

copy(source): this
this ⟼ copy(source)
Parameters
- source: VectorE3
Returns this
copy(this)
- Defined in src/lib/math/Vector3.ts:299

copyCoordinates

copyCoordinates(coordinates): this
Copies the coordinate values into this Vector3.
Parameters
- coordinates: number[]
Returns this
- Defined in src/lib/math/Vector3.ts:316

cross

cross(v): Vector3
this ⟼ this ✕ v
Parameters
- v: VectorE3
Returns Vector3
Method
cross

Chainable
- Defined in src/lib/math/Vector3.ts:333

cross2

cross2(a, b): Vector3
this ⟼ a ✕ b
Parameters
- a: VectorE3
- b: VectorE3
Returns Vector3
a x b
- Defined in src/lib/math/Vector3.ts:344

distanceTo

distanceTo(point): number
Parameters
- point: VectorE3
Returns number
Method
distanceTo
- Defined in src/lib/math/Vector3.ts:362

divByScalar

divByScalar(α): this
this ⟼ this / α
Parameters
- α: number
Returns this
Chainable
- Defined in src/lib/math/Vector3.ts:391

dot

dot(v): number
Parameters
- v: VectorE3
Returns number
Method
dot
- Defined in src/lib/math/Vector3.ts:409

dual

dual(B, changeSign): Vector3
this ⟼ I * B

Sets this vector to the dual of the bivector, B. If changeSign is true, the direction of the resulting vector is reversed.
Parameters
- B: SpinorE3
- changeSign: boolean
Returns Vector3
Method
dual

Chainable
- Defined in src/lib/math/Vector3.ts:426

equals

equals(other): boolean
Parameters
- other: any
Returns boolean
- Defined in src/lib/math/Vector3.ts:442

getComponent

getComponent(i): number
Parameters
- i: number
Returns number
- Defined in src/lib/math/Vector3.ts:106

isLocked

isLocked(): boolean
Returns boolean
- Defined in src/lib/math/Vector3.ts:37

isZero

isZero(): boolean
Returns boolean
- Defined in src/lib/math/Vector3.ts:453

lerp

lerp(target, α): Vector3
this ⟼ this + α * (target - this)
Parameters
- target: VectorE3
- α: number
Returns Vector3
this

Method
lerp

Chainable
- Defined in src/lib/math/Vector3.ts:487

lerp2

lerp2(a, b, α): this
this ⟼ a + α * (b - a)
Parameters
- a: VectorE3
- b: VectorE3
- α: number
Returns this
Method
lerp2

Chainable
- Defined in src/lib/math/Vector3.ts:504

lock

lock(): number
Returns number
- Defined in src/lib/math/Vector3.ts:41

magnitude

magnitude(): number
Computes the square root of the squared norm.

Returns number
- Defined in src/lib/math/Vector3.ts:460

neg

neg(): Vector3
Returns Vector3
this

Method
neg

Chainable
- Defined in src/lib/math/Vector3.ts:469

normalize

normalize(): Vector3
this ⟼ this / norm(this)
Returns Vector3
this

Method
normalize

Chainable
- Defined in src/lib/math/Vector3.ts:518

quadranceTo

quadranceTo(point): number
Parameters
- point: VectorE3
Returns number
Method
quadranceTo
- Defined in src/lib/math/Vector3.ts:374

reflect

reflect(n): this
this ⟼ - n * this * n
Parameters
- n: VectorE3
Returns this
Method
reflect

Chainable
- Defined in src/lib/math/Vector3.ts:246

rotate

rotate(R): Vector3
Parameters
- R: SpinorE3
Returns Vector3
R * this * reverse(R)
- Defined in src/lib/math/Vector3.ts:264

scale

scale(α): Vector3
this ⟼ this * α
Parameters
- α: number
Returns Vector3
- Defined in src/lib/math/Vector3.ts:534

setXYZ

setXYZ(x, y, z): this
this ⟼ this, with components modified.
Parameters
- x: number
- y: number
- z: number
Returns this
Chainable
- Defined in src/lib/math/Vector3.ts:562

squaredNorm

squaredNorm(): number
Returns the (Euclidean) inner product of this vector with itself.

Returns number
this ⋅ this or norm(this) * norm(this)

Method
squaredNorm
- Defined in src/lib/math/Vector3.ts:575

stress

stress(σ): this
Parameters
- σ: VectorE3
Returns this
Method
stress
- Defined in src/lib/math/Vector3.ts:545

sub

sub(v, α?): Vector3
this ⟼ this - v
Parameters
- v: VectorE3
- α: number = 1
Returns Vector3
this

Method
sub

Chainable
- Defined in src/lib/math/Vector3.ts:592

sub2

sub2(a, b): Vector3
Parameters
- a: VectorE3
- b: VectorE3
Returns Vector3
- Defined in src/lib/math/Vector3.ts:599

toArray

toArray(): number[]
Returns number[]
- Defined in src/lib/math/Vector3.ts:609

toExponential

toExponential(fractionDigits?): string
Parameters
- OptionalfractionDigits: number
Returns string
- Defined in src/lib/math/Vector3.ts:617

toFixed

toFixed(fractionDigits?): string
Parameters
- OptionalfractionDigits: number
Returns string
- Defined in src/lib/math/Vector3.ts:628

toPrecision

toPrecision(precision?): string
Parameters
- Optionalprecision: number
Returns string
- Defined in src/lib/math/Vector3.ts:639

toString

toString(radix?): string
Parameters
- Optionalradix: number
Returns string
- Defined in src/lib/math/Vector3.ts:650

unlock

unlock(token): void
Parameters
- token: number
Returns void
- Defined in src/lib/math/Vector3.ts:50

zero

zero(): Vector3
Sets this vector to the identity element for addition, 0.

Returns Vector3
- Defined in src/lib/math/Vector3.ts:660

`Static`copy

copy(vector): Vector3
Parameters
- vector: VectorE3
Returns Vector3
Method
copy

Static
Chainable
- Defined in src/lib/math/Vector3.ts:744

`Static`dot

dot(a, b): number
Parameters
- a: VectorE3
- b: VectorE3
Returns number
- Defined in src/lib/math/Vector3.ts:77

`Static`dual

dual(B): Vector3
Constructs a vector which is the dual of the supplied bivector, B. dual(B) = B << inv(I)
Parameters
- B: BivectorE3
Returns Vector3
- Defined in src/lib/math/Vector3.ts:752

`Static`e1

e1(): Vector3
Returns Vector3
- Defined in src/lib/math/Vector3.ts:756

`Static`e2

e2(): Vector3
Returns Vector3
- Defined in src/lib/math/Vector3.ts:760

`Static`e3

e3(): Vector3
Returns Vector3
- Defined in src/lib/math/Vector3.ts:764

`Static`isInstance

isInstance(x): x is Vector3
Parameters
- x: any
Returns x is Vector3
- Defined in src/lib/math/Vector3.ts:771

`Static`lerp

lerp(a, b, α): Vector3
Parameters
- a: VectorE3
- b: VectorE3
- α: number
Returns Vector3
a + α * (b - a)

Method
lerp

Static
Chainable
- Defined in src/lib/math/Vector3.ts:784

`Static`random

random(): Vector3
Computes a unit vector with a random direction.
Returns Vector3
Method
random

Static
Chainable
- Defined in src/lib/math/Vector3.ts:798

`Static`vector

vector(x, y, z): Vector3
Creates a vector with the specified cartesian coordinates. The returned vector is not locked. The returned vector is not modified.
Parameters
- x: number
  The x-coordinate.
- y: number
  The y-coordinate.
- z: number
  The z-coordinate.
Returns Vector3
- Defined in src/lib/math/Vector3.ts:813

`Static`zero

zero(): Vector3
Creates a vector with all cartesian coordinates set to zero. The returned vector is not locked. The returned vector is not modified.

Returns Vector3
- Defined in src/lib/math/Vector3.ts:822