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

Summary

Actions Summary Table

ActionsDescription
Compare(Libraries.Language.Object object)This action compares two object hash codes and returns a CompareResult.
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 B.
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 B.
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.
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.
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.

Actions Documentation

Compare(Libraries.Language.Object object)

This action compares two object hash codes and returns a CompareResult. The compare result is either larger if this hash code is larger than the object passed as a parameter, smaller, or equal.

Example Code

use Libraries.Language.Support.CompareResult
        Object o
        Object t
        CompareResult result = o:Compare(t)

Parameters

Return

Libraries.Language.Support.CompareResult: 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(t)

Parameters

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

Return

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

Return

integer:

GetPointA()

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

Return

Libraries.Compute.Vector2:

GetPointB()

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

Return

Libraries.Compute.Vector2:

SetDistance(number distance)

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

Parameters

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

SetPointA(Libraries.Compute.Vector2 point)

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

Parameters

SetPointB(Libraries.Compute.Vector2 point)

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

Parameters