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,40 @@
# Bounds
轴对齐包围盒 (AABB),中心-范围表示。
**头文件:** `#include <XCEngine/Math/Bounds.h>`
**命名空间:** `XCEngine::Math`
## 结构体定义
```cpp
struct Bounds {
Vector3 center = Vector3::Zero();
Vector3 extents = Vector3::Zero();
};
```
## 构造函数
- `Bounds()` - 默认构造
- `Bounds(const Vector3& center, const Vector3& size)` - 从中心和大小构造
## 实例方法
| 方法 | 返回值 | 描述 |
|------|--------|------|
| [GetMin()](getmin.md) | `Vector3` | 最小点 |
| [GetMax()](getmax.md) | 最大点 |
| [SetMinMax(min, max)](setminmax.md) | `void` | 从最小/最大点设置 |
| [Contains(point)](contains.md) | `bool` | 点是否在盒内 |
| [Intersects(other)](intersects.md) | `bool` | 与另一个 Bounds 相交 |
| [Encapsulate(point)](encapsulate.md) | `void` | 扩展包含点 |
| [Encapsulate(bounds)](encapsulate-bounds.md) | `void` | 扩展包含另一个 Bounds |
| [Expand(amount)](expand.md) | `void` | 扩展包围盒 |
| [GetClosestPoint(point)](getclosestpoint.md) | `Vector3` | 盒上最接近的点 |
| [GetVolume()](getvolume.md) | `float` | 体积 |
## 相关文档
- [Math 模块总览](../math.md) - 返回 Math 模块总览

View File

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

View File

@@ -0,0 +1,18 @@
# Bounds::Encapsulate (Bounds)
```cpp
void Encapsulate(const Bounds& bounds)
```
扩展包围盒以包含另一个 Bounds。
**参数:**
- `bounds` - 要包含的 Bounds
**复杂度:** O(1)
**示例:**
```cpp
bounds.Encapsulate(otherBounds);
```

View File

@@ -0,0 +1,21 @@
# Bounds::Encapsulate
```cpp
void Encapsulate(const Vector3& point)
void Encapsulate(const Bounds& bounds)
```
扩展包围盒以包含点或另一个 Bounds。
**参数:**
- `point` - 要包含的点
- `bounds` - 要包含的 Bounds
**复杂度:** O(1)
**示例:**
```cpp
bounds.Encapsulate(point);
bounds.Encapsulate(otherBounds);
```

View File

@@ -0,0 +1,19 @@
# Bounds::Expand
```cpp
void Expand(float amount)
void Expand(const Vector3& amount)
```
扩展包围盒。
**参数:**
- `amount` - 扩展量(各方向或统一)
**复杂度:** O(1)
**示例:**
```cpp
bounds.Expand(1.0f);
```

View File

@@ -0,0 +1,20 @@
# Bounds::GetClosestPoint
```cpp
Vector3 GetClosestPoint(const Vector3& point) const
```
获取包围盒上最接近给定点的点。
**参数:**
- `point` - 参考点
**返回:** `Vector3` - 盒上最接近的点
**复杂度:** O(1)
**示例:**
```cpp
Vector3 closest = bounds.GetClosestPoint(point);
```

View File

@@ -0,0 +1,17 @@
# Bounds::GetMax
```cpp
Vector3 GetMax() const
```
获取包围盒的最大点。
**返回:** `Vector3` - center + extents
**复杂度:** O(1)
**示例:**
```cpp
Vector3 max = bounds.GetMax();
```

View File

@@ -0,0 +1,17 @@
# Bounds::GetMin
```cpp
Vector3 GetMin() const
```
获取包围盒的最小点。
**返回:** `Vector3` - center - extents
**复杂度:** O(1)
**示例:**
```cpp
Vector3 min = bounds.GetMin();
```

View File

@@ -0,0 +1,17 @@
# Bounds::GetVolume
```cpp
float GetVolume() const
```
计算包围盒的体积。
**返回:** `float` - 体积
**复杂度:** O(1)
**示例:**
```cpp
float vol = bounds.GetVolume();
```

View File

@@ -0,0 +1,20 @@
# Bounds::Intersects
```cpp
bool Intersects(const Bounds& other) const
```
检测两个 Bounds 是否相交。
**参数:**
- `other` - 另一个 Bounds
**返回:** `bool` - true 表示相交
**复杂度:** O(1)
**示例:**
```cpp
if (bounds.Intersects(other)) { /* collision */ }
```

View File

@@ -0,0 +1,19 @@
# Bounds::SetMinMax
```cpp
void SetMinMax(const Vector3& min, const Vector3& max)
```
从最小/最大点设置包围盒。
**参数:**
- `min` - 最小点
- `max` - 最大点
**复杂度:** O(1)
**示例:**
```cpp
bounds.SetMinMax(minPoint, maxPoint);
```