Libraries.Game.Collision.CollisionPair Documentation

This class is contains a pair of items that might be colliding with each other. The items can be 2D objects xor 3D objects, where each item is identified by the node number that the item is in in the dynamic bounding volume tree. This class is used internally by BroadphaseCollision2D and BroadphaseCollision3D.

Inherits from: Libraries.Language.Object

Summary

Actions Summary Table

ActionsDescription
Compare(Libraries.Game.Collision.CollisionPair otherPair)This action is used to compare two CollisionPair objects to sort the collision pairs based on node numbers.
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.
GetHashCode()This action gets the hash code for an object.
GetIDA()This action returns the node number of the first item.
GetIDB()This action returns the node number of the second item.
Set(integer nodeIDA, integer nodeIDB)This action records the identifiers of the node that each item is in on a DynamicBoundingVolumeTree.
SetIDA(integer id)This action sets the node number of the first item.
SetIDB(integer id)This action sets the node number of the second item.

Actions Documentation

Compare(Libraries.Game.Collision.CollisionPair otherPair)

This action is used to compare two CollisionPair objects to sort the collision pairs based on node numbers.

Parameters

Return

Libraries.Language.Support.CompareResult: whether the current CollisionPair is SMALLER, EQUAL, or LARGER than the otherPair.

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.

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.

GetIDA()

This action returns the node number of the first item.

Return

integer: the node number of the first item.

GetIDB()

This action returns the node number of the second item.

Return

integer: the node number of the second item.

Set(integer nodeIDA, integer nodeIDB)

This action records the identifiers of the node that each item is in on a DynamicBoundingVolumeTree.

Parameters

SetIDA(integer id)

This action sets the node number of the first item.

Parameters

SetIDB(integer id)

This action sets the node number of the second item.

Parameters