Back to class index
float2[Class Summary]
x
y
zero[static][const]
one[static][const]
unitX[static][const]
unitY[static][const]
nan[static][const]
inf[static][const]
ctor (+3 overloads)
ptr() (+1 overload)
operator[](index) (+1 overload)
At(index) (+1 overload)
operators +,-,*,/(v)[const] (+1 overload)
operators +=,-=,*=,/=(v)
Add/Sub/Mul/Div(v)[const] (+1 overload)
xx/xy/yx/yy()[const]
Swizzled(i,j,k,l)[const] (+2 overloads)
SetFromScalar(scalar)
Set(x,y)
SetFromPolarCoordinates(theta,length) (+1 overload)
ToPolarCoordinates()[const]
AimedAngle()[const]
Length()[const]
LengthSq()[const]
Normalize()
Normalized()[const]
ScaleToLength(newLength)
ScaledToLength(newLength)[const]
IsNormalized(epsilonSq)[const]
IsZero(epsilonSq)[const]
IsFinite()[const]
IsPerpendicular(other,epsilonSq)[const]
Equals(other,epsilon)[const] (+1 overload)
BitEquals(other)[const]
ToString()[const]
SerializeToString()[const]
SerializeToCodeString()[const]
SumOfElements()[const]
ProductOfElements()[const]
AverageOfElements()[const]
MinElement()[const]
MinElementIndex()[const]
MaxElement()[const]
MaxElementIndex()[const]
Abs()[const]
Neg()[const]
Recip()[const]
Min(ceil)[const] (+1 overload)
Max(floor)[const] (+1 overload)
Clamp(floor,ceil)[const] (+1 overload)
Clamp01()[const]
Distance(point)[const]
DistanceSq(point)[const]
Dot(v)[const]
Perp()[const]
PerpDot(rhs)[const]
Rotate90CW()
Rotated90CW()[const]
Rotate90CCW()
Rotated90CCW()[const]
Reflect(normal)[const]
Refract(...)[const]
ProjectTo(direction)[const]
ProjectToNorm(direction)[const]
AngleBetween(other)[const]
AngleBetweenNorm(normalizedVector)[const]
Decompose(...)[const]
Lerp(b,t)[const]
FromScalar(scalar)[static]
FromPolarCoordinates(theta,length)[static] (+1 overload)
FromString(str,outEndStr)[static] (+1 overload)
Lerp(a,b,t)[static]
Orthogonalize(a,b)[static]
AreOrthogonal(a,b,epsilon)[static]
Orthonormalize(a,b)[static]
OrientedCCW(a,b,c)[static]
ConvexHull(...)[static]
ConvexHullInPlace(...)[static]
ConvexHullContains(...)[static]
MinAreaRectInPlace(...)[static]
RandomDir(lcg,length)[static]
RandomBox(...)[static]

float2::AimedAngle

Syntax

float float2::AimedAngle() const; [5 lines of code]

Returns the aimed angle direction of this vector, in radians.

The aimed angle of a 2D vector corresponds to the theta part (or azimuth) of the polar coordinate representation of this vector. Essentially, describes the direction this vector is pointing at. A vector pointing towards +X returns 0, vector pointing towards +Y returns pi/2, vector pointing towards -X returns pi, and a vector pointing towards -Y returns -pi/2 (equal to 3pi/2).

Note
This vector does not need to be normalized for this function to work, but it DOES need to be non-zero (unlike the function ToPolarCoordinates).

Return Value

The aimed angle in the range ]-pi/2, pi/2].

See Also

ToPolarCoordinates, FromPolarCoordinates, SetFromPolarCoordinates.