Share via


Vector3.DistanceSquared Method (Vector3, Vector3, Single)

Calculates the distance between two vectors squared.

Namespace: Microsoft.Xna.Framework
Assembly: Microsoft.Xna.Framework (in microsoft.xna.framework.dll)

Syntax

public static void DistanceSquared (
         ref Vector3 value1,
         ref Vector3 value2,
         out float result
)

Parameters

  • value1
    Source vector.
  • value2
    Source vector.
  • result
    [OutAttribute] The distance between the two vectors squared.

Remarks

Distance is calculated with the formula:

Bb196325.distance(en-US,XNAGameStudio.10).png

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.

See Also

Reference

Vector3 Structure
Vector3 Members
Microsoft.Xna.Framework Namespace

Platforms

Xbox 360, Windows XP SP2, Windows Vista