fix: improve doc link navigation and tree display
- Fix link resolution with proper relative/absolute path handling - Improve link styling with underline decoration - Hide leaf nodes from tree, only show directories - Fix log file path for packaged app
This commit is contained in:
40
docs/api/math/bounds/bounds.md
Normal file
40
docs/api/math/bounds/bounds.md
Normal file
@@ -0,0 +1,40 @@
|
||||
# Bounds
|
||||
|
||||
轴对齐包围盒 (AABB),中心-范围表示。
|
||||
|
||||
**头文件:** `#include <XCEngine/Math/Bounds.h>`
|
||||
|
||||
**命名空间:** `XCEngine::Math`
|
||||
|
||||
## 结构体定义
|
||||
|
||||
```cpp
|
||||
struct Bounds {
|
||||
Vector3 center = Vector3::Zero();
|
||||
Vector3 extents = Vector3::Zero();
|
||||
};
|
||||
```
|
||||
|
||||
## 构造函数
|
||||
|
||||
- `Bounds()` - 默认构造
|
||||
- `Bounds(const Vector3& center, const Vector3& size)` - 从中心和大小构造
|
||||
|
||||
## 实例方法
|
||||
|
||||
| 方法 | 返回值 | 描述 |
|
||||
|------|--------|------|
|
||||
| [GetMin()](getmin.md) | `Vector3` | 最小点 |
|
||||
| [GetMax()](getmax.md) | 最大点 |
|
||||
| [SetMinMax(min, max)](setminmax.md) | `void` | 从最小/最大点设置 |
|
||||
| [Contains(point)](contains.md) | `bool` | 点是否在盒内 |
|
||||
| [Intersects(other)](intersects.md) | `bool` | 与另一个 Bounds 相交 |
|
||||
| [Encapsulate(point)](encapsulate.md) | `void` | 扩展包含点 |
|
||||
| [Encapsulate(bounds)](encapsulate-bounds.md) | `void` | 扩展包含另一个 Bounds |
|
||||
| [Expand(amount)](expand.md) | `void` | 扩展包围盒 |
|
||||
| [GetClosestPoint(point)](getclosestpoint.md) | `Vector3` | 盒上最接近的点 |
|
||||
| [GetVolume()](getvolume.md) | `float` | 体积 |
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [Math 模块总览](../math.md) - 返回 Math 模块总览
|
||||
20
docs/api/math/bounds/contains.md
Normal file
20
docs/api/math/bounds/contains.md
Normal file
@@ -0,0 +1,20 @@
|
||||
# Bounds::Contains
|
||||
|
||||
```cpp
|
||||
bool Contains(const Vector3& point) const
|
||||
```
|
||||
|
||||
检测点是否在包围盒内。
|
||||
|
||||
**参数:**
|
||||
- `point` - 要检测的点
|
||||
|
||||
**返回:** `bool` - true 表示点在盒内
|
||||
|
||||
**复杂度:** O(1)
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
if (bounds.Contains(point)) { /* inside */ }
|
||||
```
|
||||
18
docs/api/math/bounds/encapsulate-bounds.md
Normal file
18
docs/api/math/bounds/encapsulate-bounds.md
Normal file
@@ -0,0 +1,18 @@
|
||||
# Bounds::Encapsulate (Bounds)
|
||||
|
||||
```cpp
|
||||
void Encapsulate(const Bounds& bounds)
|
||||
```
|
||||
|
||||
扩展包围盒以包含另一个 Bounds。
|
||||
|
||||
**参数:**
|
||||
- `bounds` - 要包含的 Bounds
|
||||
|
||||
**复杂度:** O(1)
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
bounds.Encapsulate(otherBounds);
|
||||
```
|
||||
21
docs/api/math/bounds/encapsulate.md
Normal file
21
docs/api/math/bounds/encapsulate.md
Normal file
@@ -0,0 +1,21 @@
|
||||
# Bounds::Encapsulate
|
||||
|
||||
```cpp
|
||||
void Encapsulate(const Vector3& point)
|
||||
void Encapsulate(const Bounds& bounds)
|
||||
```
|
||||
|
||||
扩展包围盒以包含点或另一个 Bounds。
|
||||
|
||||
**参数:**
|
||||
- `point` - 要包含的点
|
||||
- `bounds` - 要包含的 Bounds
|
||||
|
||||
**复杂度:** O(1)
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
bounds.Encapsulate(point);
|
||||
bounds.Encapsulate(otherBounds);
|
||||
```
|
||||
19
docs/api/math/bounds/expand.md
Normal file
19
docs/api/math/bounds/expand.md
Normal file
@@ -0,0 +1,19 @@
|
||||
# Bounds::Expand
|
||||
|
||||
```cpp
|
||||
void Expand(float amount)
|
||||
void Expand(const Vector3& amount)
|
||||
```
|
||||
|
||||
扩展包围盒。
|
||||
|
||||
**参数:**
|
||||
- `amount` - 扩展量(各方向或统一)
|
||||
|
||||
**复杂度:** O(1)
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
bounds.Expand(1.0f);
|
||||
```
|
||||
20
docs/api/math/bounds/getclosestpoint.md
Normal file
20
docs/api/math/bounds/getclosestpoint.md
Normal file
@@ -0,0 +1,20 @@
|
||||
# Bounds::GetClosestPoint
|
||||
|
||||
```cpp
|
||||
Vector3 GetClosestPoint(const Vector3& point) const
|
||||
```
|
||||
|
||||
获取包围盒上最接近给定点的点。
|
||||
|
||||
**参数:**
|
||||
- `point` - 参考点
|
||||
|
||||
**返回:** `Vector3` - 盒上最接近的点
|
||||
|
||||
**复杂度:** O(1)
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
Vector3 closest = bounds.GetClosestPoint(point);
|
||||
```
|
||||
17
docs/api/math/bounds/getmax.md
Normal file
17
docs/api/math/bounds/getmax.md
Normal file
@@ -0,0 +1,17 @@
|
||||
# Bounds::GetMax
|
||||
|
||||
```cpp
|
||||
Vector3 GetMax() const
|
||||
```
|
||||
|
||||
获取包围盒的最大点。
|
||||
|
||||
**返回:** `Vector3` - center + extents
|
||||
|
||||
**复杂度:** O(1)
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
Vector3 max = bounds.GetMax();
|
||||
```
|
||||
17
docs/api/math/bounds/getmin.md
Normal file
17
docs/api/math/bounds/getmin.md
Normal file
@@ -0,0 +1,17 @@
|
||||
# Bounds::GetMin
|
||||
|
||||
```cpp
|
||||
Vector3 GetMin() const
|
||||
```
|
||||
|
||||
获取包围盒的最小点。
|
||||
|
||||
**返回:** `Vector3` - center - extents
|
||||
|
||||
**复杂度:** O(1)
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
Vector3 min = bounds.GetMin();
|
||||
```
|
||||
17
docs/api/math/bounds/getvolume.md
Normal file
17
docs/api/math/bounds/getvolume.md
Normal file
@@ -0,0 +1,17 @@
|
||||
# Bounds::GetVolume
|
||||
|
||||
```cpp
|
||||
float GetVolume() const
|
||||
```
|
||||
|
||||
计算包围盒的体积。
|
||||
|
||||
**返回:** `float` - 体积
|
||||
|
||||
**复杂度:** O(1)
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
float vol = bounds.GetVolume();
|
||||
```
|
||||
20
docs/api/math/bounds/intersects.md
Normal file
20
docs/api/math/bounds/intersects.md
Normal file
@@ -0,0 +1,20 @@
|
||||
# Bounds::Intersects
|
||||
|
||||
```cpp
|
||||
bool Intersects(const Bounds& other) const
|
||||
```
|
||||
|
||||
检测两个 Bounds 是否相交。
|
||||
|
||||
**参数:**
|
||||
- `other` - 另一个 Bounds
|
||||
|
||||
**返回:** `bool` - true 表示相交
|
||||
|
||||
**复杂度:** O(1)
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
if (bounds.Intersects(other)) { /* collision */ }
|
||||
```
|
||||
19
docs/api/math/bounds/setminmax.md
Normal file
19
docs/api/math/bounds/setminmax.md
Normal file
@@ -0,0 +1,19 @@
|
||||
# Bounds::SetMinMax
|
||||
|
||||
```cpp
|
||||
void SetMinMax(const Vector3& min, const Vector3& max)
|
||||
```
|
||||
|
||||
从最小/最大点设置包围盒。
|
||||
|
||||
**参数:**
|
||||
- `min` - 最小点
|
||||
- `max` - 最大点
|
||||
|
||||
**复杂度:** O(1)
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
bounds.SetMinMax(minPoint, maxPoint);
|
||||
```
|
||||
Reference in New Issue
Block a user