docs: sync api and planning docs
This commit is contained in:
@@ -1,30 +1,26 @@
|
||||
# TransformComponent::GetLocalPosition
|
||||
|
||||
获取相关状态或对象。
|
||||
**命名空间**: `XCEngine::Components`
|
||||
|
||||
**类型**: `method`
|
||||
|
||||
**头文件**: `XCEngine/Components/TransformComponent.h`
|
||||
|
||||
## 签名
|
||||
|
||||
```cpp
|
||||
const Math::Vector3& GetLocalPosition() const;
|
||||
```
|
||||
|
||||
该方法声明于 `XCEngine/Components/TransformComponent.h`,当前页面用于固定 `TransformComponent` 类目录下的方法级 canonical 路径。
|
||||
## 作用
|
||||
|
||||
**参数:** 无。
|
||||
返回 `m_localPosition` 当前值。
|
||||
|
||||
**返回:** `const Math::Vector3&` - 返回值语义详见头文件声明。
|
||||
## 当前实现
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Components/TransformComponent.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::Components::TransformComponent object;
|
||||
// 根据上下文补齐参数后调用 TransformComponent::GetLocalPosition(...)。
|
||||
(void)object;
|
||||
}
|
||||
```
|
||||
- 返回 `m_localPosition` 当前值。
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](TransformComponent.md)
|
||||
- [返回模块目录](../Components.md)
|
||||
- [TransformComponent](TransformComponent.md)
|
||||
- [SetLocalPosition](SetLocalPosition.md)
|
||||
|
||||
Reference in New Issue
Block a user