docs: update math API docs
This commit is contained in:
@@ -1,53 +1,71 @@
|
||||
# Vector4
|
||||
|
||||
4D 向量结构体,用于表示齐次坐标、颜色 (RGBA) 或 SIMD 操作。
|
||||
**命名空间**: `XCEngine::Math`
|
||||
|
||||
**头文件:** `#include <XCEngine/Math/Vector4.h>`
|
||||
**类型**: `struct`
|
||||
|
||||
**命名空间:** `XCEngine::Math`
|
||||
**头文件**: `XCEngine/Math/Vector4.h`
|
||||
|
||||
## 结构体定义
|
||||
**描述**: 四维向量,用于齐次坐标变换和四元数相关计算
|
||||
|
||||
## 概述
|
||||
|
||||
Vector4 是四维向量结构体,常用于:
|
||||
- 齐次坐标变换(x, y, z, w)
|
||||
- RGBA 颜色表示
|
||||
- SIMD 矢量操作
|
||||
- 四元数分量存储
|
||||
|
||||
## 结构体成员
|
||||
|
||||
| 成员 | 类型 | 描述 | 默认值 |
|
||||
|------|------|------|--------|
|
||||
| `x` | `float` | X 分量 | `0.0f` |
|
||||
| `y` | `float` | Y 分量 | `0.0f` |
|
||||
| `z` | `float` | Z 分量 | `0.0f` |
|
||||
| `w` | `float` | W 分量(齐次坐标) | `0.0f` |
|
||||
|
||||
## 公共方法
|
||||
|
||||
| 方法 | 描述 |
|
||||
|------|------|
|
||||
| [`Vector4()`](constructor_default.md) | 默认构造函数,创建零向量 |
|
||||
| [`Vector4(x, y, z, w)`](constructor.md) | 从四个分量构造向量 |
|
||||
| [`Vector4(Vector3, w)`](constructor_vector3.md) | 从 Vector3 构造(w 默认 0) |
|
||||
| [`Zero`](zero.md) | 返回零向量 (0, 0, 0, 0) |
|
||||
| [`One`](one.md) | 返回单位向量 (1, 1, 1, 1) |
|
||||
| [`Dot`](dot.md) | 计算两个向量的点积 |
|
||||
| [`Project`](project.md) | 将向量投影到法线向量上 |
|
||||
| [`ToVector3`](tovector3.md) | 转换为 Vector3 |
|
||||
| [`operator[]`](./operator-brackets.md) | 下标访问分量 |
|
||||
| [`operator+`](operator-add.md) | 向量加法 |
|
||||
| [`operator-`](operator-sub.md) | 向量减法 |
|
||||
| [`operator*`](operator-mul.md) | 向量数乘 |
|
||||
| [`operator==`](operator-eq.md) | 相等比较 |
|
||||
| [`operator!=`](operator-ne.md) | 不等比较 |
|
||||
|
||||
## 使用示例
|
||||
|
||||
```cpp
|
||||
struct Vector4 {
|
||||
float x = 0.0f;
|
||||
float y = 0.0f;
|
||||
float z = 0.0f;
|
||||
float w = 0.0f;
|
||||
};
|
||||
#include <XCEngine/Math/Vector4.h>
|
||||
#include <XCEngine/Math/Vector3.h>
|
||||
#include <cstdio>
|
||||
|
||||
int main() {
|
||||
Vector4 a(1.0f, 2.0f, 3.0f, 4.0f);
|
||||
Vector4 b(4.0f, 3.0f, 2.0f, 1.0f);
|
||||
|
||||
Vector4 sum = a + b;
|
||||
Vector4 scaled = a * 2.0f;
|
||||
float dot = Vector4::Dot(a, b);
|
||||
|
||||
Vector4 projected = Vector4::Project(a, Vector4(1.0f, 0.0f, 0.0f, 0.0f));
|
||||
Vector3 v3 = a.ToVector3();
|
||||
|
||||
return 0;
|
||||
}
|
||||
```
|
||||
|
||||
## 构造函数
|
||||
|
||||
- `Vector4(float x, float y, float z, float w)` - 从四个分量构造
|
||||
- `explicit Vector4(const Vector3& v, float w = 0.0f)` - 从 Vector3 构造
|
||||
|
||||
## 静态工厂方法
|
||||
|
||||
| 方法 | 返回值 | 描述 |
|
||||
|------|--------|------|
|
||||
| [Zero()](zero.md) | `Vector4` | 返回 (0, 0, 0, 0) |
|
||||
| [One()](one.md) | `Vector4` | 返回 (1, 1, 1, 1) |
|
||||
|
||||
## 静态数学方法
|
||||
|
||||
| 方法 | 返回值 | 描述 |
|
||||
|------|--------|------|
|
||||
| [Dot(a, b)](dot.md) | `float` | 4D 点积 |
|
||||
| [Project(vector, onNormal)](project.md) | `Vector4` | 投影 |
|
||||
|
||||
## 实例方法
|
||||
|
||||
| 方法 | 返回值 | 描述 |
|
||||
|------|--------|------|
|
||||
| [ToVector3()](tovector3.md) | `Vector3` | 转换到 Vector3(丢弃 w) |
|
||||
|
||||
## 运算符
|
||||
|
||||
- 算术: `+`, `-`, `*` (scalar)
|
||||
- 下标: `operator[]` (0=x, 1=y, 2=z, 3=w)
|
||||
- 比较: `==`, `!=`
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [Math 模块总览](../math.md) - 返回 Math 模块总览
|
||||
- [Math 模块总览](../math.md) - Math 模块总览
|
||||
|
||||
Reference in New Issue
Block a user