[This is preliminary documentation and is subject to change.]
Calculates the squared distance between two vectors.
Namespace:
Rage
Assembly:
RagePluginHook (in RagePluginHook.dll) Version: 0.0.0.0 (0.56.1131.11510)
public static float DistanceSquared(
Vector2 value1,
Vector2 value2
)
Public Shared Function DistanceSquared (
value1 As Vector2,
value2 As Vector2
) As Single
public:
static float DistanceSquared(
Vector2 value1,
Vector2 value2
)
Parameters
- value1
- Type: RageVector2
The first vector. - value2
- Type: RageVector2
The second vector.
Return Value
Type:
SingleThe squared distance between the two vectors.
Distance squared is the value before taking the square root.
Distance squared can often be used in place of distance if relative comparisons are being made.
For example, consider three points A, B, and C. To determine whether B or C is further from A,
compare the distance between A and B to the distance between A and C. Calculating the two distances
involves two square roots, which are computationally expensive. However, using distance squared
provides the same information and avoids calculating two square roots.
Reference
