Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Absolute3DPosition

Absolute cartesian 3D position. This class extends a Vector3. This location can be used both as an absolute location or relative location.

Hierarchy

Implements

Index

Constructors

constructor

  • Parameters

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

    Returns Absolute3DPosition

Properties

accuracy

accuracy: number

Position accuracy

Readonly isVector3

isVector3: true

orientation

orientation: Orientation

Orientation at recorded position

referenceSpaceUID

referenceSpaceUID: string

Position reference space UID

timestamp

timestamp: number = ...

Position recording timestamp

unit

unit: LengthUnit = ...

Position unit

velocity

velocity: Velocity = ...

Velocity at recorded position

deprecated

use linearVelocity and angularVelocity instead

x

x: number

y

y: number

z

z: number

Accessors

angularVelocity

linearVelocity

Methods

add

  • Adds v to this vector.

    Parameters

    • v: Vector3

    Returns Absolute3DPosition

addScalar

addScaledVector

addVectors

  • Sets this vector to a + b.

    Parameters

    • a: Vector3
    • b: Vector3

    Returns Absolute3DPosition

angleTo

applyAxisAngle

applyEuler

applyMatrix3

applyMatrix4

applyNormalMatrix

applyQuaternion

ceil

clamp

clampLength

clampScalar

clone

copy

  • Copies value of v to this vector.

    Parameters

    • v: Vector3

    Returns Absolute3DPosition

cross

  • Sets this vector to cross product of itself and v.

    Parameters

    • a: Vector3

    Returns Absolute3DPosition

crossVectors

  • Sets this vector to cross product of a and b.

    Parameters

    • a: Vector3
    • b: Vector3

    Returns Absolute3DPosition

distanceTo

distanceToManhattan

  • distanceToManhattan(v: Vector3): number
  • deprecated

    Use {@link Vector3#manhattanDistanceTo .manhattanDistanceTo()} instead.

    Parameters

    • v: Vector3

    Returns number

distanceToSquared

  • distanceToSquared(v: Vector3): number
  • Computes squared distance of this vector to v.

    Parameters

    • v: Vector3

    Returns number

divide

divideScalar

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

    Parameters

    • s: number

    Returns Absolute3DPosition

dot

  • dot(v: Vector3): number
  • Computes dot product of this vector and v.

    Parameters

    • v: Vector3

    Returns number

equals

floor

fromArray

  • 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.

    • Optional offset: number

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

    Returns Absolute3DPosition

fromBufferAttribute

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

fromVector

getComponent

  • getComponent(index: number): number
  • Parameters

    • index: number

    Returns number

length

  • length(): number
  • Computes length of this vector.

    Returns number

lengthManhattan

  • lengthManhattan(): number

lengthSq

  • lengthSq(): number
  • Computes squared length of this vector.

    Returns number

lerp

  • Parameters

    • v: Vector3
    • alpha: number

    Returns Absolute3DPosition

lerpVectors

manhattanDistanceTo

  • manhattanDistanceTo(v: Vector3): number

manhattanLength

  • manhattanLength(): number

max

min

multiply

multiplyScalar

multiplyVectors

negate

normalize

project

projectOnPlane

projectOnVector

random

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

    Returns Absolute3DPosition

reflect

round

roundToZero

set

  • Sets value of this vector.

    Parameters

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

    Returns Absolute3DPosition

setComponent

setFromCylindrical

setFromCylindricalCoords

setFromMatrix3Column

setFromMatrixColumn

setFromMatrixPosition

setFromMatrixScale

setFromSpherical

setFromSphericalCoords

setLength

  • Normalizes this vector and multiplies it by l.

    Parameters

    • l: number

    Returns Absolute3DPosition

setScalar

  • Sets all values of this vector.

    Parameters

    • scalar: number

    Returns Absolute3DPosition

setX

  • setX(x: number): Vector3
  • Sets x value of this vector.

    Parameters

    • x: number

    Returns Vector3

setY

  • setY(y: number): Vector3
  • Sets y value of this vector.

    Parameters

    • y: number

    Returns Vector3

setZ

  • setZ(z: number): Vector3
  • Sets z value of this vector.

    Parameters

    • z: number

    Returns Vector3

sub

  • Subtracts v from this vector.

    Parameters

    • a: Vector3

    Returns Absolute3DPosition

subScalar

subVectors

  • Sets this vector to a - b.

    Parameters

    • a: Vector3
    • b: Vector3

    Returns Absolute3DPosition

toArray

  • toArray(array?: number[], offset?: number): number[]
  • toArray(array?: Vector3Tuple, offset?: 0): Vector3Tuple
  • toArray(array: ArrayLike<number>, offset?: number): ArrayLike<number>
  • Returns an array [x, y, z], or copies x, y and z into the provided array.

    Parameters

    • Optional array: number[]

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

    • Optional offset: number

      (optional) optional offset into the array.

    Returns number[]

    The created or provided array.

  • Parameters

    • Optional array: Vector3Tuple
    • Optional offset: 0

    Returns Vector3Tuple

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

    Parameters

    • array: ArrayLike<number>

      array-like to store the vector to.

    • Optional offset: number

      (optional) optional offset into the array-like.

    Returns ArrayLike<number>

    The provided array-like.

toVector3

transformDirection

unproject

Static fromArray

  • fromArray(array: number[]): Vector3