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:
18
docs/api/math/matrix3/determinant.md
Normal file
18
docs/api/math/matrix3/determinant.md
Normal file
@@ -0,0 +1,18 @@
|
||||
# Matrix3::Determinant
|
||||
|
||||
```cpp
|
||||
float Determinant() const
|
||||
```
|
||||
|
||||
计算矩阵的行列式。
|
||||
|
||||
**返回:** `float` - 行列式值
|
||||
|
||||
**复杂度:** O(1)
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
Matrix3 mat = ...;
|
||||
float det = mat.Determinant();
|
||||
```
|
||||
17
docs/api/math/matrix3/identity.md
Normal file
17
docs/api/math/matrix3/identity.md
Normal file
@@ -0,0 +1,17 @@
|
||||
# Matrix3::Identity
|
||||
|
||||
```cpp
|
||||
static Matrix3 Identity()
|
||||
```
|
||||
|
||||
返回 3x3 单位矩阵。
|
||||
|
||||
**返回:** `Matrix3` - 单位矩阵
|
||||
|
||||
**复杂度:** O(1)
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
Matrix3 identity = Matrix3::Identity();
|
||||
```
|
||||
18
docs/api/math/matrix3/inverse.md
Normal file
18
docs/api/math/matrix3/inverse.md
Normal file
@@ -0,0 +1,18 @@
|
||||
# Matrix3::Inverse
|
||||
|
||||
```cpp
|
||||
Matrix3 Inverse() const
|
||||
```
|
||||
|
||||
返回矩阵的逆矩阵。
|
||||
|
||||
**返回:** `Matrix3` - 逆矩阵
|
||||
|
||||
**复杂度:** O(1)
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
Matrix3 mat = ...;
|
||||
Matrix3 inv = mat.Inverse();
|
||||
```
|
||||
57
docs/api/math/matrix3/matrix3.md
Normal file
57
docs/api/math/matrix3/matrix3.md
Normal file
@@ -0,0 +1,57 @@
|
||||
# Matrix3 / Matrix3x3
|
||||
|
||||
3x3 矩阵结构体,用于表示 3D 旋转和缩放变换。
|
||||
|
||||
**头文件:** `#include <XCEngine/Math/Matrix3.h>`
|
||||
|
||||
**命名空间:** `XCEngine::Math`
|
||||
|
||||
## 类型别名
|
||||
|
||||
```cpp
|
||||
using Matrix3 = Matrix3x3;
|
||||
```
|
||||
|
||||
## 存储方式
|
||||
|
||||
行优先存储 (row-major):
|
||||
```
|
||||
m[row][col]
|
||||
m[0][0] m[0][1] m[0][2]
|
||||
m[1][0] m[1][1] m[1][2]
|
||||
m[2][0] m[2][1] m[2][2]
|
||||
```
|
||||
|
||||
## 构造函数
|
||||
|
||||
- 默认构造函数初始化为零矩阵
|
||||
|
||||
## 静态工厂方法
|
||||
|
||||
| 方法 | 返回值 | 描述 |
|
||||
|------|--------|------|
|
||||
| [Identity()](identity.md) | `Matrix3` | 单位矩阵 |
|
||||
| [Zero()](zero.md) | `Matrix3` | 零矩阵 |
|
||||
| [RotationX(radians)](rotationx.md) | `Matrix3` | X 轴旋转矩阵 |
|
||||
| [RotationY(radians)](rotationy.md) | `Matrix3` | Y 轴旋转矩阵 |
|
||||
| [RotationZ(radians)](rotationz.md) | `Matrix3` | Z 轴旋转矩阵 |
|
||||
| [Scale(scale)](scale.md) | `Matrix3` | 缩放矩阵 |
|
||||
|
||||
## 实例方法
|
||||
|
||||
| 方法 | 返回值 | 描述 |
|
||||
|------|--------|------|
|
||||
| [Transpose()](transpose.md) | `Matrix3` | 转置矩阵 |
|
||||
| [Inverse()](inverse.md) | `Matrix3` | 逆矩阵 |
|
||||
| [Determinant()](determinant.md) | `float` | 行列式 |
|
||||
|
||||
## 运算符
|
||||
|
||||
| 运算符 | 描述 |
|
||||
|--------|------|
|
||||
| `operator*(Matrix3, Matrix3)` | 矩阵乘法 |
|
||||
| `operator*(Matrix3, Vector3)` | 矩阵-向量乘法 |
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [Math 模块总览](../math.md) - 返回 Math 模块总览
|
||||
20
docs/api/math/matrix3/rotationx.md
Normal file
20
docs/api/math/matrix3/rotationx.md
Normal file
@@ -0,0 +1,20 @@
|
||||
# Matrix3::RotationX
|
||||
|
||||
```cpp
|
||||
static Matrix3 RotationX(float radians)
|
||||
```
|
||||
|
||||
创建绕 X 轴旋转的矩阵。
|
||||
|
||||
**参数:**
|
||||
- `radians` - 旋转角度(弧度)
|
||||
|
||||
**返回:** `Matrix3` - 旋转矩阵
|
||||
|
||||
**复杂度:** O(1)
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
Matrix3 rotX = Matrix3::RotationX(Math::HALF_PI);
|
||||
```
|
||||
20
docs/api/math/matrix3/rotationy.md
Normal file
20
docs/api/math/matrix3/rotationy.md
Normal file
@@ -0,0 +1,20 @@
|
||||
# Matrix3::RotationY
|
||||
|
||||
```cpp
|
||||
static Matrix3 RotationY(float radians)
|
||||
```
|
||||
|
||||
创建绕 Y 轴旋转的矩阵。
|
||||
|
||||
**参数:**
|
||||
- `radians` - 旋转角度(弧度)
|
||||
|
||||
**返回:** `Matrix3` - 旋转矩阵
|
||||
|
||||
**复杂度:** O(1)
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
Matrix3 rotY = Matrix3::RotationY(Math::HALF_PI);
|
||||
```
|
||||
20
docs/api/math/matrix3/rotationz.md
Normal file
20
docs/api/math/matrix3/rotationz.md
Normal file
@@ -0,0 +1,20 @@
|
||||
# Matrix3::RotationZ
|
||||
|
||||
```cpp
|
||||
static Matrix3 RotationZ(float radians)
|
||||
```
|
||||
|
||||
创建绕 Z 轴旋转的矩阵。
|
||||
|
||||
**参数:**
|
||||
- `radians` - 旋转角度(弧度)
|
||||
|
||||
**返回:** `Matrix3` - 旋转矩阵
|
||||
|
||||
**复杂度:** O(1)
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
Matrix3 rotZ = Matrix3::RotationZ(Math::HALF_PI);
|
||||
```
|
||||
20
docs/api/math/matrix3/scale.md
Normal file
20
docs/api/math/matrix3/scale.md
Normal file
@@ -0,0 +1,20 @@
|
||||
# Matrix3::Scale
|
||||
|
||||
```cpp
|
||||
static Matrix3 Scale(const Vector3& scale)
|
||||
```
|
||||
|
||||
创建缩放矩阵。
|
||||
|
||||
**参数:**
|
||||
- `scale` - 各轴缩放因子
|
||||
|
||||
**返回:** `Matrix3` - 缩放矩阵
|
||||
|
||||
**复杂度:** O(1)
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
Matrix3 scale = Matrix3::Scale(Vector3(2.0f, 2.0f, 2.0f));
|
||||
```
|
||||
18
docs/api/math/matrix3/transpose.md
Normal file
18
docs/api/math/matrix3/transpose.md
Normal file
@@ -0,0 +1,18 @@
|
||||
# Matrix3::Transpose
|
||||
|
||||
```cpp
|
||||
Matrix3 Transpose() const
|
||||
```
|
||||
|
||||
返回矩阵的转置。
|
||||
|
||||
**返回:** `Matrix3` - 转置矩阵
|
||||
|
||||
**复杂度:** O(1)
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
Matrix3 mat = ...;
|
||||
Matrix3 transposed = mat.Transpose();
|
||||
```
|
||||
17
docs/api/math/matrix3/zero.md
Normal file
17
docs/api/math/matrix3/zero.md
Normal file
@@ -0,0 +1,17 @@
|
||||
# Matrix3::Zero
|
||||
|
||||
```cpp
|
||||
static Matrix3 Zero()
|
||||
```
|
||||
|
||||
返回零矩阵。
|
||||
|
||||
**返回:** `Matrix3` - 零矩阵
|
||||
|
||||
**复杂度:** O(1)
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
Matrix3 zero = Matrix3::Zero();
|
||||
```
|
||||
Reference in New Issue
Block a user