Update API documentation and remove obsolete plan files

This commit is contained in:
2026-03-21 15:55:04 +08:00
parent 7a6cd412c8
commit 629455df07
75 changed files with 1075 additions and 1816 deletions

View File

@@ -23,31 +23,30 @@ Vector2 是 XCEngine 中的二维向量结构体,用于表示 2D 空间中的
| 方法 | 描述 |
|------|------|
| [`Zero`](Zero.md) | 返回 (0, 0) 零向量 |
| [`One`](One.md) | 返回 (1, 1) 单位向量 |
| [`Up`](Up.md) | 返回 (0, 1) 上方向 |
| [`Down`](Down.md) | 返回 (0, -1) 下方向 |
| [`Right`](Right.md) | 返回 (1, 0) 右方向 |
| [`Left`](Left.md) | 返回 (-1, 0) 左方向 |
| [`Dot`](Dot.md) | 计算两个向量的点积 |
| [`Cross`](Cross.md) | 计算两个向量的叉积(返回标量) |
| [`Normalize`](Normalize.md) | 归一化向量为单位长度 |
| [`Magnitude`](Magnitude.md) | 计算向量长度 |
| [`SqrMagnitude`](SqrMagnitude.md) | 计算向量长度平方 |
| [`Lerp`](Lerp.md) | 线性插值 |
| [`MoveTowards`](MoveTowards.md) | 朝目标移动 |
| [`Magnitude`](Magnitude.md) | 实例方法,计算当前向量长度 |
| [`SqrMagnitude`](SqrMagnitude.md) | 实例方法,计算当前向量长度平方 |
| [`Normalized`](Normalized.md) | 实例方法,返回归一化副本 |
| [`Zero`](zero.md) | 返回 (0, 0) 零向量 |
| [`One`](one.md) | 返回 (1, 1) 单位向量 |
| [`Up`](up.md) | 返回 (0, 1) 上方向 |
| [`Down`](down.md) | 返回 (0, -1) 下方向 |
| [`Right`](right.md) | 返回 (1, 0) 右方向 |
| [`Left`](left.md) | 返回 (-1, 0) 左方向 |
| [`Dot`](dot.md) | 计算两个向量的点积 |
| [`Cross`](cross.md) | 计算两个向量的叉积(返回标量) |
| [`Normalize`](normalize.md) | 归一化向量为单位长度(静态方法) |
| [`Magnitude`](magnitude.md) | 计算向量长度 |
| [`SqrMagnitude`](sqrmagnitude.md) | 计算向量长度平方 |
| [`Lerp`](lerp.md) | 线性插值 |
| [`MoveTowards`](movetowards.md) | 朝目标移动 |
| [`Normalized`](normalized.md) | 实例方法,返回归一化副本 |
## 运算符
| 运算符 | 描述 |
|--------|------|
| `+`, `-` | 向量加减运算 |
| `*`, `/` | 向量与标量乘除运算 |
| `+=`, `-=`, `*=`, `/=` | 复合赋值运算 |
| `==`, `!=` | 相等性比较(基于 EPSILON 浮点比较) |
| [`+`](operator-add.md), [`-`](operator-sub.md) | 向量加减运算 |
| [`*`](operator-mul.md), [`/`](operator-div.md) | 向量与标量乘除运算 |
| [`*=`](operator-mul-assign.md), [`/=`](operator-div-assign.md) | 复合赋值运算 |
| [`+=`](operator-add-assign.md), [`-=`](operator-sub-assign.md) | 复合赋值运算 |
| [`==`](operator-eq.md), [`!=`](operator-neq.md) | 相等性比较(基于 EPSILON 浮点比较) |
## 使用示例