Vector3.DistanceSquared Method (Vector3, Vector3)

Calculates the distance between two vectors squared.

Syntax

'Declaration
Public Shared Function DistanceSquared ( _
         value1 As Vector3, _
         value2 As Vector3 _
) As Single 

public static float DistanceSquared (
         Vector3 value1,
         Vector3 value2
)

public:
static float DistanceSquared(
         Vector3 value1,
         Vector3 value2
)

Parameters

• value1
  Type: Vector3
  Source vector.
• value2
  Type: Vector3
  Source vector.

Return Value

Type: Single
The distance between the source vectors squared.

Remarks

Distance is calculated with the following formula:

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.

Requirements

Namespace: Microsoft.Xna.Framework

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

See Also

Reference

Vector3 Structure
Vector3 Members
Microsoft.Xna.Framework Namespace

Platforms

Windows Phone