Files
XCSDD/docs/api/math/vector2/vector2.md

58 lines
1.7 KiB
Markdown
Raw Normal View History

# Vector2
2D 向量结构体,用于表示 2D 空间中的点、方向或颜色。
**头文件:** `#include <XCEngine/Math/Vector2.h>`
**命名空间:** `XCEngine::Math`
## 结构体定义
```cpp
struct Vector2 {
float x = 0.0f;
float y = 0.0f;
};
```
## 静态工厂方法
| 方法 | 返回值 | 描述 |
|------|--------|------|
| [Zero()](zero.md) | `Vector2` | 返回 (0, 0) |
| [One()](one.md) | `Vector2` | 返回 (1, 1) |
| [Up()](up.md) | `Vector2` | 返回 (0, 1),上方向 |
| [Down()](down.md) | `Vector2` | 返回 (0, -1),下方向 |
| [Right()](right.md) | `Vector2` | 返回 (1, 0),右方向 |
| [Left()](left.md) | `Vector2` | 返回 (-1, 0),左方向 |
## 静态数学方法
| 方法 | 返回值 | 描述 |
|------|--------|------|
| [Dot(a, b)](dot.md) | `float` | 点积 |
| [Cross(a, b)](cross.md) | `float` | 2D 叉积(返回标量) |
| [Normalize(v)](normalize.md) | `Vector2` | 归一化向量 |
| [Magnitude(v)](magnitude.md) | `float` | 向量长度 |
| [SqrMagnitude(v)](sqrmagnitude.md) | `float` | 长度平方(更快) |
| [Lerp(a, b, t)](lerp.md) | `Vector2` | 线性插值 |
| [MoveTowards(current, target, maxDistance)](movetowards.md) | `Vector2` | 朝目标移动 |
## 实例方法
| 方法 | 返回值 | 描述 |
|------|--------|------|
| [Magnitude()](magnitude.md) | `float` | 获取向量长度 |
| [SqrMagnitude()](sqrmagnitude.md) | `float` | 获取长度平方 |
| [Normalized()](normalized.md) | `Vector2` | 获取归一化副本 |
## 运算符
- 算术: `+`, `-`, `*` (scalar), `/` (scalar)
- 复合赋值: `+=`, `-=`, `*=`, `/=`
- 比较: `==`, `!=`
## 相关文档
- [Math 模块总览](../math.md) - 返回 Math 模块总览