xuanchi/XCEngine
1
1
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
bd530dc8b1ed933ed9fb7c4f1779567a7eb80137
XCEngine/docs/api/math/box/box.md

40 lines
1.2 KiB
Markdown
Raw Normal View History

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 个断裂引用
2026-03-19 00:22:30 +08:00
# Box
Fix Box documentation to accurately reflect AABB vs OBB behavior - Updated box.md to clarify that Box uses OBB semantics for Contains but currently uses AABB for Intersects(Box) - Updated intersects-box.md to document that it uses AABB algorithm instead of SAT, since the current implementation ignores transform - Added notes explaining the current limitations of the Box implementation
2026-03-19 00:52:04 +08:00
带变换的包围盒结构体（支持 OBB 语义，取决于方法）。
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 个断裂引用
2026-03-19 00:22:30 +08:00
**头文件：** `#include <XCEngine/Math/Box.h>`
**命名空间：** `XCEngine::Math`
## 结构体定义
```cpp
struct Box {
Vector3 center = Vector3::Zero();
Vector3 extents = Vector3::Zero();
Matrix4x4 transform = Matrix4x4::Identity();
};
```
Fix Box documentation to accurately reflect AABB vs OBB behavior - Updated box.md to clarify that Box uses OBB semantics for Contains but currently uses AABB for Intersects(Box) - Updated intersects-box.md to document that it uses AABB algorithm instead of SAT, since the current implementation ignores transform - Added notes explaining the current limitations of the Box implementation
2026-03-19 00:52:04 +08:00
**注意：** `Contains` 方法会使用 `transform` 进行真正的 OBB 检测。`Intersects(Box)` 目前使用 AABB 简化算法，未考虑旋转。
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 个断裂引用
2026-03-19 00:22:30 +08:00
## 构造函数
- `Box()` - 默认构造
- `Box(const Vector3& center, const Vector3& extents)` - 从中心和半长构造
## 实例方法
| 方法 | 返回值 | 描述 |
|------|--------|------|
| [GetMin()](getmin.md) | `Vector3` | 局部空间最小点 |
| [GetMax()](getmax.md) | `Vector3` | 局部空间最大点 |
Fix Box documentation to accurately reflect AABB vs OBB behavior - Updated box.md to clarify that Box uses OBB semantics for Contains but currently uses AABB for Intersects(Box) - Updated intersects-box.md to document that it uses AABB algorithm instead of SAT, since the current implementation ignores transform - Added notes explaining the current limitations of the Box implementation
2026-03-19 00:52:04 +08:00
| [Contains(point)](contains.md) | `bool` | 点是否在盒内（使用 transform） |
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 个断裂引用
2026-03-19 00:22:30 +08:00
| [Intersects(Sphere)](intersects.md) | `bool` | 与球体相交 |
Fix Box documentation to accurately reflect AABB vs OBB behavior - Updated box.md to clarify that Box uses OBB semantics for Contains but currently uses AABB for Intersects(Box) - Updated intersects-box.md to document that it uses AABB algorithm instead of SAT, since the current implementation ignores transform - Added notes explaining the current limitations of the Box implementation
2026-03-19 00:52:04 +08:00
| [Intersects(Box)](intersects-box.md) | `bool` | 与另一个盒相交（AABB 检测） |
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 个断裂引用
2026-03-19 00:22:30 +08:00
| [Intersects(Ray, t)](intersects-ray.md) | `bool` | 与射线相交 |
## 相关文档
- [Math 模块总览](../math.md) - 返回 Math 模块总览
Reference in New Issue Copy Permalink