Class Vector2

Serializable THREE.js Vector2

Hierarchy-Diagram

Legend

class

Hierarchy

Vector2
- Vector2

Constructors

constructor

new Vector2(x?: number, y?: number): Vector2
Parameters
- Optional x: number
- Optional y: number
Returns Vector2
Inherited from THREE.Vector2.constructor
- Defined in src/three/math/Vector2.d.ts:140

Properties

height

height: number

`Readonly` isVector2

isVector2: true

width

width: number

x

x: number

y

y: number

Methods

add

add(v: Vector2, w?: Vector2): Vector2
Adds v to this vector.
Parameters
- v: Vector2
- Optional w: Vector2
Returns Vector2
Inherited from THREE.Vector2.add
- Defined in src/three/math/Vector2.d.ts:198

addScalar

addScalar(s: number): Vector2
Adds the scalar value s to this vector's x and y values.
Parameters
- s: number
Returns Vector2
Inherited from THREE.Vector2.addScalar
- Defined in src/three/math/Vector2.d.ts:203

addScaledVector

addScaledVector(v: Vector2, s: number): Vector2
Adds the multiple of v and s to this vector.
Parameters
- v: Vector2
- s: number
Returns Vector2
Inherited from THREE.Vector2.addScaledVector
- Defined in src/three/math/Vector2.d.ts:213

addVectors

addVectors(a: Vector2, b: Vector2): Vector2
Sets this vector to a + b.
Parameters
- a: Vector2
- b: Vector2
Returns Vector2
Inherited from THREE.Vector2.addVectors
- Defined in src/three/math/Vector2.d.ts:208

angle

angle(): number
computes the angle in radians with respect to the positive x-axis

Returns number
Inherited from THREE.Vector2.angle
- Defined in src/three/math/Vector2.d.ts:355

applyMatrix3

applyMatrix3(m: Matrix3): Vector2
Multiplies this vector (with an implicit 1 as the 3rd component) by m.
Parameters
- m: Matrix3
Returns Vector2
Inherited from THREE.Vector2.applyMatrix3
- Defined in src/three/math/Vector2.d.ts:254

ceil

ceil(): Vector2
The x and y components of the vector are rounded up to the nearest integer value.

Returns Vector2
Inherited from THREE.Vector2.ceil
- Defined in src/three/math/Vector2.d.ts:298

clamp

clamp(min: Vector2, max: Vector2): Vector2
If this vector's x or y value is greater than the max vector's x or y value, it is replaced by the corresponding value. If this vector's x or y value is less than the min vector's x or y value, it is replaced by the corresponding value.
Parameters
- min: Vector2
  
  the minimum x and y values.
- max: Vector2
  
  the maximum x and y values in the desired range.
Returns Vector2
Inherited from THREE.Vector2.clamp
- Defined in src/three/math/Vector2.d.ts:272

clampLength

clampLength(min: number, max: number): Vector2
If this vector's length is greater than the max value, it is replaced by the max value. If this vector's length is less than the min value, it is replaced by the min value.
Parameters
- min: number
  
  the minimum value the length will be clamped to.
- max: number
  
  the maximum value the length will be clamped to.
Returns Vector2
Inherited from THREE.Vector2.clampLength
- Defined in src/three/math/Vector2.d.ts:288

clampScalar

clampScalar(min: number, max: number): Vector2
If this vector's x or y values are greater than the max value, they are replaced by the max value. If this vector's x or y values are less than the min value, they are replaced by the min value.
Parameters
- min: number
  
  the minimum value the components will be clamped to.
- max: number
  
  the maximum value the components will be clamped to.
Returns Vector2
Inherited from THREE.Vector2.clampScalar
- Defined in src/three/math/Vector2.d.ts:280

clone

clone(): Vector2
Returns Vector2
Overrides THREE.Vector2.clone
- Defined in src/utils/math/Vector2.ts:23

copy

copy(v: Vector2): Vector2
Copies value of v to this vector.
Parameters
- v: Vector2
Returns Vector2
Inherited from THREE.Vector2.copy
- Defined in src/three/math/Vector2.d.ts:193

cross

cross(v: Vector2): number
Computes cross product of this vector and v.
Parameters
- v: Vector2
Returns number
Inherited from THREE.Vector2.cross
- Defined in src/three/math/Vector2.d.ts:323

distanceTo

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

distanceToManhattan

distanceToManhattan(v: Vector2): number
Deprecated
Use .manhattanDistanceTo() instead.
Parameters
- v: Vector2
Returns number
Inherited from THREE.Vector2.distanceToManhattan
- Defined in src/three/math/Vector2.d.ts:370

distanceToSquared

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

divide

divide(v: Vector2): Vector2
Divides this vector by v.
Parameters
- v: Vector2
Returns Vector2
Inherited from THREE.Vector2.divide
- Defined in src/three/math/Vector2.d.ts:243

divideScalar

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

dot

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

equals

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

floor

floor(): Vector2
The components of the vector are rounded down to the nearest integer value.

Returns Vector2
Inherited from THREE.Vector2.floor
- Defined in src/three/math/Vector2.d.ts:293

fromArray

fromArray(array: number[] | ArrayLike<number>, offset?: number): Vector2
Sets this vector's x and y 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 Vector2
Inherited from THREE.Vector2.fromArray
- Defined in src/three/math/Vector2.d.ts:409

fromBufferAttribute

fromBufferAttribute(attribute: BufferAttribute, index: number): Vector2
Sets this vector's x and y values from the attribute.
Parameters
- attribute: BufferAttribute
  
  the source attribute.
- index: number
  
  index in the attribute.
Returns Vector2
Inherited from THREE.Vector2.fromBufferAttribute
- Defined in src/three/math/Vector2.d.ts:433

getComponent

getComponent(index: number): number
Gets a component of this vector.
Parameters
- index: number
Returns number
Inherited from THREE.Vector2.getComponent
- Defined in src/three/math/Vector2.d.ts:183

length

length(): number
Computes length of this vector.

Returns number
Inherited from THREE.Vector2.length
- Defined in src/three/math/Vector2.d.ts:333

lengthManhattan

lengthManhattan(): number
Deprecated
Use .manhattanLength() instead.

Returns number
Inherited from THREE.Vector2.lengthManhattan
- Defined in src/three/math/Vector2.d.ts:338

lengthSq

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

Returns number
Inherited from THREE.Vector2.lengthSq
- Defined in src/three/math/Vector2.d.ts:328

lerp

lerp(v: Vector2, alpha: number): Vector2
Linearly interpolates between this vector and v, where alpha is the distance along the line - alpha = 0 will be this vector, and alpha = 1 will be v.
Parameters
- v: Vector2
  
  vector to interpolate towards.
- alpha: number
  
  interpolation factor in the closed interval [0, 1].
Returns Vector2
Inherited from THREE.Vector2.lerp
- Defined in src/three/math/Vector2.d.ts:389

lerpVectors

lerpVectors(v1: Vector2, v2: Vector2, alpha: number): Vector2
Sets this vector to be the vector linearly interpolated between v1 and v2 where alpha is the distance along the line connecting the two vectors - alpha = 0 will be v1, and alpha = 1 will be v2.
Parameters
- v1: Vector2
  
  the starting vector.
- v2: Vector2
  
  vector to interpolate towards.
- alpha: number
  
  interpolation factor in the closed interval [0, 1].
Returns Vector2
Inherited from THREE.Vector2.lerpVectors
- Defined in src/three/math/Vector2.d.ts:397

manhattanDistanceTo

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

see Taxicab Geometry
Parameters
- v: Vector2
Returns number
Inherited from THREE.Vector2.manhattanDistanceTo
- Defined in src/three/math/Vector2.d.ts:377

manhattanLength

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

see Taxicab Geometry

Returns number
Inherited from THREE.Vector2.manhattanLength
- Defined in src/three/math/Vector2.d.ts:345

max

max(v: Vector2): Vector2
If this vector's x or y value is less than v's x or y value, replace that value with the corresponding max value.
Parameters
- v: Vector2
Returns Vector2
Inherited from THREE.Vector2.max
- Defined in src/three/math/Vector2.d.ts:264

min

min(v: Vector2): Vector2
If this vector's x or y value is greater than v's x or y value, replace that value with the corresponding min value.
Parameters
- v: Vector2
Returns Vector2
Inherited from THREE.Vector2.min
- Defined in src/three/math/Vector2.d.ts:259

multiply

multiply(v: Vector2): Vector2
Multiplies this vector by v.
Parameters
- v: Vector2
Returns Vector2
Inherited from THREE.Vector2.multiply
- Defined in src/three/math/Vector2.d.ts:233

multiplyScalar

multiplyScalar(scalar: number): Vector2
Multiplies this vector by scalar s.
Parameters
- scalar: number
Returns Vector2
Inherited from THREE.Vector2.multiplyScalar
- Defined in src/three/math/Vector2.d.ts:238

negate

negate(): Vector2
Inverts this vector.

Returns Vector2
Inherited from THREE.Vector2.negate
- Defined in src/three/math/Vector2.d.ts:313

normalize

normalize(): Vector2
Normalizes this vector.

Returns Vector2
Inherited from THREE.Vector2.normalize
- Defined in src/three/math/Vector2.d.ts:350

random

random(): Vector2
Sets this vector's x and y from Math.random

Returns Vector2
Inherited from THREE.Vector2.random
- Defined in src/three/math/Vector2.d.ts:445

rotateAround

rotateAround(center: Vector2, angle: number): Vector2
Rotates the vector around center by angle radians.
Parameters
- center: Vector2
  
  the point around which to rotate.
- angle: number
  
  the angle to rotate, in radians.
Returns Vector2
Inherited from THREE.Vector2.rotateAround
- Defined in src/three/math/Vector2.d.ts:440

round

round(): Vector2
The components of the vector are rounded to the nearest integer value.

Returns Vector2
Inherited from THREE.Vector2.round
- Defined in src/three/math/Vector2.d.ts:303

roundToZero

roundToZero(): Vector2
The components of the vector are rounded towards zero (up if negative, down if positive) to an integer value.

Returns Vector2
Inherited from THREE.Vector2.roundToZero
- Defined in src/three/math/Vector2.d.ts:308

set

set(x: number, y: number): Vector2
Sets value of this vector.
Parameters
- x: number
- y: number
Returns Vector2
Inherited from THREE.Vector2.set
- Defined in src/three/math/Vector2.d.ts:158

setComponent

setComponent(index: number, value: number): Vector2
Sets a component of this vector.
Parameters
- index: number
- value: number
Returns Vector2
Inherited from THREE.Vector2.setComponent
- Defined in src/three/math/Vector2.d.ts:178

setLength

setLength(length: number): Vector2
Normalizes this vector and multiplies it by l.
Parameters
- length: number
Returns Vector2
Inherited from THREE.Vector2.setLength
- Defined in src/three/math/Vector2.d.ts:382

setScalar

setScalar(scalar: number): Vector2
Sets the x and y values of this vector both equal to scalar.
Parameters
- scalar: number
Returns Vector2
Inherited from THREE.Vector2.setScalar
- Defined in src/three/math/Vector2.d.ts:163

setX

setX(x: number): Vector2
Sets X component of this vector.
Parameters
- x: number
Returns Vector2
Inherited from THREE.Vector2.setX
- Defined in src/three/math/Vector2.d.ts:168

setY

setY(y: number): Vector2
Sets Y component of this vector.
Parameters
- y: number
Returns Vector2
Inherited from THREE.Vector2.setY
- Defined in src/three/math/Vector2.d.ts:173

sub

sub(v: Vector2): Vector2
Subtracts v from this vector.
Parameters
- v: Vector2
Returns Vector2
Inherited from THREE.Vector2.sub
- Defined in src/three/math/Vector2.d.ts:218

subScalar

subScalar(s: number): Vector2
Subtracts s from this vector's x and y components.
Parameters
- s: number
Returns Vector2
Inherited from THREE.Vector2.subScalar
- Defined in src/three/math/Vector2.d.ts:223

subVectors

subVectors(a: Vector2, b: Vector2): Vector2
Sets this vector to a - b.
Parameters
- a: Vector2
- b: Vector2
Returns Vector2
Inherited from THREE.Vector2.subVectors
- Defined in src/three/math/Vector2.d.ts:228

toArray

toArray(array?: number[], offset?: number): number[]
Returns an array [x, y], or copies x and y into the provided array.

Returns
The created or 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[]
Inherited from THREE.Vector2.toArray
- Defined in src/three/math/Vector2.d.ts:417
toArray(array?: Vector2Tuple, offset?: 0): Vector2Tuple
Parameters
- Optional array: Vector2Tuple
- Optional offset: 0
Returns Vector2Tuple
Inherited from THREE.Vector2.toArray
- Defined in src/three/math/Vector2.d.ts:418
toArray(array: ArrayLike<number>, offset?: number): ArrayLike<number>
Copies x and y into the provided array-like.

Returns
The provided array-like.
Parameters
- array: ArrayLike<number>
  
  array-like to store the vector to.
- Optional offset: number
  
  (optional) optional offset into the array.
Returns ArrayLike<number>
Inherited from THREE.Vector2.toArray
- Defined in src/three/math/Vector2.d.ts:426

`Static` fromArray

fromArray(array: number[]): Vector2
Parameters
- array: number[]
Returns Vector2
- Defined in src/utils/math/Vector2.ts:19

Class Vector2

Hierarchy-Diagram

Legend

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional x: number

Optional y: number

Returns Vector2

Properties

height

Readonly isVector2

width

x

y

Methods

add

Parameters

v: Vector2

Optional w: Vector2

Returns Vector2

addScalar

Parameters

s: number

Returns Vector2

addScaledVector

Parameters

v: Vector2

s: number

Returns Vector2

addVectors

Parameters

a: Vector2

b: Vector2

Returns Vector2

angle

Returns number

applyMatrix3

Parameters

m: Matrix3

Returns Vector2

ceil

Returns Vector2

clamp

Parameters

min: Vector2

max: Vector2

Returns Vector2

clampLength

Parameters

min: number

max: number

Returns Vector2

clampScalar

Parameters

min: number

max: number

Returns Vector2

clone

Returns Vector2

copy

Parameters

v: Vector2

Returns Vector2

cross

Parameters

v: Vector2

Returns number

distanceTo

Parameters

v: Vector2

Returns number

distanceToManhattan

Deprecated

Parameters

`Optional` x: number

`Optional` y: number

`Readonly` isVector2

`Optional` w: Vector2

`Optional` offset: number