Class Vector2

constructor

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

  Creates a new empty vec2

  Parameters

  • x: number = 0

    X component

  • y: number = 0

    Y component

  Returns Vector2

className

elements

isVector2

x

• get x(): number

  X component

  Returns number

• set x(value: number): void

  X component

  Parameters

  • value: number

  Returns void

y

• get y(): number

  Y component

  Returns number

• set y(value: number): void

  Y component

  Parameters

  • value: number

  Returns void

add

• add(a: Vector2, b?: Vector2): this

  Adds two vec2's

  Parameters

  • a: Vector2
  • Optionalb: Vector2

    如果不传，计算 this 和 a 的和

  Returns this

  this

ceil

• ceil(): this

  Math.ceil the components of this

  Returns this

  this

clone

• clone(): Vector2

  Creates a new vec2 initialized with values from this vector

  Returns Vector2

  a new Vector2

copy

• copy(v: Vector2): this

  Copy the values from one vec2 to this

  Parameters

  • v: Vector2

    the source vector

  Returns this

  this

cross

• cross(a: Vector2, b?: Vector2): this

  Computes the cross product of two vec2's

  Parameters

  • a: Vector2
  • Optionalb: Vector2

    如果不传，计算 this 和 a 的结果

  Returns this

  cross product of a and b

dist

• dist(a: Vector2, b?: Vector2): number

  Parameters

  • a: Vector2
  • Optionalb: Vector2

  Returns number

distance

• distance(a: Vector2, b?: Vector2): number

  Calculates the euclidian distance between two vec2's

  Parameters

  • a: Vector2
  • Optionalb: Vector2

    如果不传，计算 this 和 a 的结果

  Returns number

  distance between a and b

div

• div(a: Vector2, b?: Vector2): this

  Parameters

  • a: Vector2
  • Optionalb: Vector2

  Returns this

divide

• divide(a: Vector2, b?: Vector2): this

  Divides two vec2's

  Parameters

  • a: Vector2
  • Optionalb: Vector2

    如果不传，计算 this 和 a 的商

  Returns this

  this

dot

• dot(a: Vector2, b?: Vector2): number

  Calculates the dot product of two vec2's

  Parameters

  • a: Vector2
  • Optionalb: Vector2

    如果不传，计算 this 和 a 的结果

  Returns number

  product of a and b

equals

• equals(a: Vector2, b?: Vector2): boolean

  Returns whether or not the vectors have approximately the same elements in the same position.

  Parameters

  • a: Vector2
  • Optionalb: Vector2

    如果不传，计算 this 和 a 的结果

  Returns boolean

  True if the vectors are equal, false otherwise.

exactEquals

• exactEquals(a: Vector2, b?: Vector2): boolean

  Returns whether or not the vectors have exactly the same elements in the same position (when compared with ===)

  Parameters

  • a: Vector2
  • Optionalb: Vector2

    如果不传，计算 this 和 a 的结果

  Returns boolean

  True if the vectors are equal, false otherwise.

floor

• floor(): this

  Math.floor the components of this

  Returns this

  this

fromArray

• fromArray(array: ArrayLike<number>, offset?: number): this

  从数组赋值

  Parameters

  • array: ArrayLike<number>

    数组

  • offset: number = 0

    数组偏移值

  Returns this

  this

inverse

• inverse(a?: Vector2): this

  Returns the inverse of the components of a vec2

  Parameters

  • Optionala: Vector2

  Returns this

  this

len

• len(): number

  Returns number

length

• length(): number

  Calculates the length of this

  Returns number

  length of this

lerp

• lerp(v: Vector2, t: number): this

  Performs a linear interpolation between two vec2's

  Parameters

  • v: Vector2
  • t: number

    interpolation amount between the two vectors

  Returns this

  this

max

• max(a: Vector2, b?: Vector2): this

  Returns the maximum of two vec2's

  Parameters

  • a: Vector2
  • Optionalb: Vector2

    如果不传，计算 this 和 a 的结果

  Returns this

  this

min

• min(a: Vector2, b?: Vector2): this

  Returns the minimum of two vec2's

  Parameters

  • a: Vector2
  • Optionalb: Vector2

    如果不传，计算 this 和 a 的结果

  Returns this

  this

mul

• mul(a: Vector2, b?: Vector2): this

  Parameters

  • a: Vector2
  • Optionalb: Vector2

  Returns this

multiply

• multiply(a: Vector2, b?: Vector2): this

  Multiplies two vec2's

  Parameters

  • a: Vector2
  • Optionalb: Vector2

    如果不传，计算 this 和 a 的积

  Returns this

  this

negate

• negate(): this

  Negates the components of this

  Returns this

  this

normalize

• normalize(): this

  Normalize this

  Returns this

  this

random

• random(scale?: number): this

  Generates a random vector with the given scale

  Parameters

  • Optionalscale: number

    Length of the resulting vector. If ommitted, a unit vector will be returned

  Returns this

  this

round

• round(): this

  Math.round the components of this

  Returns this

  this

scale

• scale(scale: number): this

  Scales this by a scalar number

  Parameters

  • scale: number

    amount to scale the vector by

  Returns this

  this

scaleAndAdd

• scaleAndAdd(scale: number, a: Vector2, b?: Vector2): this

  Adds two vec2's after scaling the second vector by a scalar value

  Parameters

  • scale: number

    the amount to scale the second vector by before adding

  • a: Vector2
  • Optionalb: Vector2

    如果不传，计算 this 和 a 的结果

  Returns this

  this

set

• set(x: number, y: number): this

  Set the components of a vec4 to the given values

  Parameters

  • x: number

    X component

  • y: number

    Y component

  Returns this

  this

sqrDist

• sqrDist(a: Vector2, b?: Vector2): number

  Parameters

  • a: Vector2
  • Optionalb: Vector2

  Returns number

sqrLen

• sqrLen(): number

  Returns number

squaredDistance

• squaredDistance(a: Vector2, b?: Vector2): number

  Calculates the squared euclidian distance between two vec2's

  Parameters

  • a: Vector2
  • Optionalb: Vector2

    如果不传，计算 this 和 a 的结果

  Returns number

  squared distance between a and b

squaredLength

• squaredLength(): number

  Calculates the squared length of this

  Returns number

  squared length of this

sub

• sub(a: Vector2, b?: Vector2): this

  Parameters

  • a: Vector2
  • Optionalb: Vector2

  Returns this

subtract

• subtract(a: Vector2, b?: Vector2): this

  Subtracts vector b from vector a

  Parameters

  • a: Vector2
  • Optionalb: Vector2

    如果不传，计算 this 和 a 的差

  Returns this

  this

toArray

• toArray(array?: MutableNumberArray, offset?: number): MutableNumberArray

  转换到数组

  Parameters

  • array: MutableNumberArray = []

    数组

  • offset: number = 0

    数组偏移值

  Returns MutableNumberArray

transformMat3

• transformMat3(m: Matrix3): this

  Transforms the vec2 with a mat3

  Parameters

  • m: Matrix3

    matrix to transform with

  Returns this

  this

transformMat4

• transformMat4(m: Matrix4): this

  Transforms the vec2 with a mat4

  Parameters

  • m: Matrix4

    matrix to transform with

  Returns this

  this