docs: update math API docs
This commit is contained in:
@@ -4,17 +4,30 @@
|
||||
bool Contains(const Vector3& point) const
|
||||
```
|
||||
|
||||
检测点是否在盒内。
|
||||
检测点是否在盒体内。该方法使用 `transform` 矩阵将点转换到盒体局部空间进行检测,支持 OBB 语义。
|
||||
|
||||
**参数:**
|
||||
- `point` - 要检测的点
|
||||
- `point` - 要检测的点(世界坐标)
|
||||
|
||||
**返回:** `bool` - true 表示点在盒内
|
||||
**返回:** `bool` - 点在盒体内返回 true,否则返回 false
|
||||
|
||||
**线程安全:** ✅
|
||||
|
||||
**复杂度:** O(1)
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
if (box.Contains(point)) { /* inside */ }
|
||||
#include <XCEngine/Math/Box.h>
|
||||
#include <XCEngine/Math/Vector3.h>
|
||||
|
||||
using namespace XCEngine::Math;
|
||||
|
||||
Box box(Vector3(0.0f, 0.0f, 0.0f), Vector3(1.0f, 1.0f, 1.0f));
|
||||
if (box.Contains(Vector3(0.5f, 0.5f, 0.5f))) {
|
||||
}
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [Box 类总览](box.md) - 返回类总览
|
||||
|
||||
Reference in New Issue
Block a user