docs: 重构 API 文档结构并修正源码准确性

- 重组文档目录结构: 每个模块的概述页移动到模块子目录
- 重命名 index.md 为 main.md
- 修正所有模块文档中的错误:
  - math: FromEuler→FromEulerAngles, TransformDirection 包含缩放, Box 是 OBB, Color::ToRGBA 格式
  - containers: 新增 operator==/!= 文档, 补充 std::hash DJB 算法细节
  - core: 修复 types 链接错误
  - debug: LogLevelToString 返回大写, timestamp 是秒, Profiler 空实现标注, Windows API vs ANSI
  - memory: 修复头文件路径, malloc vs operator new, 新增方法文档
  - resources: 修复 Shader/Texture 链接错误
  - threading: TaskSystem::Wait 空实现标注, ReadWriteLock 重入描述, LambdaTask 链接
- 验证: fix_links.py 确认 0 个断裂引用
This commit is contained in:
2026-03-19 00:22:30 +08:00
parent d0e16962c8
commit dc850d7739
1012 changed files with 26673 additions and 9222 deletions

View File

@@ -0,0 +1,22 @@
# Plane::FromPoints
```cpp
static Plane FromPoints(const Vector3& a, const Vector3& b, const Vector3& c)
```
从三个不共线点创建平面。
**参数:**
- `a` - 第一个点
- `b` - 第二个点
- `c` - 第三个点
**返回:** `Plane` - 由三点定义的平面
**复杂度:** O(1)
**示例:**
```cpp
Plane plane = Plane::FromPoints(p0, p1, p2);
```

View File

@@ -0,0 +1,20 @@
# Plane::GetClosestPoint
```cpp
Vector3 GetClosestPoint(const Vector3& point) const
```
计算平面上最接近给定点的点。
**参数:**
- `point` - 参考点
**返回:** `Vector3` - 平面上最接近的点
**复杂度:** O(1)
**示例:**
```cpp
Vector3 closest = plane.GetClosestPoint(point);
```

View File

@@ -0,0 +1,20 @@
# Plane::GetDistanceToPoint
```cpp
float GetDistanceToPoint(const Vector3& point) const
```
计算点到平面的有符号距离。
**参数:**
- `point` - 要计算的点
**返回:** `float` - 有符号距离
**复杂度:** O(1)
**示例:**
```cpp
float dist = plane.GetDistanceToPoint(point);
```

View File

@@ -0,0 +1,20 @@
# Plane::GetSide
```cpp
bool GetSide(const Vector3& point) const
```
判断点在平面的哪一侧。
**参数:**
- `point` - 要测试的点
**返回:** `bool` - true 表示点在法线方向一侧
**复杂度:** O(1)
**示例:**
```cpp
if (plane.GetSide(point)) { /* point is on normal side */ }
```

View File

@@ -0,0 +1,20 @@
# Plane::Intersects
```cpp
bool Intersects(const Sphere& sphere) const
```
检测平面是否与球体相交。
**参数:**
- `sphere` - 要检测的球体
**返回:** `bool` - true 表示相交
**复杂度:** O(1)
**示例:**
```cpp
if (plane.Intersects(sphere)) { /* collision */ }
```

View File

@@ -0,0 +1,40 @@
# Plane
3D 平面结构体,由法线和距离表示。
**头文件:** `#include <XCEngine/Math/Plane.h>`
**命名空间:** `XCEngine::Math`
## 结构体定义
```cpp
struct Plane {
Vector3 normal = Vector3::Up();
float distance = 0.0f;
};
```
## 构造函数
- `Plane()` - 默认构造 (y=0 平面)
- `Plane(const Vector3& normal, float distance)` - 从法线和距离构造
## 静态工厂方法
| 方法 | 返回值 | 描述 |
|------|--------|------|
| [FromPoints(a, b, c)](frompoints.md) | `Plane` | 从三个不共线点创建 |
## 实例方法
| 方法 | 返回值 | 描述 |
|------|--------|------|
| [GetDistanceToPoint(point)](getdistancetopoint.md) | `float` | 点到平面的有符号距离 |
| [GetClosestPoint(point)](getclosestpoint.md) | `Vector3` | 平面上最接近给定点的点 |
| [GetSide(point)](getside.md) | `bool` | 点在平面的哪一侧 |
| [Intersects(sphere)](intersects.md) | `bool` | 与球体相交 |
## 相关文档
- [Math 模块总览](../math.md) - 返回 Math 模块总览