docs: update math API docs
This commit is contained in:
@@ -4,17 +4,39 @@
|
||||
bool GetSide(const Vector3& point) const
|
||||
```
|
||||
|
||||
判断点在平面的哪一侧。
|
||||
判断点在平面的哪一侧。返回值 `true` 表示点在法线方向一侧,`false` 表示点在法线相反方向或平面上。
|
||||
|
||||
**参数:**
|
||||
- `point` - 要测试的点
|
||||
|
||||
**返回:** `bool` - true 表示点在法线方向一侧
|
||||
**返回:** `bool` - `true` 表示点在法线方向一侧,`false` 表示另一侧或平面上
|
||||
|
||||
**线程安全:** ✅
|
||||
|
||||
**复杂度:** O(1)
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
if (plane.GetSide(point)) { /* point is on normal side */ }
|
||||
#include <XCEngine/Math/Plane.h>
|
||||
#include <XCEngine/Math/Vector3.h>
|
||||
|
||||
using namespace XCEngine::Math;
|
||||
|
||||
void GetSideExample() {
|
||||
Plane plane(Vector3::Up(), 0.0f);
|
||||
|
||||
Vector3 pointOnNormalSide(0.0f, 1.0f, 0.0f);
|
||||
if (plane.GetSide(pointOnNormalSide)) {
|
||||
}
|
||||
|
||||
Vector3 pointOnOppositeSide(0.0f, -1.0f, 0.0f);
|
||||
if (!plane.GetSide(pointOnOppositeSide)) {
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [Plane 类总览](plane.md) - 返回类总览
|
||||
- [GetDistanceToPoint](getdistancetopoint.md) - 计算有符号距离
|
||||
|
||||
Reference in New Issue
Block a user