## Libraries.Game.Collision.Narrowphase.Distance2D Documentation

This class calculates the closest distance between two objects. The algorithm that this class uses is the GJK algorithm, which finds the distance between two convex shapes.

Inherits from: Libraries.Language.Object

## Summary

### Actions Summary Table

ActionsDescription
Compare(Libraries.Language.Object object)This action compares two object hash codes and returns an integer.
Distance(Libraries.Game.Collision.Narrowphase.DistanceOutput2D out, Libraries.Game.Collision.Narrowphase.SimplexCache2D cache, Libraries.Game.Collision.Narrowphase.DistanceInput2D in)This calculates the minimum distances between two objects and saves the result in "DistanceOutput2D out.
Equals(Libraries.Language.Object object)This action determines if two objects are equal based on their hash code values.
GetHashCode()This action gets the hash code for an object.

## Actions Documentation

### Compare(Libraries.Language.Object object)

This action compares two object hash codes and returns an integer. The result is larger if this hash code is larger than the object passed as a parameter, smaller, or equal. In this case, -1 means smaller, 0 means equal, and 1 means larger. This action was changed in Quorum 7 to return an integer, instead of a CompareResult object, because the previous implementation was causing efficiency issues.

Example Code

``````Object o
Object t
integer result = o:Compare(t) //1 (larger), 0 (equal), or -1 (smaller)``````

#### Return

integer: The Compare result, Smaller, Equal, or Larger.

### Distance(Libraries.Game.Collision.Narrowphase.DistanceOutput2D out, Libraries.Game.Collision.Narrowphase.SimplexCache2D cache, Libraries.Game.Collision.Narrowphase.DistanceInput2D in)

This calculates the minimum distances between two objects and saves the result in "DistanceOutput2D out."

### Equals(Libraries.Language.Object object)

This action determines if two objects are equal based on their hash code values.

Example Code

``````use Libraries.Language.Object
use Libraries.Language.Types.Text
Object o
Text t
boolean result = o:Equals(t)``````

#### Return

boolean: True if the hash codes are equal and false if they are not equal.

### GetHashCode()

This action gets the hash code for an object.

Example Code

``````Object o
integer hash = o:GetHashCode()``````

#### Return

integer: The integer hash code of the object.