Class Vector3

A Vector3.

Hierarchy (View Summary)

Vector<Vector3>
- Vector3

Index

Constructors

Properties

Accessors

abs length lengthSq manhattanLength negated normalized quatExp x y z nx ny nz one px py pz zero

Methods

__new add applyMatrix3 applyMatrix4 applyQuaternion clone cross divide dot lerp multiply scale sub toString orthoNormalize

Constructors

constructor

new Vector3(v?: RawVector3): Vector3
Parameters
- v: RawVector3 = ...
Returns Vector3
Overrides Vector.constructor
- Defined in math/vec3/Vector3.ts:19

Properties

elements

elements: RawVector3

Accessors

abs

get abs(): T
This but each component is the absolute.

Returns T
Inherited from Vector.abs
- Defined in math/vec/Vector.ts:60

length

get length(): number
The length of this. a.k.a. magnitude

Returns number
Inherited from Vector.length
- Defined in math/vec/Vector.ts:25

lengthSq

get lengthSq(): number
The squared length of this.

Returns number
Inherited from Vector.lengthSq
- Defined in math/vec/Vector.ts:32

manhattanLength

get manhattanLength(): number
The manhattan length of this.

Returns number
Inherited from Vector.manhattanLength
- Defined in math/vec/Vector.ts:39

negated

get negated(): T
This but negated.

Returns T
Inherited from Vector.negated
- Defined in math/vec/Vector.ts:53

normalized

get normalized(): T
A normalized Vector3 of this.

Returns T
Inherited from Vector.normalized
- Defined in math/vec/Vector.ts:46

quatExp

get quatExp(): Quaternion
Treating this as a quaternion with w = 0, an exponential map of the quaternion.

Returns Quaternion
- Defined in math/vec3/Vector3.ts:94

x

get x(): number
An x component of this.

Returns number
- Defined in math/vec3/Vector3.ts:27
set x(x: number): void
Parameters
- x: number
Returns void
- Defined in math/vec3/Vector3.ts:31

y

get y(): number
An y component of this.

Returns number
- Defined in math/vec3/Vector3.ts:38
set y(y: number): void
Parameters
- y: number
Returns void
- Defined in math/vec3/Vector3.ts:42

z

get z(): number
An z component of this.

Returns number
- Defined in math/vec3/Vector3.ts:49
set z(z: number): void
Parameters
- z: number
Returns void
- Defined in math/vec3/Vector3.ts:53

`Static`nx

get nx(): Vector3
Vector3( -1.0, 0.0, 0.0 )

Returns Vector3
- Defined in math/vec3/Vector3.ts:119

`Static`ny

get ny(): Vector3
Vector3( 0.0, -1.0, 0.0 )

Returns Vector3
- Defined in math/vec3/Vector3.ts:133

`Static`nz

get nz(): Vector3
Vector3( 0.0, 0.0, -1.0 )

Returns Vector3
- Defined in math/vec3/Vector3.ts:147

`Static`one

get one(): Vector3
Vector3( 1.0, 1.0, 1.0 )

Returns Vector3
- Defined in math/vec3/Vector3.ts:154

`Static`px

get px(): Vector3
Vector3( 1.0, 0.0, 0.0 )

Returns Vector3
- Defined in math/vec3/Vector3.ts:112

`Static`py

get py(): Vector3
Vector3( 0.0, 1.0, 0.0 )

Returns Vector3
- Defined in math/vec3/Vector3.ts:126

`Static`pz

get pz(): Vector3
Vector3( 0.0, 0.0, 1.0 )

Returns Vector3
- Defined in math/vec3/Vector3.ts:140

`Static`zero

get zero(): Vector3
Vector3( 0.0, 0.0, 0.0 )

Returns Vector3
- Defined in math/vec3/Vector3.ts:105

Methods

`Protected`__new

__new(v: RawVector3): Vector3
Parameters
- v: RawVector3
Returns Vector3
Overrides Vector.__new
- Defined in math/vec3/Vector3.ts:98

add

add(...vectors: Vector3[]): Vector3
Add one or more Vector into this.
Parameters
- ...vectors: Vector3[]
  Other Vectors
Returns Vector3
Inherited from Vector.add
- Defined in math/vec/Vector.ts:75

applyMatrix3

applyMatrix3(matrix: Matrix3): Vector3
Apply a 3x3 matrix to this vector.
Parameters
- matrix: Matrix3
Returns Vector3
- Defined in math/vec3/Vector3.ts:80

applyMatrix4

applyMatrix4(matrix: Matrix4): Vector3
Apply a 4x4 matrix to this vector (with an implicit 1 in the 4th dimension).
Parameters
- matrix: Matrix4
Returns Vector3
- Defined in math/vec3/Vector3.ts:87

applyQuaternion

applyQuaternion(quaternion: Quaternion): Vector3
Rotate this vector using a Quaternion.
Parameters
- quaternion: Quaternion
  A quaternion
Returns Vector3
- Defined in math/vec3/Vector3.ts:73

clone

clone(): Vector3
Clone this.

Returns Vector3
Inherited from Vector.clone
- Defined in math/vec/Vector.ts:67

cross

cross(vector: Vector3): Vector3
Return a cross of this and another Vector3.
Parameters
- vector: Vector3
  Another vector
Returns Vector3
- Defined in math/vec3/Vector3.ts:65

divide

divide(vector: Vector3): Vector3
Divide this from another Vector.
Parameters
- vector: Vector3
  Another Vector
Returns Vector3
Inherited from Vector.divide
- Defined in math/vec/Vector.ts:101

dot

dot(vector: Vector3): number
Dot two Vectors.
Parameters
- vector: Vector3
  Another vector
Returns number
Inherited from Vector.dot
- Defined in math/vec/Vector.ts:129

lerp

lerp(vector: Vector3, t: number): Vector3
Linearly interpolate the vector with another vector. The t won't be clamped.
Parameters
- vector: Vector3
  Another vector
- t: number
  A number interpolating two vectors. Usually in range [0, 1] but not clamped
Returns Vector3
Inherited from Vector.lerp
- Defined in math/vec/Vector.ts:121

multiply

multiply(...vectors: Vector3[]): Vector3
Multiply one or more Vector with this.
Parameters
- ...vectors: Vector3[]
  Other Vectors
Returns Vector3
Inherited from Vector.multiply
- Defined in math/vec/Vector.ts:91

scale

scale(scalar: number): Vector3
Scale this by scalar. a.k.a. multiplyScalar
Parameters
- scalar: number
  A scalar
Returns Vector3
Inherited from Vector.scale
- Defined in math/vec/Vector.ts:110

sub

sub(vector: Vector3): Vector3
Substract this from another Vector.
Parameters
- vector: Vector3
Returns Vector3
Inherited from Vector.sub
- Defined in math/vec/Vector.ts:83

toString

toString(): string
Returns a string representation of an object.

Returns string
- Defined in math/vec3/Vector3.ts:57

`Static`orthoNormalize

orthoNormalize(
    normal: Vector3,
    tangent: Vector3,
    binormal: Vector3,
): { binormal: Vector3; normal: Vector3; tangent: Vector3 }
Return a tangent which is orthogonal to normal. If binormal is specified, it is also returned and it's orthogonal to both normal and tangent.
Parameters
- normal: Vector3
- tangent: Vector3
- binormal: Vector3
Returns { binormal: Vector3; normal: Vector3; tangent: Vector3 }
- Defined in math/vec3/Vector3.ts:162