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

Inherits from: Libraries.Language.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.

#### Return

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

Example

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

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

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

#### Return

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

Example

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

### GetDistance()

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

number:

### GetHashCode()

This action gets the hash code for an object.

#### Return

integer: The integer hash code of the object.

Example

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

### GetIterations()

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

integer:

### GetPointA()

This action returns the closest point on shape A to shape B.

### GetPointB()

This action returns the closest point on shape B to shape A.

### SetDistance(number distance)

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

#### Parameters

• number distance

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

#### Parameters

• integer iterations

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

This action sets the closest point on shape A to shape B.

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

This action sets the closest point on shape B to shape A.