Class Vector2

Hierarchy

Vector2

Index

Constructors

constructor

Properties

ONE
ZERO

Accessors

x
y

Methods

Constructors

constructor

new Vector2(raw?: Float32Array, offset?: number): Vector2

- Defined in src/engine/math/vector2.ts:64
Parameters
- Optional raw: Float32Array
- Optional offset: number
Returns Vector2

Properties

Static Readonly ONE

ONE: DeepImmutableObject<Vector2>

一向量，不要对该对象进行修改

readonly
static
memberof: Vector3

Static Readonly ZERO

ZERO: DeepImmutableObject<Vector2>

零向量，不要对该对象进行修改

readonly
static
memberof: Vector3

Accessors

x

get x(): number
set x(val: number): void

- Defined in src/engine/math/vector2.ts:20
x值

memberof

Vector2

Returns number
- Defined in src/engine/math/vector2.ts:23
x值

Parameters
- val: number
Returns void

y

get y(): number
set y(val: number): void

- Defined in src/engine/math/vector2.ts:33
y值

memberof

Vector2

Returns number
- Defined in src/engine/math/vector2.ts:36
y值

Parameters
- val: number
Returns void

Methods

add

add(v: DeepImmutableObject<Vector2>, dst?: Vector2): Vector2

- Defined in src/engine/math/vector2.ts:177
向量加法

memberof

Vector2

Parameters
- v: DeepImmutableObject<Vector2>
  
  目标向量
- Optional dst: Vector2
Returns Vector2

计算结果

clone

clone(): Vector2

- Defined in src/engine/math/vector2.ts:272
拷贝该向量

memberof

Vector2

Returns Vector2

拷贝出来的对象

dot

dot(v: DeepImmutableObject<Vector2>): number

- Defined in src/engine/math/vector2.ts:254
向量点乘

memberof

Vector2

Parameters
- v: DeepImmutableObject<Vector2>
  
  目标向量
Returns number

计算结果

equal

equal(v: DeepImmutableObject<Vector2>): boolean

- Defined in src/engine/math/vector2.ts:134
判断与目标向量的值是否相等

memberof

Vector2

Parameters
- v: DeepImmutableObject<Vector2>
  
  目标向量
Returns boolean

是否相等，这里误差小于10^-6视为相等

getAngle

getAngle(): number

- Defined in src/engine/math/vector2.ts:290
获取向量旋转角，以角度表示

memberof

Vector2

Returns number

旋转角，以角度表示

isZero

isZero(): boolean

- Defined in src/engine/math/vector2.ts:281
是否为零向量

memberof

Vector2

Returns boolean

length

length(): number

- Defined in src/engine/math/vector2.ts:263
向量的模

memberof

Vector2

Returns number

计算结果

lerp

lerp(v: DeepImmutableObject<Vector2>, f: number, dst?: Vector2): Vector2

- Defined in src/engine/math/vector2.ts:231
在该向量与目标向量之间计算插值

memberof

Vector2

Parameters
- v: DeepImmutableObject<Vector2>
  
  目标向量
- f: number
  
  插值系数
- Optional dst: Vector2
Returns Vector2

计算结果

negate

negate(): Vector2

- Defined in src/engine/math/vector2.ts:241
取反

Returns Vector2

normalize

normalize(dst?: Vector2): Vector2

- Defined in src/engine/math/vector2.ts:203
向量归一化，如该向量为零向量，则结果依然为零向量

memberof

Vector2

Parameters
- Optional dst: Vector2
Returns Vector2

计算结果

scale

scale(f: number, dst?: Vector2): Vector2

- Defined in src/engine/math/vector2.ts:217
向量缩放

memberof

Vector2

Parameters
- f: number
  
  缩放比
- Optional dst: Vector2
Returns Vector2

计算结果

set

set(val: DeepImmutableObject<Vector2>): Vector2

- Defined in src/engine/math/vector2.ts:145
拷贝目标向量的值到该向量

memberof

Vector2

Parameters
- val: DeepImmutableObject<Vector2>
  
  目标向量
Returns Vector2

自身

setValue

setValue(x: number, y: number): Vector2

- Defined in src/engine/math/vector2.ts:164
设置向量的值

memberof

Vector2

Parameters
- x: number
  
  x值
- y: number
  
  y值
Returns Vector2

自身

sub

sub(v: DeepImmutableObject<Vector2>, dst?: Vector2): Vector2

- Defined in src/engine/math/vector2.ts:190
向量减法

memberof

Vector2

Parameters
- v: DeepImmutableObject<Vector2>
  
  目标向量
- Optional dst: Vector2
Returns Vector2

计算结果

toArray

toArray(): number[]

- Defined in src/engine/math/vector2.ts:123
返回向量数据

memberof

Vector2

Returns number[]

矩阵数据，以JSArray返回

Static createFromArray

createFromArray(array: number[]): Vector2

- Defined in src/engine/math/vector2.ts:94
使用一个数组创建
此操作会拷贝一份数组

static

memberof

Vector2

Parameters
- array: number[]
  
  数据源，长度必须为2，否则会抛出异常
Returns Vector2

创建出来的向量

Static createFromNumber

createFromNumber(x: number, y: number): Vector2

- Defined in src/engine/math/vector2.ts:79
使用数值创建
推荐使用这种方式代替new Vector2

static

memberof

Vector2

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

创建出来的向量

Static createFromTypedArray

createFromTypedArray(array: Float32Array, offset?: number): Vector2

- Defined in src/engine/math/vector2.ts:110
使用某个已有的typedArray创建
此操作不会拷贝数据，而是在原来的内存区域上操作

static

memberof

Vector2

Parameters
- array: Float32Array
  
  数据源
- offset: number = 0
Returns Vector2

创建出来的向量

Generated using TypeDoc