Class Vector3

A Vector3.

Hierarchy

Vector<Vector3>
- Vector3

Index

Constructors

constructor

Properties

elements

Accessors

Methods

Constructors

constructor

new Vector3(v?: RawVector3): Vector3

Overrides Vector.constructor
- Defined in math/vec3/Vector3.ts:16
Parameters
- v: RawVector3 = ...
Returns Vector3

Properties

elements

elements: RawVector3

Accessors

abs

get abs(): T

Inherited from Vector.abs
- Defined in math/vec/Vector.ts:59
This but each component is the absolute.

Returns T

length

get length(): number

Inherited from Vector.length
- Defined in math/vec/Vector.ts:24
The length of this. a.k.a. magnitude

Returns number

lengthSq

get lengthSq(): number

Inherited from Vector.lengthSq
- Defined in math/vec/Vector.ts:31
The squared length of this.

Returns number

manhattanLength

get manhattanLength(): number

Inherited from Vector.manhattanLength
- Defined in math/vec/Vector.ts:38
The manhattan length of this.

Returns number

negated

get negated(): T

Inherited from Vector.negated
- Defined in math/vec/Vector.ts:52
This but negated.

Returns T

normalized

get normalized(): T

Inherited from Vector.normalized
- Defined in math/vec/Vector.ts:45
A normalized Vector3 of this.

Returns T

x

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

- Defined in math/vec3/Vector3.ts:24
An x component of this.

Returns number
- Defined in math/vec3/Vector3.ts:28
An x component of this.

Parameters
- x: number
Returns void

y

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

- Defined in math/vec3/Vector3.ts:35
An y component of this.

Returns number
- Defined in math/vec3/Vector3.ts:39
An y component of this.

Parameters
- y: number
Returns void

z

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

- Defined in math/vec3/Vector3.ts:46
An z component of this.

Returns number
- Defined in math/vec3/Vector3.ts:50
An z component of this.

Parameters
- z: number
Returns void

Static nx

get nx(): Vector3

- Defined in math/vec3/Vector3.ts:102
Vector3( -1.0, 0.0, 0.0 )

Returns Vector3

Static ny

get ny(): Vector3

- Defined in math/vec3/Vector3.ts:116
Vector3( 0.0, -1.0, 0.0 )

Returns Vector3

Static nz

get nz(): Vector3

- Defined in math/vec3/Vector3.ts:130
Vector3( 0.0, 0.0, -1.0 )

Returns Vector3

Static one

get one(): Vector3

- Defined in math/vec3/Vector3.ts:137
Vector3( 1.0, 1.0, 1.0 )

Returns Vector3

Static px

get px(): Vector3

- Defined in math/vec3/Vector3.ts:95
Vector3( 1.0, 0.0, 0.0 )

Returns Vector3

Static py

get py(): Vector3

- Defined in math/vec3/Vector3.ts:109
Vector3( 0.0, 1.0, 0.0 )

Returns Vector3

Static pz

get pz(): Vector3

- Defined in math/vec3/Vector3.ts:123
Vector3( 0.0, 0.0, 1.0 )

Returns Vector3

Static zero

get zero(): Vector3

- Defined in math/vec3/Vector3.ts:88
Vector3( 0.0, 0.0, 0.0 )

Returns Vector3

Methods

Protected __new

__new(v: RawVector3): Vector3

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

add

add(...vectors: Vector3[]): Vector3

Inherited from Vector.add
- Defined in math/vec/Vector.ts:74
Add one or more Vector into this.

Parameters
- Rest ...vectors: Vector3[]
  
  Other Vectors
Returns Vector3

applyMatrix4

applyMatrix4(matrix: Matrix4): Vector3

- Defined in math/vec3/Vector3.ts:77
Multiply this vector (with an implicit 1 in the 4th dimension) by m.

Parameters
- matrix: Matrix4
Returns Vector3

applyQuaternion

applyQuaternion(quaternion: Quaternion): Vector3

- Defined in math/vec3/Vector3.ts:70
Rotate this vector using a Quaternion.

Parameters
- quaternion: Quaternion
  
  A quaternion
Returns Vector3

clone

clone(): Vector3

Inherited from Vector.clone
- Defined in math/vec/Vector.ts:66
Clone this.

Returns Vector3

cross

cross(vector: Vector3): Vector3

- Defined in math/vec3/Vector3.ts:62
Return a cross of this and another Vector3.

Parameters
- vector: Vector3
  
  Another vector
Returns Vector3

divide

divide(vector: Vector3): Vector3

Inherited from Vector.divide
- Defined in math/vec/Vector.ts:98
Divide this from another Vector.

Parameters
- vector: Vector3
  
  Another Vector
Returns Vector3

dot

dot(vector: Vector3): number

Inherited from Vector.dot
- Defined in math/vec/Vector.ts:115
Dot two Vectors.

Parameters
- vector: Vector3
  
  Another vector
Returns number

multiply

multiply(...vectors: Vector3[]): Vector3

Inherited from Vector.multiply
- Defined in math/vec/Vector.ts:90
Multiply one or more Vector with this.

Parameters
- Rest ...vectors: Vector3[]
  
  Other Vectors
Returns Vector3

scale

scale(scalar: number): Vector3

Inherited from Vector.scale
- Defined in math/vec/Vector.ts:107
Scale this by scalar. a.k.a. multiplyScalar

Parameters
- scalar: number
  
  A scalar
Returns Vector3

sub

sub(vector: Vector3): Vector3

Inherited from Vector.sub
- Defined in math/vec/Vector.ts:82
Substract this from another Vector.

Parameters
- vector: Vector3
Returns Vector3

toString

toString(): string

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

Static orthoNormalize

orthoNormalize(normal: Vector3, tangent: Vector3, binormal: Vector3): { binormal: Vector3; normal: Vector3; tangent: Vector3 }

- Defined in math/vec3/Vector3.ts:145
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 }
- binormal: Vector3
- normal: Vector3
- tangent: Vector3

Generated using TypeDoc