Libraries.Game.Collision.EdgeResult2D Documentation

This class stores the variables necessary to store the results from the FindMaxSeparation action in the class CollisionEvent2D.

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.

Parameters

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.

Parameters

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)

GetEdgeIndex()

This action returns the index of the edge that is associated with the "separation" in this EdgeResults2D.

Return

integer: the index of the edge.

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()

GetSeparation()

This action returns the separation between the two vertices calculated from the FindMaxSeparation action in the class CollisionEvent2D.

Return

number: the separation between the two vertices.

SetEdgeIndex(integer edgeIndex)

This action sets the index of the edge that is associated with the "separation" in this EdgeResults2D. The calculation is done in the FindMaxSeparation action in the class CollisionEvent2D.

Parameters

  • integer edgeIndex: The index of the edge.

SetSeparation(number separation)

This action is used by the FindMaxSeparation action in the class CollisionEvent2D to set the maximum separation between two vertices.

Parameters

  • number separation: The separation between the two vertices.