Class AngularVelocity

Hierarchy-Diagram

Legend

class

Hierarchy

SensorValue<AngularVelocityUnit>
- AngularVelocity

Index

Constructors

constructor

new AngularVelocity(x?, y?, z?, unit?): AngularVelocity
Parameters
- Optional x: number
- Optional y: number
- Optional z: number
- unit: DerivedUnit = AngularVelocityUnit.RADIAN_PER_SECOND
Returns AngularVelocity
Overrides SensorValue.constructor
- Defined in src/data/values/AngularVelocity.ts:14

Properties

accuracy

accuracy: Accuracy<AngularVelocityUnit, number | Vector3>

`Readonly` isVector3

isVector3: true

timestamp

timestamp: number

unit

unit: AngularVelocityUnit

x

x: number

y

y: number

z

z: number

Methods

[iterator]

[iterator](): Iterator<number, any, undefined>
Iterating through a Vector3 instance will yield its components (x, y, z) in the corresponding order.

Returns Iterator<number, any, undefined>
Inherited from SensorValue.[iterator]
- Defined in src/three/math/Vector3.d.ts:308

add

add(v): AngularVelocity
Adds v to this vector.
Parameters
- v: Vector3
Returns AngularVelocity
Inherited from SensorValue.add
- Defined in src/three/math/Vector3.d.ts:93

addScalar

addScalar(s): AngularVelocity
Parameters
- s: number
Returns AngularVelocity
Inherited from SensorValue.addScalar
- Defined in src/three/math/Vector3.d.ts:95

addScaledVector

addScaledVector(v, s): AngularVelocity
Parameters
- v: Vector3
- s: number
Returns AngularVelocity
Inherited from SensorValue.addScaledVector
- Defined in src/three/math/Vector3.d.ts:97

addVectors

addVectors(a, b): AngularVelocity
Sets this vector to a + b.
Parameters
- a: Vector3
- b: Vector3
Returns AngularVelocity
Inherited from SensorValue.addVectors
- Defined in src/three/math/Vector3.d.ts:102

angleTo

angleTo(v): number
Parameters
- v: Vector3
Returns number
Inherited from SensorValue.angleTo
- Defined in src/three/math/Vector3.d.ts:236

applyAxisAngle

applyAxisAngle(axis, angle): AngularVelocity
Parameters
- axis: Vector3
- angle: number
Returns AngularVelocity
Inherited from SensorValue.applyAxisAngle
- Defined in src/three/math/Vector3.d.ts:127

applyEuler

applyEuler(euler): AngularVelocity
Parameters
- euler: Euler
Returns AngularVelocity
Inherited from SensorValue.applyEuler
- Defined in src/three/math/Vector3.d.ts:125

applyMatrix3

applyMatrix3(m): AngularVelocity
Parameters
- m: Matrix3
Returns AngularVelocity
Inherited from SensorValue.applyMatrix3
- Defined in src/three/math/Vector3.d.ts:129

applyMatrix4

applyMatrix4(m): AngularVelocity
Parameters
- m: Matrix4
Returns AngularVelocity
Inherited from SensorValue.applyMatrix4
- Defined in src/three/math/Vector3.d.ts:133

applyNormalMatrix

applyNormalMatrix(m): AngularVelocity
Parameters
- m: Matrix3
Returns AngularVelocity
Inherited from SensorValue.applyNormalMatrix
- Defined in src/three/math/Vector3.d.ts:131

applyQuaternion

applyQuaternion(q): AngularVelocity
Parameters
- q: Quaternion
Returns AngularVelocity
Inherited from SensorValue.applyQuaternion
- Defined in src/three/math/Vector3.d.ts:135

ceil

ceil(): AngularVelocity
Returns AngularVelocity
Inherited from SensorValue.ceil
- Defined in src/three/math/Vector3.d.ts:163

clamp

clamp(min, max): AngularVelocity
Parameters
- min: Vector3
- max: Vector3
Returns AngularVelocity
Inherited from SensorValue.clamp
- Defined in src/three/math/Vector3.d.ts:155

clampLength

clampLength(min, max): AngularVelocity
Parameters
- min: number
- max: number
Returns AngularVelocity
Inherited from SensorValue.clampLength
- Defined in src/three/math/Vector3.d.ts:159

clampScalar

clampScalar(min, max): AngularVelocity
Parameters
- min: number
- max: number
Returns AngularVelocity
Inherited from SensorValue.clampScalar
- Defined in src/three/math/Vector3.d.ts:157

clone

clone(): AngularVelocity
Returns AngularVelocity
Inherited from SensorValue.clone
- Defined in src/data/values/SensorValue.ts:77

copy

copy(v): AngularVelocity
Copies value of v to this vector.
Parameters
- v: Vector3
Returns AngularVelocity
Inherited from SensorValue.copy
- Defined in src/three/math/Vector3.d.ts:88

cross

cross(a): AngularVelocity
Sets this vector to cross product of itself and v.
Parameters
- a: Vector3
Returns AngularVelocity
Inherited from SensorValue.cross
- Defined in src/three/math/Vector3.d.ts:227

crossVectors

crossVectors(a, b): AngularVelocity
Sets this vector to cross product of a and b.
Parameters
- a: Vector3
- b: Vector3
Returns AngularVelocity
Inherited from SensorValue.crossVectors
- Defined in src/three/math/Vector3.d.ts:232

distanceTo

distanceTo(v): number
Computes distance of this vector to v.
Parameters
- v: Vector3
Returns number
Inherited from SensorValue.distanceTo
- Defined in src/three/math/Vector3.d.ts:241

distanceToManhattan

distanceToManhattan(v): number
Parameters
- v: Vector3
Returns number

Deprecated
Use .manhattanDistanceTo() instead.
Inherited from SensorValue.distanceToManhattan
- Defined in src/three/math/Vector3.d.ts:251

distanceToSquared

distanceToSquared(v): number
Computes squared distance of this vector to v.
Parameters
- v: Vector3
Returns number
Inherited from SensorValue.distanceToSquared
- Defined in src/three/math/Vector3.d.ts:246

divide

divide(v): AngularVelocity
Parameters
- v: Vector3
Returns AngularVelocity
Inherited from SensorValue.divide
- Defined in src/three/math/Vector3.d.ts:143

divideScalar

divideScalar(s): AngularVelocity
Divides this vector by scalar s. Set vector to ( 0, 0, 0 ) if s == 0.
Parameters
- s: number
Returns AngularVelocity
Inherited from SensorValue.divideScalar
- Defined in src/three/math/Vector3.d.ts:149

dot

dot(v): number
Computes dot product of this vector and v.
Parameters
- v: Vector3
Returns number
Inherited from SensorValue.dot
- Defined in src/three/math/Vector3.d.ts:177

equals

equals(v): boolean
Checks for strict equality of this vector and v.
Parameters
- v: Vector3
Returns boolean
Inherited from SensorValue.equals
- Defined in src/three/math/Vector3.d.ts:270

floor

floor(): AngularVelocity
Returns AngularVelocity
Inherited from SensorValue.floor
- Defined in src/three/math/Vector3.d.ts:161

fromArray

fromArray(array, offset?): AngularVelocity
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 AngularVelocity
Inherited from SensorValue.fromArray
- Defined in src/three/math/Vector3.d.ts:277

fromBufferAttribute

fromBufferAttribute(attribute, index): AngularVelocity
Parameters
- attribute: BufferAttribute | InterleavedBufferAttribute
- index: number
Returns AngularVelocity
Inherited from SensorValue.fromBufferAttribute
- Defined in src/three/math/Vector3.d.ts:296

getComponent

getComponent(index): number
Parameters
- index: number
Returns number
Inherited from SensorValue.getComponent
- Defined in src/three/math/Vector3.d.ts:78

length

length(): number
Computes length of this vector.

Returns number
Inherited from SensorValue.length
- Defined in src/three/math/Vector3.d.ts:187

lengthManhattan

lengthManhattan(): number
Computes Manhattan length of this vector. http://en.wikipedia.org/wiki/Taxicab_geometry

Returns number

Deprecated
Use .manhattanLength() instead.
Inherited from SensorValue.lengthManhattan
- Defined in src/three/math/Vector3.d.ts:195

lengthSq

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

Returns number
Inherited from SensorValue.lengthSq
- Defined in src/three/math/Vector3.d.ts:182

lerp

lerp(v, alpha): AngularVelocity
Parameters
- v: Vector3
- alpha: number
Returns AngularVelocity
Inherited from SensorValue.lerp
- Defined in src/three/math/Vector3.d.ts:220

lerpVectors

lerpVectors(v1, v2, alpha): AngularVelocity
Parameters
- v1: Vector3
- v2: Vector3
- alpha: number
Returns AngularVelocity
Inherited from SensorValue.lerpVectors
- Defined in src/three/math/Vector3.d.ts:222

manhattanDistanceTo

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

see Taxicab Geometry
Parameters
- v: Vector3
Returns number
Inherited from SensorValue.manhattanDistanceTo
- Defined in src/three/math/Vector3.d.ts:209

manhattanLength

manhattanLength(): number
Computes the Manhattan length of this vector.

see Taxicab Geometry

Returns number
Inherited from SensorValue.manhattanLength
- Defined in src/three/math/Vector3.d.ts:202

max

max(v): AngularVelocity
Parameters
- v: Vector3
Returns AngularVelocity
Inherited from SensorValue.max
- Defined in src/three/math/Vector3.d.ts:153

min

min(v): AngularVelocity
Parameters
- v: Vector3
Returns AngularVelocity
Inherited from SensorValue.min
- Defined in src/three/math/Vector3.d.ts:151

multiply

multiply(v): AngularVelocity
Parameters
- v: Vector3
Returns AngularVelocity
Inherited from SensorValue.multiply
- Defined in src/three/math/Vector3.d.ts:116

multiplyScalar

multiplyScalar(s): AngularVelocity
Multiplies this vector by scalar s.
Parameters
- s: number
Returns AngularVelocity
Inherited from SensorValue.multiplyScalar
- Defined in src/three/math/Vector3.d.ts:121

multiplyVectors

multiplyVectors(a, b): AngularVelocity
Parameters
- a: Vector3
- b: Vector3
Returns AngularVelocity
Inherited from SensorValue.multiplyVectors
- Defined in src/three/math/Vector3.d.ts:123

negate

negate(): AngularVelocity
Inverts this vector.

Returns AngularVelocity
Inherited from SensorValue.negate
- Defined in src/three/math/Vector3.d.ts:172

normalize

normalize(): AngularVelocity
Normalizes this vector.

Returns AngularVelocity
Inherited from SensorValue.normalize
- Defined in src/three/math/Vector3.d.ts:214

project

project(camera): AngularVelocity
Parameters
- camera: Camera
Returns AngularVelocity
Inherited from SensorValue.project
- Defined in src/three/math/Vector3.d.ts:137

projectOnPlane

projectOnPlane(planeNormal): AngularVelocity
Parameters
- planeNormal: Vector3
Returns AngularVelocity
Inherited from SensorValue.projectOnPlane
- Defined in src/three/math/Vector3.d.ts:234

projectOnVector

projectOnVector(v): AngularVelocity
Parameters
- v: Vector3
Returns AngularVelocity
Inherited from SensorValue.projectOnVector
- Defined in src/three/math/Vector3.d.ts:233

random

random(): AngularVelocity
Sets this vector's x, y and z from Math.random

Returns AngularVelocity
Inherited from SensorValue.random
- Defined in src/three/math/Vector3.d.ts:301

randomDirection

randomDirection(): AngularVelocity
Returns AngularVelocity
Inherited from SensorValue.randomDirection
- Defined in src/three/math/Vector3.d.ts:303

reflect

reflect(vector): AngularVelocity
Parameters
- vector: Vector3
Returns AngularVelocity
Inherited from SensorValue.reflect
- Defined in src/three/math/Vector3.d.ts:235

round

round(): AngularVelocity
Returns AngularVelocity
Inherited from SensorValue.round
- Defined in src/three/math/Vector3.d.ts:165

roundToZero

roundToZero(): AngularVelocity
Returns AngularVelocity
Inherited from SensorValue.roundToZero
- Defined in src/three/math/Vector3.d.ts:167

set

set(x, y, z): AngularVelocity
Sets value of this vector.
Parameters
- x: number
- y: number
- z: number
Returns AngularVelocity
Inherited from SensorValue.set
- Defined in src/three/math/Vector3.d.ts:48

setAccuracy

setAccuracy(accuracy): AngularVelocity
Set the accuracy of the absolute position
Parameters
- accuracy: number | Accuracy<AngularVelocityUnit, number | Vector3>
  
  Accuracy object or number
Returns AngularVelocity
instance
Inherited from SensorValue.setAccuracy
- Defined in src/data/values/SensorValue.ts:55

setComponent

setComponent(index, value): AngularVelocity
Parameters
- index: number
- value: number
Returns AngularVelocity
Inherited from SensorValue.setComponent
- Defined in src/three/math/Vector3.d.ts:70

setFromColor

setFromColor(color): AngularVelocity
Sets this vector's x, y and z components from the r, g, and b components of the specified Color | color.
Parameters
- color: Color
Returns AngularVelocity
Inherited from SensorValue.setFromColor
- Defined in src/three/math/Vector3.d.ts:76

setFromCylindrical

setFromCylindrical(s): AngularVelocity
Parameters
- s: Cylindrical
Returns AngularVelocity
Inherited from SensorValue.setFromCylindrical
- Defined in src/three/math/Vector3.d.ts:255

setFromCylindricalCoords

setFromCylindricalCoords(radius, theta, y): AngularVelocity
Parameters
- radius: number
- theta: number
- y: number
Returns AngularVelocity
Inherited from SensorValue.setFromCylindricalCoords
- Defined in src/three/math/Vector3.d.ts:256

setFromEuler

setFromEuler(e): AngularVelocity
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 AngularVelocity
Inherited from SensorValue.setFromEuler
- Defined in src/three/math/Vector3.d.ts:265

setFromMatrix3Column

setFromMatrix3Column(matrix, index): AngularVelocity
Parameters
- matrix: Matrix3
- index: number
Returns AngularVelocity
Inherited from SensorValue.setFromMatrix3Column
- Defined in src/three/math/Vector3.d.ts:260

setFromMatrixColumn

setFromMatrixColumn(matrix, index): AngularVelocity
Parameters
- matrix: Matrix4
- index: number
Returns AngularVelocity
Inherited from SensorValue.setFromMatrixColumn
- Defined in src/three/math/Vector3.d.ts:259

setFromMatrixPosition

setFromMatrixPosition(m): AngularVelocity
Parameters
- m: Matrix4
Returns AngularVelocity
Inherited from SensorValue.setFromMatrixPosition
- Defined in src/three/math/Vector3.d.ts:257

setFromMatrixScale

setFromMatrixScale(m): AngularVelocity
Parameters
- m: Matrix4
Returns AngularVelocity
Inherited from SensorValue.setFromMatrixScale
- Defined in src/three/math/Vector3.d.ts:258

setFromSpherical

setFromSpherical(s): AngularVelocity
Parameters
- s: Spherical
Returns AngularVelocity
Inherited from SensorValue.setFromSpherical
- Defined in src/three/math/Vector3.d.ts:253

setFromSphericalCoords

setFromSphericalCoords(r, phi, theta): AngularVelocity
Parameters
- r: number
- phi: number
- theta: number
Returns AngularVelocity
Inherited from SensorValue.setFromSphericalCoords
- Defined in src/three/math/Vector3.d.ts:254

setLength

setLength(l): AngularVelocity
Normalizes this vector and multiplies it by l.
Parameters
- l: number
Returns AngularVelocity
Inherited from SensorValue.setLength
- Defined in src/three/math/Vector3.d.ts:219

setScalar

setScalar(scalar): AngularVelocity
Sets all values of this vector.
Parameters
- scalar: number
Returns AngularVelocity
Inherited from SensorValue.setScalar
- Defined in src/three/math/Vector3.d.ts:53

setX

setX(x): Vector3
Sets x value of this vector.
Parameters
- x: number
Returns Vector3
Inherited from SensorValue.setX
- Defined in src/three/math/Vector3.d.ts:58

setY

setY(y): Vector3
Sets y value of this vector.
Parameters
- y: number
Returns Vector3
Inherited from SensorValue.setY
- Defined in src/three/math/Vector3.d.ts:63

setZ

setZ(z): Vector3
Sets z value of this vector.
Parameters
- z: number
Returns Vector3
Inherited from SensorValue.setZ
- Defined in src/three/math/Vector3.d.ts:68

sub

sub(a): AngularVelocity
Subtracts v from this vector.
Parameters
- a: Vector3
Returns AngularVelocity
Inherited from SensorValue.sub
- Defined in src/three/math/Vector3.d.ts:107

subScalar

subScalar(s): AngularVelocity
Parameters
- s: number
Returns AngularVelocity
Inherited from SensorValue.subScalar
- Defined in src/three/math/Vector3.d.ts:109

subVectors

subVectors(a, b): AngularVelocity
Sets this vector to a - b.
Parameters
- a: Vector3
- b: Vector3
Returns AngularVelocity
Inherited from SensorValue.subVectors
- Defined in src/three/math/Vector3.d.ts:114

toArray

toArray(array?, offset?): 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.
Inherited from SensorValue.toArray
- Defined in src/three/math/Vector3.d.ts:285
toArray(array?, offset?): Vector3Tuple
Parameters
- Optional array: Vector3Tuple
- Optional offset: 0
Returns Vector3Tuple
Inherited from SensorValue.toArray
- Defined in src/three/math/Vector3.d.ts:286
toArray(array, offset?): ArrayLike<number>
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.
Inherited from SensorValue.toArray
- Defined in src/three/math/Vector3.d.ts:294

toTuple

toTuple(unit?): Vector3Tuple
Convert sensor value to tuple
Parameters
- Optional unit: AngularVelocityUnit
  
  Conversion unit
Returns Vector3Tuple
Tuple of three numbers
Inherited from SensorValue.toTuple
- Defined in src/data/values/SensorValue.ts:69

transformDirection

transformDirection(m): AngularVelocity
Parameters
- m: Matrix4
Returns AngularVelocity
Inherited from SensorValue.transformDirection
- Defined in src/three/math/Vector3.d.ts:141

unproject

unproject(camera): AngularVelocity
Parameters
- camera: Camera
Returns AngularVelocity
Inherited from SensorValue.unproject
- Defined in src/three/math/Vector3.d.ts:139

`Static` fromArray

fromArray<T>(this, array, unit?): T
Type Parameters
- T extends Vector3
Parameters
- this: (new (...args) => T)
  - - new (...args): T
    - Parameters
      
      Rest ...args: any[]
      
      Returns T
- array: number[]
- unit: AngularVelocityUnit = AngularVelocityUnit.RADIAN_PER_SECOND
Returns T
Overrides SensorValue.fromArray
- Defined in src/data/values/AngularVelocity.ts:18

`Static` fromVector

fromVector<T>(this, vector): T
Type Parameters
- T extends Vector3
Parameters
- this: (new (...args) => T)
  - - new (...args): T
    - Parameters
      
      Rest ...args: any[]
      
      Returns T
- vector: Vector3
Returns T
Inherited from SensorValue.fromVector
- Defined in src/utils/math/Vector3.ts:28

Class AngularVelocity

Hierarchy-Diagram

Legend

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional x: number

Optional y: number

Optional z: number

unit: DerivedUnit = AngularVelocityUnit.RADIAN_PER_SECOND

Returns AngularVelocity

Properties

accuracy

Readonly isVector3

timestamp

unit

x

y

z

Methods

[iterator]

Returns Iterator<number, any, undefined>

add

Parameters

v: Vector3

Returns AngularVelocity

addScalar

Parameters

s: number

Returns AngularVelocity

addScaledVector

Parameters

v: Vector3

s: number

Returns AngularVelocity

addVectors

Parameters

a: Vector3

b: Vector3

Returns AngularVelocity

angleTo

Parameters

v: Vector3

Returns number

applyAxisAngle

Parameters

axis: Vector3

angle: number

Returns AngularVelocity

applyEuler

Parameters

euler: Euler

Returns AngularVelocity

applyMatrix3

Parameters

m: Matrix3

Returns AngularVelocity

applyMatrix4

Parameters

m: Matrix4

Returns AngularVelocity

applyNormalMatrix

Parameters

m: Matrix3

Returns AngularVelocity

applyQuaternion

Parameters

q: Quaternion

Returns AngularVelocity

ceil

Returns AngularVelocity

clamp

Parameters

min: Vector3

max: Vector3

`Optional` x: number

`Optional` y: number

`Optional` z: number

`Readonly` isVector3

`Optional` offset: number