Class Vector2

constructor

• new Vector2(x?, y?): Vector2

• Parameters

  • x: number = 0

  • y: number = 0

  Returns Vector2

Readonly isVector2

x

y

height

• get height(): number

• Returns number

• set height(value): void

• Parameters

  • value: number

  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

• Parameters

  • value: number

  Returns void

add

• add(v): Vector2

• Parameters

  • v: Vector2

  Returns Vector2

addScalar

• addScalar(s): Vector2

• Parameters

  • s: number

  Returns Vector2

addScaledVector

• addScaledVector(v, s): Vector2

• Parameters

  • v: Vector2

  • s: number

  Returns Vector2

addVectors

• addVectors(a, b): Vector2

• Parameters

  • a: Vector2

  • b: Vector2

  Returns Vector2

added

• added(v): Vector2

• Parameters

  • v: Vector2

  Returns Vector2

angle

• angle(v?): number

• The angle in [0, PI]

  Parameters

  • Optional v: Vector2

  Returns number

angleTo

• angleTo(v): number

• The angle in [0, 2PI)

  Parameters

  • v: Vector2

  Returns number

applyMatrix3

• applyMatrix3(m): Vector2

• Parameters

  • m: Matrix3

  Returns Vector2

ceil

• ceil(): Vector2

• Returns Vector2

clamp

• clamp(min, max): Vector2

• Parameters

  • min: Vector2

  • max: Vector2

  Returns Vector2

clampLength

• clampLength(min, max): Vector2

• Parameters

  • min: number

  • max: number

  Returns Vector2

clampScalar

• clampScalar(minVal, maxVal): Vector2

• Parameters

  • minVal: number

  • maxVal: number

  Returns Vector2

clone

• clone(): Vector2

• Returns Vector2

copy

• copy(v): Vector2

• Parameters

  • v: Vector2

  Returns Vector2

cross

• cross(v): number

• Parameters

  • v: Vector2

  Returns number

distanceTo

• distanceTo(v): number

• Parameters

  • v: Vector2

  Returns number

distanceToSquared

• distanceToSquared(v): number

• Parameters

  • v: Vector2

  Returns number

divide

• divide(v): Vector2

• Parameters

  • v: Vector2

  Returns Vector2

divideScalar

• divideScalar(scalar): Vector2

• Parameters

  • scalar: number

  Returns Vector2

dot

• dot(v): number

• Parameters

  • v: Vector2

  Returns number

equals

• equals(v, distTol?, cosTol?): boolean

• Parameters

  • v: Vector2

  • distTol: number = Tolerance.global.distTol

  • cosTol: number = Tolerance.global.cosTol

  Returns boolean

floor

• floor(): Vector2

• Returns Vector2

fromArray

• fromArray(array, offset?): Vector2

• Parameters

  • array: ArrayLike<number> | number[]

  • offset: number = 0

  Returns Vector2

getComponent

• getComponent(index): number

• Parameters

  • index: number

  Returns number

isOpposite

• isOpposite(vec, tol?, checkZeroVec?): boolean

• Parameters

  • vec: Vector2

  • Optional tol: Tolerance

  • checkZeroVec: boolean = true

  Returns boolean

isParallel

• isParallel(vec, tol?, checkZeroVec?): boolean

• 是否平行

  Parameters

  • vec: Vector2

  • Optional tol: Tolerance

  • checkZeroVec: boolean = true

  Returns boolean

isPerpendicular

• isPerpendicular(vec, tol?, checkZeroVec?): boolean

• 是否垂直

  Parameters

  • vec: Vector2

  • Optional tol: Tolerance

  • checkZeroVec: boolean = true

  Returns boolean

isSameDirection

• isSameDirection(v, tol?, checkZeroVec?): boolean

• Parameters

  • v: Vector2

  • Optional tol: Tolerance

  • checkZeroVec: boolean = true

  Returns boolean

isZero

• isZero(distTol?): boolean

• Parameters

  • distTol: number = Tolerance.global.distTol

  Returns boolean

lerp

• lerp(v, alpha): Vector2

• Parameters

  • v: Vector2

  • alpha: number

  Returns Vector2

lerpVectors

• lerpVectors(v1, v2, alpha): Vector2

• Parameters

  • v1: Vector2

  • v2: Vector2

  • alpha: number

  Returns Vector2

manhattanDistanceTo

• manhattanDistanceTo(v): number

• Parameters

  • v: Vector2

  Returns number

max

• max(v): Vector2

• Parameters

  • v: Vector2

  Returns Vector2

min

• min(v): Vector2

• Parameters

  • v: Vector2

  Returns Vector2

multiplied

• multiplied(scale): Vector2

• Return a new vector which is the scaler result of this vector.

  Parameters

  • scale: number

  Returns Vector2

multiply

• multiply(v): Vector2

• Parameters

  • v: Vector2

  Returns Vector2

multiplyScalar

• multiplyScalar(scalar): Vector2

• Parameters

  • scalar: number

  Returns Vector2

negate

• negate(): Vector2

• Returns Vector2

normalize

• normalize(): Vector2

• Returns Vector2

normalized

• normalized(): Vector2

• 返回单位向量

  Returns Vector2

random

• random(): Vector2

• Returns Vector2

reverse

• reverse(): Vector2

• Returns Vector2

reversed

• reversed(): Vector2

• Returns Vector2

rotateAround

• rotateAround(center, angle): Vector2

• Parameters

  • center: Vector2

  • angle: number

  Returns Vector2

round

• round(): Vector2

• Returns Vector2

roundToZero

• roundToZero(): Vector2

• Returns Vector2

set

• set(x, y): Vector2

• Parameters

  • x: number

  • y: number

  Returns Vector2

setComponent

• setComponent(index, value): Vector2

• Parameters

  • index: number

  • value: number

  Returns Vector2

setLength

• setLength(length): Vector2

• Parameters

  • length: number

  Returns Vector2

setScalar

• setScalar(scalar): Vector2

• Parameters

  • scalar: number

  Returns Vector2

setX

• setX(x): Vector2

• Parameters

  • x: number

  Returns Vector2

setY

• setY(y): Vector2

• Parameters

  • y: number

  Returns Vector2

sub

• sub(v): Vector2

• Parameters

  • v: Vector2

  Returns Vector2

subScalar

• subScalar(s): Vector2

• Parameters

  • s: number

  Returns Vector2

subVectors

• subVectors(a, b): Vector2

• Parameters

  • a: Vector2

  • b: Vector2

  Returns Vector2

subtracted

• subtracted(v): Vector2

• Parameters

  • v: Vector2

  Returns Vector2

toArray

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

• Parameters

  • array: number[] = []

  • offset: number = 0

  Returns number[]

toVector3

• toVector3(): Vector3

• Returns Vector3

Static fromObject

• fromObject(obj): Vector2

• Parameters

  • obj: {
        x: number;
        y: number;
    }

    • x: number

    • y: number

  Returns Vector2