docs: update math API docs
This commit is contained in:
@@ -4,17 +4,34 @@
|
||||
Vector3 GetClosestPoint(const Vector3& point) const
|
||||
```
|
||||
|
||||
计算平面上最接近给定点的点。
|
||||
计算平面上最接近给定点的点。通过将点沿平面法线方向投影到平面上得到。
|
||||
|
||||
**参数:**
|
||||
- `point` - 参考点
|
||||
|
||||
**返回:** `Vector3` - 平面上最接近的点
|
||||
**返回:** `Vector3` - 平面上最接近给定点的点
|
||||
|
||||
**线程安全:** ✅
|
||||
|
||||
**复杂度:** O(1)
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
Vector3 closest = plane.GetClosestPoint(point);
|
||||
#include <XCEngine/Math/Plane.h>
|
||||
#include <XCEngine/Math/Vector3.h>
|
||||
|
||||
using namespace XCEngine::Math;
|
||||
|
||||
void GetClosestPointExample() {
|
||||
Plane plane(Vector3::Up(), 0.0f);
|
||||
|
||||
Vector3 point(5.0f, 10.0f, 0.0f);
|
||||
Vector3 closest = plane.GetClosestPoint(point);
|
||||
}
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [Plane 类总览](plane.md) - 返回类总览
|
||||
- [GetDistanceToPoint](getdistancetopoint.md) - 计算有符号距离
|
||||
|
||||
Reference in New Issue
Block a user