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
This commit is contained in:
26
docs/api/components/transform-component/translate.md
Normal file
26
docs/api/components/transform-component/translate.md
Normal file
@@ -0,0 +1,26 @@
|
||||
# Translate
|
||||
|
||||
Move the transform by the specified translation.
|
||||
|
||||
## Syntax
|
||||
|
||||
```cpp
|
||||
void Translate(const Math::Vector3& translation, Space relativeTo = Space::Self);
|
||||
```
|
||||
|
||||
## Parameters
|
||||
|
||||
- `translation` - The translation vector.
|
||||
- `relativeTo` - Whether the translation is relative to self or world space.
|
||||
|
||||
## Remarks
|
||||
|
||||
Moves the transform by the specified amount. When `relativeTo` is `Space::Self`, the translation is applied in local space. When `Space::World`, the translation is applied in world space.
|
||||
|
||||
## Examples
|
||||
|
||||
```cpp
|
||||
void Example(TransformComponent* transform) {
|
||||
transform->Translate(Math::Vector3(0.0f, 0.0f, 10.0f), Space::Self);
|
||||
}
|
||||
```
|
||||
Reference in New Issue
Block a user