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:
31
docs/api/components/transform-component/get-forward.md
Normal file
31
docs/api/components/transform-component/get-forward.md
Normal file
@@ -0,0 +1,31 @@
|
||||
# GetForward
|
||||
|
||||
Get the forward direction vector in world space.
|
||||
|
||||
## Syntax
|
||||
|
||||
```cpp
|
||||
Math::Vector3 GetForward() const;
|
||||
```
|
||||
|
||||
## Returns
|
||||
|
||||
Returns the forward direction vector as a `Math::Vector3`.
|
||||
|
||||
## Remarks
|
||||
|
||||
Returns the forward direction of this transform in world space, based on the world rotation. By convention, forward is typically the negative Z axis direction.
|
||||
|
||||
## See Also
|
||||
|
||||
- [GetRight](get-right)
|
||||
- [GetUp](get-up)
|
||||
|
||||
## Examples
|
||||
|
||||
```cpp
|
||||
void Example(TransformComponent* transform) {
|
||||
Math::Vector3 forward = transform->GetForward();
|
||||
XC_LOG_INFO("Forward: ({}, {}, {})", forward.x, forward.y, forward.z);
|
||||
}
|
||||
```
|
||||
Reference in New Issue
Block a user