docs: update math API docs
This commit is contained in:
@@ -1,17 +1,44 @@
|
||||
# Transform::Inverse
|
||||
|
||||
```cpp
|
||||
Transform Inverse() const
|
||||
Transform Inverse() const;
|
||||
```
|
||||
|
||||
返回变换的逆。
|
||||
返回当前变换的逆变换。逆变换满足 `transform * transform.Inverse() == Identity()`。
|
||||
|
||||
**返回:** `Transform` - 逆变换
|
||||
计算方式:
|
||||
- 旋转取反:先计算旋转的逆(四元数共轭)
|
||||
- 缩放送原:取倒数
|
||||
- 位置:将原点相对于当前点的偏移,经逆旋转和逆缩放后取反
|
||||
|
||||
**参数:** 无
|
||||
|
||||
**返回:** `Transform` - 当前变换的逆变换
|
||||
|
||||
**线程安全:** ❌(无锁,非线程安全)
|
||||
|
||||
**复杂度:** O(1)
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
Transform inv = transform.Inverse();
|
||||
#include "XCEngine/Math/Transform.h"
|
||||
#include "XCEngine/Math/Vector3.h"
|
||||
|
||||
using namespace XCEngine::Math;
|
||||
|
||||
void InverseExample() {
|
||||
Transform transform;
|
||||
transform.position = Vector3(10.0f, 0.0f, 0.0f);
|
||||
transform.rotation = Quaternion::Identity();
|
||||
transform.scale = Vector3(2.0f, 2.0f, 2.0f);
|
||||
|
||||
Transform inverse = transform.Inverse();
|
||||
|
||||
Transform identity = transform * inverse;
|
||||
}
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [Transform](transform.md) - 返回类总览
|
||||
|
||||
Reference in New Issue
Block a user