Module |
|
Header |
/Engine/Source/Runtime/Core/Public/Math/Rotator.h |
Include |
#include "Math/Rotator.h" |
struct FRotator
Implements a container for rotation information.
All rotation values are stored in degrees.
Name | Description | ||
---|---|---|---|
|
float |
Pitch |
Rotation around the right axis (around Y axis), Looking up and down (0=Straight Ahead, +Up, -Down) |
|
float |
Roll |
Rotation around the forward axis (around X axis), Tilting your head, 0=Straight, +Clockwise, -CCW. |
|
float |
Yaw |
Rotation around the up axis (around Z axis), Running in circles 0=East, +North, -South. |
Name | Description | |
---|---|---|
|
FRotator() |
Default constructor (no initialization). |
|
FRotator ( |
Constructor |
|
FRotator ( |
Constructor. |
|
FRotator ( |
Constructor. |
|
FRotator ( |
Constructor. |
Name | Description | ||
---|---|---|---|
|
Add ( |
Adds to each component of the rotator. |
|
|
Clamp() |
Gets the rotation values so they fall within the range [0,360] |
|
|
float |
ClampAxis ( |
Clamps an angle to the range of [0, 360). |
|
CompressAxisToByte ( |
Compresses a floating point angle into a byte. |
|
|
CompressAxisToShort ( |
Compress a floating point angle into a word. |
|
|
ContainsNaN() |
Utility to check if there are any non-finite values (NaN or Inf) in this Rotator. |
|
|
float |
DecompressAxisFromByte ( |
Decompress a word into a floating point angle. |
|
float |
DecompressAxisFromShort ( |
Decompress a short into a floating point angle. |
|
DiagnosticCheckNaN ( |
||
|
DiagnosticCheckNaN() |
||
|
Equals ( |
Checks whether two rotators are equal within specified tolerance, when treated as an orientation. |
|
|
Euler() |
Convert a Rotator into floating-point Euler angles (in degrees). Rotator now stored in degrees. |
|
|
float |
GetComponentForAxis ( |
Get a specific component of the vector, given a specific axis by enum |
|
GetDenormalized() |
Create a copy of this rotator and denormalize, clamping each axis to 0 - 360. |
|
|
GetEquivalentRotator() |
Return a Rotator that has the same rotation but has different degree values for Yaw, Pitch, and Roll. |
|
|
GetInverse() |
Returns the inverse of the rotator. |
|
|
float |
GetManhattanDistance ( |
Return the manhattan distance in degrees between this Rotator and the passed in one. |
|
GetNormalized() |
Create a copy of this rotator and normalize, removes all winding and creates the "shortest route" rotation. |
|
|
GetWindingAndRemainder |
Decompose this Rotator into a Winding part (multiples of 360) and a Remainder part. |
|
|
GridSnap ( |
Get the rotation, snapped to specified degree segments. |
|
|
InitFromString ( |
Initialize this Rotator based on an FString. |
|
|
IsNearlyZero ( |
Checks whether rotator is nearly zero within specified tolerance, when treated as an orientation. |
|
|
IsZero() |
Checks whether this has exactly zero rotation, when treated as an orientation. |
|
|
MakeFromEuler ( |
Convert a vector of floating-point Euler angles (in degrees) into a Rotator. |
|
|
NetSerialize ( |
||
|
Normalize() |
In-place normalize, removes all winding and creates the "shortest route" rotation. |
|
|
float |
NormalizeAxis ( |
Clamps an angle to the range of (-180, 180]. |
|
Quaternion() |
Get Rotation as a quaternion. |
|
|
RotateVector ( |
Rotate a vector rotated by this rotator. |
|
|
Serialize ( |
||
|
SerializeCompressed ( |
Serializes the rotator compressed for e.g. network transmission. |
|
|
SerializeCompressedShort ( |
Serializes the rotator compressed for e.g. network transmission (use shorts though). |
|
|
SetClosestToMe ( |
Modify if necessary the passed in rotator to be the closest rotator to it based upon it's equivalent. |
|
|
SetComponentForAxis ( |
Set a specified componet of the vector, given a specific axis by enum |
|
|
ToCompactString() |
Get a short textural representation of this vector, for compact readable logging. |
|
|
ToString() |
Get a textual representation of the vector. |
|
|
UnrotateVector ( |
Returns the vector rotated by the inverse of this rotator. |
|
|
Vector() |
Convert a rotation into a unit vector facing in its direction. |
Name | Description | ||
---|---|---|---|
|
operator- ( |
Get the result of subtracting a rotator from this. |
|
|
operator!= ( |
Checks whether two rotators are different. |
|
|
operator* ( |
Get the result of scaling this rotator. |
|
|
operator*= ( |
Multiply this rotator by a scaling factor. |
|
|
operator+ ( |
Get the result of adding a rotator to this. |
|
|
operator+= ( |
Adds another rotator to this. |
|
|
operator-= ( |
Subtracts another rotator from this. |
|
|
operator== ( |
Checks whether two rotators are identical. This checks each component for exact equality. |
Name |
Description |
---|---|
ZeroRotator |
A rotator of zero degrees on each axis. |