docs: update math API docs
This commit is contained in:
@@ -4,17 +4,35 @@
|
||||
bool Contains(const Vector3& point) const
|
||||
```
|
||||
|
||||
检测点是否在包围盒内。
|
||||
检测给定点是否在包围盒内部。边界上的点被视为在盒内。
|
||||
|
||||
**参数:**
|
||||
- `point` - 要检测的点
|
||||
|
||||
**返回:** `bool` - true 表示点在盒内
|
||||
**返回:** `bool` - true 表示点在盒内(包括边界)
|
||||
|
||||
**线程安全:** ✅
|
||||
|
||||
**复杂度:** O(1)
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
if (bounds.Contains(point)) { /* inside */ }
|
||||
#include <XCEngine/Math/Bounds.h>
|
||||
#include <XCEngine/Math/Vector3.h>
|
||||
|
||||
using namespace XCEngine::Math;
|
||||
|
||||
Bounds bounds(Vector3(0.0f, 0.0f, 0.0f), Vector3(2.0f, 2.0f, 2.0f));
|
||||
if (bounds.Contains(Vector3(0.0f, 0.0f, 0.0f))) {
|
||||
// center is inside
|
||||
}
|
||||
if (!bounds.Contains(Vector3(10.0f, 0.0f, 0.0f))) {
|
||||
// far away point is outside
|
||||
}
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [Bounds](bounds.md) - 返回类总览
|
||||
- [Intersects](intersects.md) - 检测与另一个 Bounds 是否相交
|
||||
|
||||
Reference in New Issue
Block a user