🔢 Quat
Floating point Quaternion that can represent a rotation about an axis in 3-D space
👐Open Source
This library implementation is Open Sourced on GitHub!
🧑💻API Source
This page is auto-generated! The Functions, Properties and Events described here are defined in our GitHub's API Repository! Feel free to commit suggestions and changes to the source .json API files!
🎒 Examples
local new_quaternion = Quat(0.5, 0.5, 1, -1)
local rotation = new_quaterion:Rotator()
🛠 Constructors
Default Constructor
No description provided
local my_quat = Quat(X?, Y?, Z?, W?)
Parameters
| Type | Name | Default | Description |
|---|---|---|---|
| number | X | 0 | The quaternion's X-component |
| number | Y | X | The quaternion's Y-component |
| number | Z | X | The quaternion's Z-component |
| number | W | X | The quaternion's W-component |
🧽 Properties
| Type | Name | Description |
|---|---|---|
| number | X | The quaternion's X-component |
| number | Y | The quaternion's Y-component |
| number | Z | The quaternion's Z-component |
| number | W | The quaternion's W-component |
🦠 Functions
info
This structure supports *, +, - and tostring operations.
| Returns | Name | Description | |
|---|---|---|---|
Normalize | In place normalize this Quaternion | ||
| Rotator | Rotator | Get the Rotator representation of this Quaternion | |
| Quat | Inverse | Returns the inverse of this Quaternion | |
| Vector | RotateVector | Rotates a vector by this Quaternion | |
| Vector | UnrotateVector | Unrotates a vector by this Quaternion | |
| Vector | GetForwardVector | Get the forward direction vector from this Quaternion | |
| Vector | GetRightVector | Get the right direction vector from this Quaternion | |
| Vector | GetUpVector | Get the up direction vector from this Quaternion |
Normalize
In place normalize this Quaternion
my_quat:Normalize()
Rotator
Get the Rotator representation of this Quaternion
local ret = my_quat:Rotator()
Returns
| Type | Description |
|---|---|
| Rotator | Rotator representation of this Quaternion |
Inverse
Returns the inverse of this Quaternion
local ret = my_quat:Inverse()
Returns
| Type | Description |
|---|---|
| Quat | Inverse of this Quaternion |
RotateVector
Rotates a vector by this Quaternion
local ret = my_quat:RotateVector(vector)
Parameters
| Type | Parameter | Default | Description |
|---|---|---|---|
| Vector | vector | Required parameter | Vector to rotate |
Returns
| Type | Description |
|---|---|
| Vector | Rotated vector |
UnrotateVector
Unrotates a vector by this Quaternion
local ret = my_quat:UnrotateVector(vector)
Parameters
| Type | Parameter | Default | Description |
|---|---|---|---|
| Vector | vector | Required parameter | Vector to unrotate |
Returns
| Type | Description |
|---|---|
| Vector | Unrotated vector |
GetForwardVector
Get the forward direction vector from this Quaternion
local ret = my_quat:GetForwardVector()
Returns
| Type | Description |
|---|---|
| Vector | Forward vector |
GetRightVector
Get the right direction vector from this Quaternion
local ret = my_quat:GetRightVector()
Returns
| Type | Description |
|---|---|
| Vector | Right vector |
GetUpVector
Get the up direction vector from this Quaternion
local ret = my_quat:GetUpVector()
Returns
| Type | Description |
|---|---|
| Vector | Up vector |
