docs: update math API docs
This commit is contained in:
35
docs/api/math/plane/constructor.md
Normal file
35
docs/api/math/plane/constructor.md
Normal file
@@ -0,0 +1,35 @@
|
||||
# Plane::Plane
|
||||
|
||||
```cpp
|
||||
Plane(const Vector3& normal, float distance)
|
||||
```
|
||||
|
||||
从法线向量和距离值构造平面。输入的法线会自动归一化。
|
||||
|
||||
**参数:**
|
||||
- `normal` - 平面法线向量(会被归一化)
|
||||
- `distance` - 原点到平面的有符号距离
|
||||
|
||||
**返回:** 无(构造函数)
|
||||
|
||||
**线程安全:** ✅
|
||||
|
||||
**复杂度:** O(1)
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Math/Plane.h>
|
||||
#include <XCEngine/Math/Vector3.h>
|
||||
|
||||
using namespace XCEngine::Math;
|
||||
|
||||
void ConstructorExample() {
|
||||
Plane plane(Vector3::Up(), 0.0f);
|
||||
Plane tiltedPlane(Vector3(1.0f, 1.0f, 0.0f), 5.0f);
|
||||
}
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [Plane 类总览](plane.md) - 返回类总览
|
||||
Reference in New Issue
Block a user