docs: update math API docs

This commit is contained in:
2026-03-20 02:35:15 +08:00
parent e165dbea1c
commit c5b17239ca
243 changed files with 5307 additions and 1327 deletions

View File

@@ -4,24 +4,38 @@
bool Intersects(const Plane& plane, float& t) const
```
检测射线是否与平面相交。
检测射线是否与平面相交。通过计算射线与平面法线的点积判断平行,通过求交公式计算交点。
**参数:**
- `plane` - 要检测的平面
- `t` - 输出交点的参数距离
- `t` - 输出交点的参数距离(仅在返回 true 时有效)
**返回:** `bool` - 相交返回 true射线朝向平面),否则返回 false
**返回:** `bool` - 相交返回 truet >= 0),否则返回 false
**线程安全:**
**复杂度:** O(1)
**异常:**
**示例:**
```cpp
Ray ray(cameraPosition, rayDirection);
Plane groundPlane = Plane::FromNormalAndPoint(Vector3::Up(), Vector3::Zero());
#include <XCEngine/Math/Ray.h>
#include <XCEngine/Math/Plane.h>
#include <XCEngine/Math/Vector3.h>
using namespace XCEngine::Math;
Ray ray(Vector3(0.0f, 1.0f, 0.0f), Vector3(0.0f, -1.0f, 0.0f));
Plane groundPlane(Vector3(0.0f, 1.0f, 0.0f), 0.0f);
float t;
if (ray.Intersects(groundPlane, t)) {
Vector3 hitPoint = ray.GetPoint(t);
// 射线命中地面
}
```
## 相关文档
- [Ray 类总览](ray.md) - 返回类总览
- [Plane](../plane/plane.md) - 平面类型