Class Vector3

Index

Constructors

Properties

isVector3 x y z

Accessors

length lengthSq manhattanLength

Methods

Constructors

constructor

new Vector3(x?, y?, z?): Vector3
Parameters
- x: number = 0
- y: number = 0
- z: number = 0
Returns Vector3
- Defined in packages/math/src/base/Vector3.ts:21

Properties

`Readonly` isVector3

isVector3: boolean

x

x: number

y

y: number

z

z: number

Accessors

length

get length(): number
Returns number
- Defined in packages/math/src/base/Vector3.ts:413

lengthSq

get lengthSq(): number
Returns number
- Defined in packages/math/src/base/Vector3.ts:409

manhattanLength

get manhattanLength(): number
Returns number
- Defined in packages/math/src/base/Vector3.ts:417

Methods

add

add(v): Vector3
Parameters
- v: Vector3
Returns Vector3
- Defined in packages/math/src/base/Vector3.ts:96

addScalar

addScalar(s): Vector3
Parameters
- s: number
Returns Vector3
- Defined in packages/math/src/base/Vector3.ts:108

addScaledVector

addScaledVector(v, s): Vector3
Parameters
- v: Vector3
- s: number
Returns Vector3
- Defined in packages/math/src/base/Vector3.ts:124

addVectors

addVectors(a, b): Vector3
Parameters
- a: Vector3
- b: Vector3
Returns Vector3
- Defined in packages/math/src/base/Vector3.ts:116

added

added(v): Vector3
Parameters
- v: Vector3
Returns Vector3
- Defined in packages/math/src/base/Vector3.ts:104

angle

angle(v): number
The angle in [0, PI]
Parameters
- v: Vector3
Returns number
- Defined in packages/math/src/base/Vector3.ts:531

angleTo

angleTo(v, vecRef): number
The angle in [0, 2PI)
Parameters
- v: Vector3
- vecRef: Vector3
Returns number
- Defined in packages/math/src/base/Vector3.ts:538

appliedEuler

appliedEuler(euler): Vector3
Parameters
- euler: Euler
Returns Vector3
- Defined in packages/math/src/base/Vector3.ts:192

appliedMatrix4

appliedMatrix4(m): Vector3
Parameters
- m: Matrix4
Returns Vector3
- Defined in packages/math/src/base/Vector3.ts:231

appliedQuaternion

appliedQuaternion(q): Vector3
Parameters
- q: Quaternion
Returns Vector3
- Defined in packages/math/src/base/Vector3.ts:271

applyAxisAngle

applyAxisAngle(axis, angle): Vector3
Parameters
- axis: Vector3
- angle: number
Returns Vector3
- Defined in packages/math/src/base/Vector3.ts:196

applyEuler

applyEuler(euler): Vector3
Parameters
- euler: Euler
Returns Vector3
- Defined in packages/math/src/base/Vector3.ts:188

applyMatrix3

applyMatrix3(m): Vector3
Parameters
- m: Matrix3
Returns Vector3
- Defined in packages/math/src/base/Vector3.ts:200

applyMatrix4

applyMatrix4(m): Vector3
Parameters
- m: Matrix4
Returns Vector3
- Defined in packages/math/src/base/Vector3.ts:217

applyNormalMatrix

applyNormalMatrix(m): Vector3
Parameters
- m: Matrix3
Returns Vector3
- Defined in packages/math/src/base/Vector3.ts:213

applyQuaternion

applyQuaternion(q): Vector3
Parameters
- q: Quaternion
Returns Vector3
- Defined in packages/math/src/base/Vector3.ts:246

ceil

ceil(): Vector3
Returns Vector3
- Defined in packages/math/src/base/Vector3.ts:371

clamp

clamp(min, max): Vector3
Parameters
- min: Vector3
- max: Vector3
Returns Vector3
- Defined in packages/math/src/base/Vector3.ts:339

clampLength

clampLength(min, max): Vector3
Parameters
- min: number
- max: number
Returns Vector3
- Defined in packages/math/src/base/Vector3.ts:357

clampScalar

clampScalar(minVal, maxVal): Vector3
Parameters
- minVal: number
- maxVal: number
Returns Vector3
- Defined in packages/math/src/base/Vector3.ts:349

clone

clone(): Vector3
Returns Vector3
- Defined in packages/math/src/base/Vector3.ts:84

copy

copy(v): Vector3
Parameters
- v: Vector3
Returns Vector3
- Defined in packages/math/src/base/Vector3.ts:88

cross

cross(v): Vector3
Parameters
- v: Vector3
Returns Vector3
- Defined in packages/math/src/base/Vector3.ts:477

crossVectors

crossVectors(a, b): Vector3
Parameters
- a: Vector3
- b: Vector3
Returns Vector3
- Defined in packages/math/src/base/Vector3.ts:489

crossed

crossed(vec): Vector3
Parameters
- vec: Vector3
Returns Vector3
- Defined in packages/math/src/base/Vector3.ts:481

distanceTo

distanceTo(v): number
Parameters
- v: Vector3
Returns number
- Defined in packages/math/src/base/Vector3.ts:549

distanceToSquared

distanceToSquared(v): number
Parameters
- v: Vector3
Returns number
- Defined in packages/math/src/base/Vector3.ts:553

divide

divide(v): Vector3
Parameters
- v: Vector3
Returns Vector3
- Defined in packages/math/src/base/Vector3.ts:311

divideScalar

divideScalar(scalar): Vector3
Parameters
- scalar: number
Returns Vector3
- Defined in packages/math/src/base/Vector3.ts:319

dot

dot(v): number
Parameters
- v: Vector3
Returns number
- Defined in packages/math/src/base/Vector3.ts:403

equals

equals(v, distTol?, cosTol?): boolean
Parameters
- v: Vector3
- distTol: number = Tolerance.global.distTol
- cosTol: number = Tolerance.global.cosTol
Returns boolean
- Defined in packages/math/src/base/Vector3.ts:594

floor

floor(): Vector3
Returns Vector3
- Defined in packages/math/src/base/Vector3.ts:363

fromArray

fromArray(array, offset?): Vector3
Parameters
- array: ArrayLike<number> | number[]
- offset: number = 0
Returns Vector3
- Defined in packages/math/src/base/Vector3.ts:666

getComponent

getComponent(index): number
Parameters
- index: number
Returns number
- Defined in packages/math/src/base/Vector3.ts:75

isOpposite

isOpposite(vec, tol?, checkZeroVec?): boolean
Parameters
- vec: Vector3
- Optional tol: Tolerance
- checkZeroVec: boolean = true
Returns boolean
- Defined in packages/math/src/base/Vector3.ts:648

isParallel

isParallel(vec, tol?, checkZeroVec?): boolean
Parameters
- vec: Vector3
- Optional tol: Tolerance
- checkZeroVec: boolean = true
Returns boolean
- Defined in packages/math/src/base/Vector3.ts:620

isPerpendicular

isPerpendicular(vec, tol?, checkZeroVec?): boolean
Parameters
- vec: Vector3
- Optional tol: Tolerance
- checkZeroVec: boolean = true
Returns boolean
- Defined in packages/math/src/base/Vector3.ts:605

isSameDirection

isSameDirection(vec, tol?, checkZeroVec?): boolean
Parameters
- vec: Vector3
- Optional tol: Tolerance
- checkZeroVec: boolean = true
Returns boolean
- Defined in packages/math/src/base/Vector3.ts:634

isZero

isZero(distTol?): boolean
Parameters
- distTol: number = Tolerance.global.distTol
Returns boolean
- Defined in packages/math/src/base/Vector3.ts:662

lerp

lerp(v, alpha): Vector3
Parameters
- v: Vector3
- alpha: number
Returns Vector3
- Defined in packages/math/src/base/Vector3.ts:457

lerpVectors

lerpVectors(v1, v2, alpha): Vector3
Parameters
- v1: Vector3
- v2: Vector3
- alpha: number
Returns Vector3
- Defined in packages/math/src/base/Vector3.ts:465

manhattanDistanceTo

manhattanDistanceTo(v): number
Parameters
- v: Vector3
Returns number
- Defined in packages/math/src/base/Vector3.ts:560

max

max(v): Vector3
Parameters
- v: Vector3
Returns Vector3
- Defined in packages/math/src/base/Vector3.ts:331

min

min(v): Vector3
Parameters
- v: Vector3
Returns Vector3
- Defined in packages/math/src/base/Vector3.ts:323

multiplied

multiplied(v): Vector3
Parameters
- v: Vector3
Returns Vector3
- Defined in packages/math/src/base/Vector3.ts:168

multiply

multiply(v): Vector3
Parameters
- v: Vector3
Returns Vector3
- Defined in packages/math/src/base/Vector3.ts:160

multiplyScalar

multiplyScalar(scalar): Vector3
Parameters
- scalar: number
Returns Vector3
- Defined in packages/math/src/base/Vector3.ts:172

multiplyVectors

multiplyVectors(a, b): Vector3
Parameters
- a: Vector3
- b: Vector3
Returns Vector3
- Defined in packages/math/src/base/Vector3.ts:180

negate

negate(): Vector3
Returns Vector3
- Defined in packages/math/src/base/Vector3.ts:395

normalize

normalize(): Vector3
Returns Vector3
- Defined in packages/math/src/base/Vector3.ts:421

normalized

normalized(): Vector3
Returns Vector3
- Defined in packages/math/src/base/Vector3.ts:425

projectOnPlane

projectOnPlane(planeNormal): Vector3
Parameters
- planeNormal: Vector3
Returns Vector3
- Defined in packages/math/src/base/Vector3.ts:512

projectOnVector

projectOnVector(v): Vector3
Parameters
- v: Vector3
Returns Vector3
- Defined in packages/math/src/base/Vector3.ts:502

random

random(): Vector3
Returns Vector3
- Defined in packages/math/src/base/Vector3.ts:682

reflect

reflect(normal): Vector3
Parameters
- normal: Vector3
Returns Vector3
- Defined in packages/math/src/base/Vector3.ts:520

reverse

reverse(): Vector3
Returns Vector3
- Defined in packages/math/src/base/Vector3.ts:441

reversed

reversed(): Vector3
Returns Vector3
- Defined in packages/math/src/base/Vector3.ts:449

round

round(): Vector3
Returns Vector3
- Defined in packages/math/src/base/Vector3.ts:379

roundToZero

roundToZero(): Vector3
Returns Vector3
- Defined in packages/math/src/base/Vector3.ts:387

set

set(x, y, z): Vector3
Parameters
- x: number
- y: number
- z: number
Returns Vector3
- Defined in packages/math/src/base/Vector3.ts:28

setComponent

setComponent(index, value): Vector3
Parameters
- index: number
- value: number
Returns Vector3
- Defined in packages/math/src/base/Vector3.ts:64

setFromMatrix3Column

setFromMatrix3Column(m, index): Vector3
Parameters
- m: Matrix3
- index: number
Returns Vector3
- Defined in packages/math/src/base/Vector3.ts:590

setFromMatrixColumn

setFromMatrixColumn(m, index): Vector3
Parameters
- m: Matrix4
- index: number
Returns Vector3
- Defined in packages/math/src/base/Vector3.ts:586

setFromMatrixPosition

setFromMatrixPosition(m): Vector3
Parameters
- m: Matrix4
Returns Vector3
- Defined in packages/math/src/base/Vector3.ts:564

setFromMatrixScale

setFromMatrixScale(m): Vector3
Parameters
- m: Matrix4
Returns Vector3
- Defined in packages/math/src/base/Vector3.ts:574

setLength

setLength(length): Vector3
Parameters
- length: number
Returns Vector3
- Defined in packages/math/src/base/Vector3.ts:453

setScalar

setScalar(scalar): Vector3
Parameters
- scalar: number
Returns Vector3
- Defined in packages/math/src/base/Vector3.ts:38

setX

setX(x): Vector3
Parameters
- x: number
Returns Vector3
- Defined in packages/math/src/base/Vector3.ts:46

setY

setY(y): Vector3
Parameters
- y: number
Returns Vector3
- Defined in packages/math/src/base/Vector3.ts:52

setZ

setZ(z): Vector3
Parameters
- z: number
Returns Vector3
- Defined in packages/math/src/base/Vector3.ts:58

sub

sub(v): Vector3
Parameters
- v: Vector3
Returns Vector3
- Defined in packages/math/src/base/Vector3.ts:132

subScalar

subScalar(s): Vector3
Parameters
- s: number
Returns Vector3
- Defined in packages/math/src/base/Vector3.ts:144

subVectors

subVectors(a, b): Vector3
Parameters
- a: Vector3
- b: Vector3
Returns Vector3
- Defined in packages/math/src/base/Vector3.ts:152

subtracted

subtracted(v): Vector3
Parameters
- v: Vector3
Returns Vector3
- Defined in packages/math/src/base/Vector3.ts:140

toArray

toArray(array?, offset?): number[]
Parameters
- array: number[] = []
- offset: number = 0
Returns number[]
- Defined in packages/math/src/base/Vector3.ts:674

toVector2

toVector2(): Vector2
Returns Vector2
- Defined in packages/math/src/base/Vector3.ts:473

transformDirection

transformDirection(m): Vector3
Parameters
- m: Matrix4
Returns Vector3
- Defined in packages/math/src/base/Vector3.ts:296

`Static` fromObject

fromObject(obj): Vector3
Parameters
- obj: {
      x: number;
      y: number;
      z?: number;
  }
  - x: number
  - y: number
  - Optional z?: number
Returns Vector3
- Defined in packages/math/src/base/Vector3.ts:12

Generated using TypeDoc