docs: update math API docs
This commit is contained in:
42
docs/api/math/box/constructor.md
Normal file
42
docs/api/math/box/constructor.md
Normal file
@@ -0,0 +1,42 @@
|
||||
# Box::Box
|
||||
|
||||
## 默认构造函数
|
||||
|
||||
```cpp
|
||||
Box() = default;
|
||||
```
|
||||
|
||||
构造一个盒体,`center` 为原点,`extents` 为零向量,`transform` 为单位矩阵。
|
||||
|
||||
## 带参构造函数
|
||||
|
||||
```cpp
|
||||
Box(const Vector3& center, const Vector3& extents)
|
||||
```
|
||||
|
||||
从指定的中心和半长构造一个盒体。
|
||||
|
||||
**参数:**
|
||||
- `center` - 盒体的中心点
|
||||
- `extents` - 盒体在各轴向上的半长(从中心到面的距离)
|
||||
|
||||
**返回:** 无
|
||||
|
||||
**线程安全:** ✅
|
||||
|
||||
**复杂度:** O(1)
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
#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, 2.0f, 1.5f));
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [Box 类总览](box.md) - 返回类总览
|
||||
Reference in New Issue
Block a user