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 @@
# Ray::GetPoint
```cpp
Vector3 GetPoint(float t) const
```
获取射线上指定距离处的点。
**参数:**
- `t` - 沿射线方向的参数距离
**返回:** `Vector3` - 射线上的点 `origin + direction * t`
**复杂度:** O(1)
**示例:**
```cpp
Ray ray(cameraPosition, mouseRayDir.Normalized());
float t = 100.0f;
Vector3 point = ray.GetPoint(t); // 沿射线方向 100 单位处的点
```

View File

@@ -0,0 +1,27 @@
# Ray::Intersects (box)
```cpp
bool Intersects(const Box& box, float& t) const
```
检测射线是否与 OBB有向包围盒相交。
**参数:**
- `box` - 要检测的 OBB 盒体
- `t` - 输出交点的参数距离
**返回:** `bool` - 相交返回 true否则返回 false
**复杂度:** O(1)
**示例:**
```cpp
Ray ray(cameraPosition, rayDirection);
Box colliderBox = object.GetWorldBox();
float t;
if (ray.Intersects(colliderBox, t)) {
Vector3 hitPoint = ray.GetPoint(t);
// 处理命中
}
```

View File

@@ -0,0 +1,27 @@
# Ray::Intersects (plane)
```cpp
bool Intersects(const Plane& plane, float& t) const
```
检测射线是否与平面相交。
**参数:**
- `plane` - 要检测的平面
- `t` - 输出交点的参数距离
**返回:** `bool` - 相交返回 true射线朝向平面否则返回 false
**复杂度:** O(1)
**示例:**
```cpp
Ray ray(cameraPosition, rayDirection);
Plane groundPlane = Plane::FromNormalAndPoint(Vector3::Up(), Vector3::Zero());
float t;
if (ray.Intersects(groundPlane, t)) {
Vector3 hitPoint = ray.GetPoint(t);
// 射线命中地面
}
```

View File

@@ -0,0 +1,26 @@
# Ray::Intersects (sphere)
```cpp
bool Intersects(const Sphere& sphere, float& t) const
```
检测射线是否与球体相交。
**参数:**
- `sphere` - 要检测的球体
- `t` - 输出最近交点的参数距离
**返回:** `bool` - 相交返回 true否则返回 false
**复杂度:** O(1)
**示例:**
```cpp
Ray ray(cameraPosition, rayDirection);
float t;
if (ray.Intersects(sphere, t)) {
Vector3 hitPoint = ray.GetPoint(t);
// 处理命中
}
```

44
docs/api/math/ray/ray.md Normal file
View File

@@ -0,0 +1,44 @@
# Ray
3D 射线结构体,用于光线投射和拾取。
**头文件:** `#include <XCEngine/Math/Ray.h>`
**命名空间:** `XCEngine::Math`
## 结构体定义
```cpp
struct Ray {
Vector3 origin; // 射线起点
Vector3 direction; // 归一化方向
Ray() = default;
Ray(const Vector3& origin, const Vector3& direction);
Vector3 GetPoint(float t) const;
bool Intersects(const Sphere& sphere, float& t) const;
bool Intersects(const Box& box, float& t) const;
bool Intersects(const Plane& plane, float& t) const;
};
```
## 构造函数
| 方法 | 描述 |
|------|------|
| `Ray()` | 默认构造 |
| `Ray(origin, direction)` | 从起点和方向构造 |
## 实例方法
| 方法 | 返回值 | 描述 |
|------|--------|------|
| [GetPoint(t)](getpoint.md) | `Vector3` | 获取射线上 t 距离处的点 |
| [Intersects(sphere, t)](intersects-sphere.md) | `bool` | 与球体相交,输出距离 t |
| [Intersects(box, t)](intersects-box.md) | `bool` | 与 OBB 相交,输出距离 t |
| [Intersects(plane, t)](intersects-plane.md) | `bool` | 与平面相交,输出距离 t |
## 相关文档
- [Math 模块总览](../math.md) - 返回 Math 模块总览