[This is preliminary documentation and is subject to change.]
Calculates the distance between a vector and a
ISpatial, ignoring the Z-component.
Namespace:
Rage
Assembly:
RagePluginHook (in RagePluginHook.dll) Version: 0.0.0.0 (0.56.1131.11510)
public static float DistanceSquared(
Vector3 value1,
ISpatial spatialObject
)
Public Shared Function DistanceSquared (
value1 As Vector3,
spatialObject As ISpatial
) As Single
public:
static float DistanceSquared(
Vector3 value1,
ISpatial^ spatialObject
)
Parameters
- value1
- Type: RageVector3
The first vector. - spatialObject
- Type: RageISpatial
The ISpatial.
Return Value
Type:
SingleThe squared distance between the vector and the
ISpatial.
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
