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

@@ -0,0 +1,27 @@
# Vector3::Magnitude
```cpp
float Magnitude() const
```
计算向量的长度(模)。
**返回:** `float` - 向量的长度
**线程安全:**
**复杂度:** O(1)
**示例:**
```cpp
Vector3 v(3.0f, 4.0f, 0.0f);
float mag = v.Magnitude(); // 5.0f
```
## 相关文档
- [Vector3 总览](vector3.md)
- [`SqrMagnitude`](sqrmagnitude.md) - 长度的平方
- [`Normalized`](normalized.md) - 归一化副本
- [`static Magnitude`](magnitude.md) - 静态版本

View File

@@ -0,0 +1,27 @@
# Vector3::Normalized
```cpp
Vector3 Normalized() const
```
返回向量的归一化副本(单位长度为 1 的向量)。不会修改原向量。
**返回:** `Vector3` - 归一化后的向量副本;如果向量长度接近零,则返回零向量
**线程安全:**
**复杂度:** O(1)
**示例:**
```cpp
Vector3 v(3.0f, 4.0f, 0.0f);
Vector3 normalized = v.Normalized(); // (0.6f, 0.8f, 0.0f)
// v 仍然是 (3.0f, 4.0f, 0.0f)
```
## 相关文档
- [Vector3 总览](vector3.md)
- [`static Normalize`](normalize.md) - 静态版本(会修改原向量)
- [`Magnitude`](magnitude-instance.md) - 向量长度

View File

@@ -0,0 +1,27 @@
# Vector3::SqrMagnitude
```cpp
float SqrMagnitude() const
```
计算向量长度的平方。用于在不计算平方根的情况下比较长度,性能更优。
**返回:** `float` - 向量长度的平方
**线程安全:**
**复杂度:** O(1)
**示例:**
```cpp
Vector3 v(3.0f, 4.0f, 0.0f);
float sqrMag = v.SqrMagnitude(); // 25.0f
```
## 相关文档
- [Vector3 总览](vector3.md)
- [`Magnitude`](magnitude-instance.md) - 向量长度
- [`Normalized`](normalized.md) - 归一化副本
- [`static SqrMagnitude`](sqrmagnitude.md) - 静态版本

View File

@@ -51,11 +51,20 @@ Vector3 是 XCEngine 中用于表示三维向量的核心类型,支持常见
|--------|------|
| [`+`](operator_add.md), [`-`](operator_sub.md) | 向量加减 |
| [`*`](operator_mul.md), [`/`](operator_div.md) | 向量与标量或分量相乘/相除 |
| [`+=`](operator_add_assign.md), [`-=`](operator_sub_assign.md) | 复合赋值运算符 |
| [`*=`](operator_mul_assign.md), [`/=`](operator_div_assign.md) | 复合赋值运算符 |
| [`[]`](./operator_index.md) | 下标访问 x, y, z 分量 |
| [`==`](operator_eq.md), [`!=`](operator_neq.md) | 相等性比较 |
| [`* (Quaternion)`](quaternion-multiply.md) | 用四元数旋转向量 |
## 实例方法
| 方法 | 描述 |
|------|------|
| [`Magnitude()`](magnitude-instance.md) | 计算向量长度 |
| [`SqrMagnitude()`](sqrmagnitude-instance.md) | 计算向量长度的平方 |
| [`Normalized()`](normalized-instance.md) | 返回归一化副本 |
## 使用示例
```cpp