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-local-scale.md
Normal file
31
docs/api/components/transform-component/get-local-scale.md
Normal file
@@ -0,0 +1,31 @@
|
||||
# GetLocalScale
|
||||
|
||||
Get the scale of this transform relative to the parent transform.
|
||||
|
||||
## Syntax
|
||||
|
||||
```cpp
|
||||
const Math::Vector3& GetLocalScale() const;
|
||||
```
|
||||
|
||||
## Returns
|
||||
|
||||
Returns the local scale as a `Math::Vector3` reference.
|
||||
|
||||
## Remarks
|
||||
|
||||
Local scale represents the scale of this transform in parent space. If this transform has no parent, local scale is the same as world scale.
|
||||
|
||||
## See Also
|
||||
|
||||
- [SetLocalScale](set-local-scale)
|
||||
- [GetScale](get-scale)
|
||||
|
||||
## Examples
|
||||
|
||||
```cpp
|
||||
void Example(TransformComponent* transform) {
|
||||
const Math::Vector3& scale = transform->GetLocalScale();
|
||||
XC_LOG_INFO("Local scale: ({}, {}, {})", scale.x, scale.y, scale.z);
|
||||
}
|
||||
```
|
||||
Reference in New Issue
Block a user