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,43 @@
# AABB / OBB
轴对齐包围盒 (AABB) 和有向包围盒 (OBB)。
**头文件:** `#include <XCEngine/Math/AABB.h>`
**命名空间:** `XCEngine::Math`
## AABB
`AABB` 在 Math 库中通过 `Bounds` 类型实现,参见 [./bounds/bounds.md](../bounds/bounds.md)。
## OBB - 有向包围盒
OBB 是可以任意方向旋转的包围盒。
```cpp
struct OBB {
Vector3 center;
Vector3 extents;
Matrix4 transform;
};
```
### 构造函数
- `OBB()` - 默认构造
- `OBB(const Vector3& center, const Vector3& extents)` - 从中心和半长构造
### 实例方法
| 方法 | 返回值 | 描述 |
|------|--------|------|
| [GetAxis(index)](obb-getaxis.md) | `Vector3` | 获取局部轴 |
| [GetMin()](obb-getmin.md) | `Vector3` | 局部空间最小点 |
| [GetMax()](obb-getmax.md) | `Vector3` | 局部空间最大点 |
| [Contains(point)](obb-contains.md) | `bool` | 点是否在 OBB 内 |
| [Intersects(OBB)](obb-intersects-obb.md) | `bool` | 与另一个 OBB 相交 |
| [Intersects(Sphere)](obb-intersects-sphere.md) | `bool` | 与球体相交 |
## 相关文档
- [Math 模块总览](../math.md) - 返回 Math 模块总览

View File

@@ -0,0 +1,20 @@
# OBB::Contains
```cpp
bool Contains(const Vector3& point) const
```
检测点是否在 OBB 内。
**参数:**
- `point` - 要检测的点
**返回:** `bool` - true 表示点在 OBB 内
**复杂度:** O(1)
**示例:**
```cpp
if (obb.Contains(point)) { /* inside */ }
```

View File

@@ -0,0 +1,20 @@
# OBB::GetAxis
```cpp
Vector3 GetAxis(int index) const
```
获取 OBB 的局部轴。
**参数:**
- `index` - 轴索引 (0=X, 1=Y, 2=Z)
**返回:** `Vector3` - 对应的局部轴
**复杂度:** O(1)
**示例:**
```cpp
Vector3 xAxis = obb.GetAxis(0);
```

View File

@@ -0,0 +1,17 @@
# OBB::GetMax
```cpp
Vector3 GetMax() const
```
获取局部空间最大点。
**返回:** `Vector3` - center + extents
**复杂度:** O(1)
**示例:**
```cpp
Vector3 max = obb.GetMax();
```

View File

@@ -0,0 +1,17 @@
# OBB::GetMin
```cpp
Vector3 GetMin() const
```
获取局部空间最小点。
**返回:** `Vector3` - center - extents
**复杂度:** O(1)
**示例:**
```cpp
Vector3 min = obb.GetMin();
```

View File

@@ -0,0 +1,25 @@
# OBB::Intersects(OBB)
```cpp
bool Intersects(const OBB& other) const;
```
判断两个 OBB 是否相交SAT 分离轴定理)。
**返回:** 两包围盒是否相交
**复杂度:** O(1)
**示例:**
```cpp
OBB a(centerA, extentsA);
OBB b(centerB, extentsB);
if (a.Intersects(b)) {
// 两包围盒相交
}
```
## 相关文档
- [AABB 总览](aabb.md) - 返回 AABB 概览

View File

@@ -0,0 +1,28 @@
# OBB::Intersects(Sphere)
```cpp
bool Intersects(const Sphere& sphere) const;
```
判断 OBB 与球体是否相交。
**参数:**
- `sphere` - 球体
**返回:** OBB 与球体是否相交
**复杂度:** O(1)
**示例:**
```cpp
OBB obb(center, extents);
Sphere s(sphereCenter, radius);
if (obb.Intersects(s)) {
// OBB 与球体相交
}
```
## 相关文档
- [AABB 总览](aabb.md) - 返回 AABB 概览