Vector2 | Math Library

表示二维的一个向量

Class representing a vector containing 2 coordinates

Hierarchy

Vector2

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new Vector2(x?: number, y?: number): Vector2
new Vector2(point?: Partial<IVec2>): Vector2

- Defined in unit/vector2/index.ts:60
Parameters
- Optional x: number
  
  x value
- Optional y: number
  
  y value
Returns Vector2
- Defined in unit/vector2/index.ts:66
Parameters
- Optional point: Partial<IVec2>
  
  An Object that contains the values x and y
Returns Vector2

Properties

x

x: number = ...

向量的 x 值

The X value of the current vector

default: 0

y

y: number = ...

向量的 y 值

The Y value of the current vector

default: 0

Static Readonly MAX

MAX: Vector2 = ...

Vector2 (Infinity, Infinity)

Static Readonly MIN

MIN: Vector2 = ...

Vector2 (-Infinity, -Infinity)

Static Readonly ONE

ONE: Vector2 = ...

Vector2 (1, 1)

Static X_DIRECTION

X_DIRECTION: Vector2 = ...

X轴正方向

The positive direction of the X-Axis

Static Y_DIRECTION

Y_DIRECTION: Vector2 = ...

Y轴正方向

The positive direction of the Y-Axis

Static Readonly ZERO

ZERO: Vector2 = ...

Vector2 (0, 0)

Accessors

angle

get angle(): number

- Defined in unit/vector2/index.ts:174
向量的角度

Computes the angle in radians with respect to the horizontal left axis

弧度制，范围在 [ 0, 2 * PI )，逆时针为正

Radians in range [ 0, 2 * PI ), counterclockwise

Returns number

length

get length(): number

- Defined in unit/vector2/index.ts:152
向量的长度

Get the length of this vector.

Returns number

lengthSq

get lengthSq(): number

- Defined in unit/vector2/index.ts:161
向量长度的平方

Get the squared length of this vector.

Returns number

Methods

add

add(value: number): Vector2
add(vector: Partial<IVec2>): Vector2

- Defined in unit/vector2/index.ts:189
向量加法

Adds v with the current vector

Parameters
- value: number
  
  a scalar or a vector2
Returns Vector2

A new Vector2
- Defined in unit/vector2/index.ts:190
Parameters
- vector: Partial<IVec2>
Returns Vector2

applyMatrix3

applyMatrix3(matrix: Matrix3): Vector2

- Defined in unit/vector2/index.ts:277
对当前向量应用矩阵

Apply matrix3 to the current vector

Parameters
- matrix: Matrix3
  
  a Matrix3
Returns Vector2

A new Vector2

clone

clone(): Vector2

- Defined in unit/vector2/index.ts:143
复制当前向量

Clones this vector to a new vector

Returns Vector2

新的向量 (A new Vector)

copy

copy(v: Vector2): Vector2

- Defined in unit/vector2/index.ts:133
将向量 v 的值拷贝给当前向量

Copies v to this vector

Parameters
- v: Vector2
Returns Vector2

当前向量 (this vector2)

cross

cross(v: Vector2): number

- Defined in unit/vector2/index.ts:327
叉乘

Computes cross product of the current vector and v

The cross product of Vector2 is just a scalar of z-axis

Parameters
- v: Vector2
Returns number

divide

divide(value: number): Vector2
divide(vector: Partial<IVec2>): Vector2

- Defined in unit/vector2/index.ts:255
向量除法

Divides the current vector by v.

Parameters
- value: number
  
  a scalar or a vector2
Returns Vector2

A new Vector2
- Defined in unit/vector2/index.ts:256
Parameters
- vector: Partial<IVec2>
Returns Vector2

dot

dot(v: Vector2): number

- Defined in unit/vector2/index.ts:316
点乘

Computes dot product of the current vector and v

Parameters
- v: Vector2
Returns number

equals

equals(v: Vector2): boolean

- Defined in unit/vector2/index.ts:336
两个向量是否相等

Determines whether the current vector and v are equal

Parameters
- v: Vector2
Returns boolean

inverse

inverse(): Vector2

- Defined in unit/vector2/index.ts:295
逆向量

Inverse the current vector

Returns Vector2

A new Vector2

isOrthogonal

isOrthogonal(v: Vector2, tolerance?: number): boolean

- Defined in unit/vector2/index.ts:355
两个向量是否正交垂直

Determines whether the current vector and v are orthogonal

Parameters
- v: Vector2
- tolerance: number = ...
Returns boolean

isParallel

isParallel(v: Vector2, tolerance?: number): boolean

- Defined in unit/vector2/index.ts:346
两个向量是否平行

Determines whether the current vector and v are parallel

Parameters
- v: Vector2
- tolerance: number = ...
Returns boolean

multiply

multiply(value: number): Vector2
multiply(vector: Partial<IVec2>): Vector2

- Defined in unit/vector2/index.ts:233
向量乘法

Multiplies the current vector by v.

Parameters
- value: number
  
  a scalar or a vector2
Returns Vector2

A new Vector2
- Defined in unit/vector2/index.ts:234
Parameters
- vector: Partial<IVec2>
Returns Vector2

normalize

normalize(): Vector2

- Defined in unit/vector2/index.ts:307
单位向量

Normalizes the current vector.

Returns Vector2

A new Vector2

set

set(x?: number, y?: number): Vector2
set(point: Partial<IVec2>): Vector2

- Defined in unit/vector2/index.ts:84
设置向量的值

Sets values of this vector

Parameters
- Optional x: number
  
  x value
- Optional y: number
  
  y value
Returns Vector2

当前向量 (this vector2)
- Defined in unit/vector2/index.ts:92
设置向量的值

Sets values of this vector

Parameters
- point: Partial<IVec2>
  
  A Object that contains the values x and y
Returns Vector2

当前向量 (this vector2)

setX

setX(x: number): Vector2

- Defined in unit/vector2/index.ts:111
设置向量的 x 值

Sets the X value of this vector

Parameters
- x: number
Returns Vector2

当前向量 (this vector2)

setY

setY(y: number): Vector2

- Defined in unit/vector2/index.ts:122
设置向量的 y 值

Sets the Y value of this vector

Parameters
- y: number
Returns Vector2

当前向量 (this vector2)

sub

sub(value: number): Vector2
sub(vector: Partial<IVec2>): Vector2

- Defined in unit/vector2/index.ts:211
向量减法

Subtracts v from the current vector

Parameters
- value: number
  
  a scalar or a vector2
Returns Vector2

A new Vector2
- Defined in unit/vector2/index.ts:212
Parameters
- vector: Partial<IVec2>
Returns Vector2

Generated using TypeDoc