Files
XCEngine/docs/api/components/transform-component/get-local-position.md
ssdfasd a9d5a68dd6 docs: Add Component, GameObject, TransformComponent and Scene API documentation
- Add Component class documentation with lifecycle methods
- Add GameObject class documentation with component system
- Add TransformComponent documentation with transform methods
- Add Scene class documentation with GameObject management
- Add SceneManager singleton documentation with scene loading
- Update components.md overview with all component classes
- Update main.md navigation with Scene module
2026-03-22 03:33:55 +08:00

34 lines
816 B
Markdown

# GetLocalPosition
Get the position of this transform relative to the parent transform.
## Syntax
```cpp
const Math::Vector3& GetLocalPosition() const;
```
## Returns
Returns the local position as a `Math::Vector3` reference. The returned reference remains valid until the transform is modified.
## Remarks
Local position represents the position of this transform in parent space. If this transform has no parent, local position is the same as world position.
## See Also
- [SetLocalPosition](set-local-position)
- [GetPosition](get-position)
- [SetPosition](set-position)
## Examples
```cpp
void Example(TransformComponent* transform) {
const Math::Vector3& localPos = transform->GetLocalPosition();
XC_LOG_INFO("Local position: ({}, {}, {})",
localPos.x, localPos.y, localPos.z);
}
```