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:
69
docs/api/math/rect/rect-overview.md
Normal file
69
docs/api/math/rect/rect-overview.md
Normal file
@@ -0,0 +1,69 @@
|
||||
# Rect
|
||||
|
||||
浮点矩形结构体,用于 2D 区域表示。
|
||||
|
||||
**头文件:** `#include <XCEngine/Math/Rect.h>`
|
||||
|
||||
**命名空间:** `XCEngine::Math`
|
||||
|
||||
## 结构体定义
|
||||
|
||||
```cpp
|
||||
struct Rect {
|
||||
float x = 0.0f; // 左边界
|
||||
float y = 0.0f; // 上边界
|
||||
float width = 0.0f;
|
||||
float height = 0.0f;
|
||||
|
||||
Rect() = default;
|
||||
Rect(float x, float y, float w, float h) : x(x), y(y), width(w), height(h) {}
|
||||
};
|
||||
```
|
||||
|
||||
## 构造函数
|
||||
|
||||
| 方法 | 描述 |
|
||||
|------|------|
|
||||
| `Rect()` | 默认构造,初始化为零 |
|
||||
| `Rect(x, y, w, h)` | 从坐标和尺寸构造 |
|
||||
|
||||
## 边界访问
|
||||
|
||||
| 方法 | 返回值 | 描述 |
|
||||
|------|--------|------|
|
||||
| [GetLeft()](getleft.md) | `float` | 左边界 (x) |
|
||||
| [GetRight()](getright.md) | `float` | 右边界 (x + width) |
|
||||
| [GetTop()](gettop.md) | `float` | 上边界 (y) |
|
||||
| [GetBottom()](getbottom.md) | `float` | 下边界 (y + height) |
|
||||
| [GetPosition()](getposition.md) | `Vector2` | 左上角位置 (x, y) |
|
||||
| [GetSize()](getsize.md) | `Vector2` | 尺寸 (width, height) |
|
||||
| [GetCenter()](getcenter.md) | `Vector2` | 中心点 |
|
||||
|
||||
## 检测方法
|
||||
|
||||
| 方法 | 返回值 | 描述 |
|
||||
|------|--------|------|
|
||||
| [Contains(px, py)](contains-float.md) | `bool` | 浮点坐标点检测 |
|
||||
| [Contains(point)](contains-vector2.md) | `bool` | Vector2 点检测 |
|
||||
| [Intersects(other)](intersects.md) | `bool` | 与另一矩形相交 |
|
||||
|
||||
## 静态方法
|
||||
|
||||
| 方法 | 返回值 | 描述 |
|
||||
|------|--------|------|
|
||||
| [Intersect(a, b)](intersect.md) | `Rect` | 两矩形交集 |
|
||||
| [Union(a, b)](union.md) | `Rect` | 两矩形并集 |
|
||||
|
||||
## 设置方法
|
||||
|
||||
| 方法 | 返回值 | 描述 |
|
||||
|------|--------|------|
|
||||
| [Set(x, y, w, h)](set.md) | `void` | 设置所有值 |
|
||||
| [SetPosition(x, y)](setposition-float.md) | `void` | 设置位置 |
|
||||
| [SetPosition(position)](setposition-vector2.md) | `void` | 设置位置 |
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [Math 模块总览](../math.md) - 返回 Rect 模块总览
|
||||
- [RectInt](rectint.md) - 整数矩形版本
|
||||
- [Viewport](viewport.md) - 渲染视口
|
||||
Reference in New Issue
Block a user