31 lines
517 B
Markdown
31 lines
517 B
Markdown
|
# GetUp
|
||
|
|
|
||
|
|
Get the up direction vector in world space.
|
||
|
|
|
||
|
|
## Syntax
|
||
|
|
|
||
|
|
```cpp
|
||
|
|
Math::Vector3 GetUp() const;
|
||
|
|
```
|
||
|
|
|
||
|
|
## Returns
|
||
|
|
|
||
|
|
Returns the up direction vector as a `Math::Vector3`.
|
||
|
|
|
||
|
|
## Remarks
|
||
|
|
|
||
|
|
Returns the up direction of this transform in world space, based on the world rotation. By convention, up is typically the positive Y axis direction.
|
||
|
|
|
||
|
|
## See Also
|
||
|
|
|
||
|
|
- [GetForward](get-forward)
|
||
|
|
- [GetRight](get-right)
|
||
|
|
|
||
|
|
## Examples
|
||
|
|
|
||
|
|
```cpp
|
||
|
|
void Example(TransformComponent* transform) {
|
||
|
|
Math::Vector3 up = transform->GetUp();
|
||
|
|
}
|
||
|
|
```
|