Class SensorValue<U>

ReadonlyisVector3

x

0
Copy

y

0
Copy

z

0
Copy

[iterator]

• "[iterator]"(): Iterator<number>

  Iterating through a Vector3 instance will yield its components (x, y, z) in the corresponding order.

  Returns Iterator<number>

add

• add(v: Vector3Like): this

  Adds v to this vector.

  Parameters

  • v: Vector3Like

  Returns this

addScalar

• addScalar(s: number): this

  Parameters

  • s: number

  Returns this

addScaledVector

• addScaledVector(v: Vector3, s: number): this

  Parameters

  • v: Vector3
  • s: number

  Returns this

addVectors

• addVectors(a: Vector3Like, b: Vector3Like): this

  Sets this vector to a + b.

  Parameters

  • a: Vector3Like
  • b: Vector3Like

  Returns this

angleTo

• angleTo(v: Vector3): number

  Parameters

  • v: Vector3

  Returns number

applyAxisAngle

• applyAxisAngle(axis: Vector3, angle: number): this

  Parameters

  • axis: Vector3
  • angle: number

  Returns this

applyEuler

• applyEuler(euler: Euler): this

  Parameters

  • euler: Euler

  Returns this

applyMatrix3

• applyMatrix3(m: Matrix3): this

  Parameters

  • m: Matrix3

  Returns this

applyMatrix4

• applyMatrix4(m: Matrix4): this

  Parameters

  • m: Matrix4

  Returns this

applyNormalMatrix

• applyNormalMatrix(m: Matrix3): this

  Parameters

  • m: Matrix3

  Returns this

applyQuaternion

• applyQuaternion(q: QuaternionLike): this

  Parameters

  • q: QuaternionLike

  Returns this

ceil

• ceil(): this

  Returns this

clamp

• clamp(min: Vector3Like, max: Vector3Like): this

  Parameters

  • min: Vector3Like
  • max: Vector3Like

  Returns this

clampLength

• clampLength(min: number, max: number): this

  Parameters

  • min: number
  • max: number

  Returns this

clampScalar

• clampScalar(min: number, max: number): this

  Parameters

  • min: number
  • max: number

  Returns this

copy

• copy(v: Vector3Like): this

  Copies value of v to this vector.

  Parameters

  • v: Vector3Like

  Returns this

cross

• cross(a: Vector3Like): this

  Sets this vector to cross product of itself and v.

  Parameters

  • a: Vector3Like

  Returns this

crossVectors

• crossVectors(a: Vector3Like, b: Vector3Like): this

  Sets this vector to cross product of a and b.

  Parameters

  • a: Vector3Like
  • b: Vector3Like

  Returns this

distanceTo

• distanceTo(v: Vector3Like): number

  Computes distance of this vector to v.

  Parameters

  • v: Vector3Like

  Returns number

distanceToSquared

• distanceToSquared(v: Vector3Like): number

  Computes squared distance of this vector to v.

  Parameters

  • v: Vector3Like

  Returns number

divide

• divide(v: Vector3Like): this

  Parameters

  • v: Vector3Like

  Returns this

divideScalar

• divideScalar(s: number): this

  Divides this vector by scalar s. Set vector to ( 0, 0, 0 ) if s == 0.

  Parameters

  • s: number

  Returns this

dot

• dot(v: Vector3Like): number

  Computes dot product of this vector and v.

  Parameters

  • v: Vector3Like

  Returns number

equals

• equals(v: Vector3Like): boolean

  Checks for strict equality of this vector and v.

  Parameters

  • v: Vector3Like

  Returns boolean

floor

• floor(): this

  Returns this

fromArray

• fromArray(array: number[] | ArrayLike<number>, offset?: number): this

  Sets this vector's x, y and z value from the provided array or array-like.

  Parameters

  • array: number[] | ArrayLike<number>

    the source array or array-like.

  • Optionaloffset: number

    (optional) offset into the array. Default is 0.

  Returns this

fromBufferAttribute

• fromBufferAttribute(
      attribute: BufferAttribute | InterleavedBufferAttribute,
      index: number,
  ): this

  Parameters

  • attribute: BufferAttribute | InterleavedBufferAttribute
  • index: number

  Returns this

getComponent

• getComponent(index: number): number

  Parameters

  • index: number

  Returns number

length

• length(): number

  Computes length of this vector.

  Returns number

lengthSq

• lengthSq(): number

  Computes squared length of this vector.

  Returns number

lerp

• lerp(v: Vector3Like, alpha: number): this

  Parameters

  • v: Vector3Like
  • alpha: number

  Returns this

lerpVectors

• lerpVectors(v1: Vector3Like, v2: Vector3Like, alpha: number): this

  Parameters

  • v1: Vector3Like
  • v2: Vector3Like
  • alpha: number

  Returns this

manhattanDistanceTo

• manhattanDistanceTo(v: Vector3Like): number

  Computes the Manhattan length (distance) from this vector to the given vector v

  see Taxicab Geometry

  Parameters

  • v: Vector3Like

  Returns number

manhattanLength

• manhattanLength(): number

  Computes the Manhattan length of this vector.

  see Taxicab Geometry

  Returns number

max

• max(v: Vector3Like): this

  Parameters

  • v: Vector3Like

  Returns this

min

• min(v: Vector3Like): this

  Parameters

  • v: Vector3Like

  Returns this

multiply

• multiply(v: Vector3Like): this

  Parameters

  • v: Vector3Like

  Returns this

multiplyScalar

• multiplyScalar(s: number): this

  Multiplies this vector by scalar s.

  Parameters

  • s: number

  Returns this

multiplyVectors

• multiplyVectors(a: Vector3Like, b: Vector3Like): this

  Parameters

  • a: Vector3Like
  • b: Vector3Like

  Returns this

negate

• negate(): this

  Inverts this vector.

  Returns this

normalize

• normalize(): this

  Normalizes this vector.

  Returns this

project

• project(camera: Camera): this

  Parameters

  • camera: Camera

  Returns this

projectOnPlane

• projectOnPlane(planeNormal: Vector3): this

  Parameters

  • planeNormal: Vector3

  Returns this

projectOnVector

• projectOnVector(v: Vector3): this

  Parameters

  • v: Vector3

  Returns this

random

• random(): this

  Sets this vector's x, y and z from Math.random

  Returns this

randomDirection

• randomDirection(): this

  Returns this

reflect

• reflect(vector: Vector3Like): this

  Parameters

  • vector: Vector3Like

  Returns this

round

• round(): this

  Returns this

roundToZero

• roundToZero(): this

  Returns this

set

• set(x: number, y: number, z: number): this

  Sets value of this vector.

  Parameters

  • x: number
  • y: number
  • z: number

  Returns this

setComponent

• setComponent(index: number, value: number): this

  Parameters

  • index: number
  • value: number

  Returns this

setFromColor

• setFromColor(color: RGB): this

  Sets this vector's x, y and z components from the r, g, and b components of the specified Color | color.

  Parameters

  • color: RGB

  Returns this

setFromCylindrical

• setFromCylindrical(s: Cylindrical): this

  Parameters

  • s: Cylindrical

  Returns this

setFromCylindricalCoords

• setFromCylindricalCoords(radius: number, theta: number, y: number): this

  Parameters

  • radius: number
  • theta: number
  • y: number

  Returns this

setFromEuler

• setFromEuler(e: Euler): this

  Sets this vector's x, y and z components from the x, y, and z components of the specified Euler Angle.

  Parameters

  • e: Euler

  Returns this

setFromMatrix3Column

• setFromMatrix3Column(matrix: Matrix3, index: number): this

  Parameters

  • matrix: Matrix3
  • index: number

  Returns this

setFromMatrixColumn

• setFromMatrixColumn(matrix: Matrix4, index: number): this

  Parameters

  • matrix: Matrix4
  • index: number

  Returns this

setFromMatrixPosition

• setFromMatrixPosition(m: Matrix4): this

  Parameters

  • m: Matrix4

  Returns this

setFromMatrixScale

• setFromMatrixScale(m: Matrix4): this

  Parameters

  • m: Matrix4

  Returns this

setFromSpherical

• setFromSpherical(s: Spherical): this

  Parameters

  • s: Spherical

  Returns this

setFromSphericalCoords

• setFromSphericalCoords(r: number, phi: number, theta: number): this

  Parameters

  • r: number
  • phi: number
  • theta: number

  Returns this

setLength

• setLength(l: number): this

  Normalizes this vector and multiplies it by l.

  Parameters

  • l: number

  Returns this

setScalar

• setScalar(scalar: number): this

  Sets all values of this vector.

  Parameters

  • scalar: number

  Returns this

setX

• setX(x: number): this

  Sets x value of this vector.

  Parameters

  • x: number

  Returns this

setY

• setY(y: number): this

  Sets y value of this vector.

  Parameters

  • y: number

  Returns this

setZ

• setZ(z: number): this

  Sets z value of this vector.

  Parameters

  • z: number

  Returns this

sub

• sub(a: Vector3Like): this

  Subtracts v from this vector.

  Parameters

  • a: Vector3Like

  Returns this

subScalar

• subScalar(s: number): this

  Parameters

  • s: number

  Returns this

subVectors

• subVectors(a: Vector3Like, b: Vector3Like): this

  Sets this vector to a - b.

  Parameters

  • a: Vector3Like
  • b: Vector3Like

  Returns this

toArray

• toArray(array?: number[], offset?: number): number[]

  Returns an array [x, y, z], or copies x, y and z into the provided array.

  Parameters

  • Optionalarray: number[]

    (optional) array to store the vector to. If this is not provided, a new array will be created.

  • Optionaloffset: number

    (optional) optional offset into the array.

  Returns number[]

  The created or provided array.

• toArray(array?: Vector3Tuple, offset?: 0): Vector3Tuple

  Returns an array [x, y, z], or copies x, y and z into the provided array.

  Parameters

  • Optionalarray: Vector3Tuple

    (optional) array to store the vector to. If this is not provided, a new array will be created.

  • Optionaloffset: 0

    (optional) optional offset into the array.

  Returns Vector3Tuple

  The created or provided array.

• toArray(array: ArrayLike<number>, offset?: number): ArrayLike<number>

  Copies x, y and z into the provided array-like.

  Parameters

  • array: ArrayLike<number>

    array-like to store the vector to.

  • Optionaloffset: number

    (optional) optional offset into the array-like.

  Returns ArrayLike<number>

  The provided array-like.

transformDirection

• transformDirection(m: Matrix4): this

  Parameters

  • m: Matrix4

  Returns this

unproject

• unproject(camera: Camera): this

  Parameters

  • camera: Camera

  Returns this

StaticfromArray

• fromArray<T extends Vector3>(
      this: new (...args: any[]) => T,
      array: number[],
  ): T

  Type Parameters

  • T extends Vector3

  Parameters

  • this: new (...args: any[]) => T
  • array: number[]

  Returns T

StaticfromVector

• fromVector<T extends Vector3>(
      this: new (...args: any[]) => T,
      vector: Vector3,
  ): T

  Type Parameters

  • T extends Vector3

  Parameters

  • this: new (...args: any[]) => T
  • vector: Vector3

  Returns T