## Libraries.Game.Collision.Narrowphase.DistanceOutput2D Documentation

This class serves as the container that contains the closest points between shapes A and B on both shape A and shape

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.
Equals(Libraries.Language.Object object)This action determines if two objects are equal based on their hash code values.
GetDistance()This action returns the distance between the cloest point on shape A to shape
GetHashCode()This action gets the hash code for an object.
GetIterations()This action returns how many iterations of the GJK algorithm that was used to solve the distance between shape A and shape
GetPointA()This action returns the closest point on shape A to shape
GetPointB()This action returns the closest point on shape B to shape
SetDistance(number distance)This action sets the distance between the cloest point on shape A to shape
SetIterations(integer iterations)This action sets how many iterations of the GJK algorithm that was used to solve the distance between shape A and shape
SetPointA(Libraries.Compute.Vector2 point)This action sets the closest point on shape A to shape
SetPointB(Libraries.Compute.Vector2 point)This action sets the closest point on shape B to shape

## 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 (smalle``````

#### Return

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

### 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(``````

#### Return

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

### GetDistance()

This action returns the distance between the cloest point on shape A to shape

number:

### 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.

### GetIterations()

This action returns how many iterations of the GJK algorithm that was used to solve the distance between shape A and shape

integer:

### GetPointA()

This action returns the closest point on shape A to shape

### GetPointB()

This action returns the closest point on shape B to shape

### SetDistance(number distance)

This action sets the distance between the cloest point on shape A to shape

### SetIterations(integer iterations)

This action sets how many iterations of the GJK algorithm that was used to solve the distance between shape A and shape

### SetPointA(Libraries.Compute.Vector2 point)

This action sets the closest point on shape A to shape

### SetPointB(Libraries.Compute.Vector2 point)

This action sets the closest point on shape B to shape