Constructors
constructor
- new Vector2(x?, y?): Vector2
Parameters
Optional
x: number
Optional
y: number
Properties
Readonly
isVector2
isVector2: boolean
x
x: number
y
y: number
Accessors
height
- get height(): number
Returns number
- set height(value): void
Returns void
length
- get length(): number
Returns number
lengthSq
- get lengthSq(): number
Returns number
manhattanLength
- get manhattanLength(): number
Returns number
width
- get width(): number
Returns number
- set width(value): void
Returns void
Methods
add
- add(v): Vector2
addScalar
- addScalar(s): Vector2
addScaledVector
- addScaledVector(v, s): Vector2
addVectors
- addVectors(a, b): Vector2
added
- added(v): Vector2
angle
- angle(v?): number
Returns number
angleTo
- angleTo(v): number
Returns number
applyMatrix3
- applyMatrix3(m): Vector2
ceil
- ceil(): Vector2
clamp
- clamp(min, max): Vector2
clampLength
- clampLength(min, max): Vector2
clampScalar
- clampScalar(minVal, maxVal): Vector2
Parameters
minVal: number
maxVal: number
clone
- clone(): Vector2
copy
- copy(v): Vector2
cross
- cross(v): number
Returns number
distanceTo
- distanceTo(v): number
Returns number
distanceToSquared
- distanceToSquared(v): number
Returns number
divide
- divide(v): Vector2
divideScalar
- divideScalar(scalar): Vector2
dot
- dot(v): number
Returns number
equals
- equals(v, distTol?, cosTol?): boolean
Parameters
Optional
distTol: number
Optional
cosTol: number
Returns boolean
floor
- floor(): Vector2
fromArray
- fromArray(array, offset?): Vector2
Parameters
array: ArrayLike<number> | number[]
Optional
offset: number
getComponent
- getComponent(index): number
Returns number
isOpposite
- isOpposite(vec, tol?, checkZeroVec?): boolean
Parameters
Optional
checkZeroVec: boolean
Returns boolean
isParallel
- isParallel(vec, tol?, checkZeroVec?): boolean
Parameters
Optional
checkZeroVec: boolean
Returns boolean
isPerpendicular
- isPerpendicular(vec, tol?, checkZeroVec?): boolean
Parameters
Optional
checkZeroVec: boolean
Returns boolean
isSameDirection
- isSameDirection(v, tol?, checkZeroVec?): boolean
Parameters
Optional
checkZeroVec: boolean
Returns boolean
isZero
- isZero(distTol?): boolean
Returns boolean
lerp
- lerp(v, alpha): Vector2
lerpVectors
- lerpVectors(v1, v2, alpha): Vector2
manhattanDistanceTo
- manhattanDistanceTo(v): number
Returns number
max
- max(v): Vector2
min
- min(v): Vector2
multiplied
- multiplied(scale): Vector2
multiply
- multiply(v): Vector2
multiplyScalar
- multiplyScalar(scalar): Vector2
negate
- negate(): Vector2
normalize
- normalize(): Vector2
normalized
- normalized(): Vector2
random
- random(): Vector2
reverse
- reverse(): Vector2
reversed
- reversed(): Vector2
rotateAround
- rotateAround(center, angle): Vector2
round
- round(): Vector2
roundToZero
- roundToZero(): Vector2
set
- set(x, y): Vector2
setComponent
- setComponent(index, value): Vector2
Parameters
index: number
value: number
setLength
- setLength(length): Vector2
setScalar
- setScalar(scalar): Vector2
setX
- setX(x): Vector2
setY
- setY(y): Vector2
sub
- sub(v): Vector2
subScalar
- subScalar(s): Vector2
subVectors
- subVectors(a, b): Vector2
subtracted
- subtracted(v): Vector2
toArray
- toArray(array?, offset?): number[]
Parameters
Optional
array: number[]
Optional
offset: number
Returns number[]
toVector3
- toVector3(): Vector3
Static
fromObject
- fromObject(obj): Vector2
Parameters
obj: {
x: number;
y: number;
}
The angle in [0, PI]