Libraries.Game.Collision.Narrowphase.DistanceInput2D Documentation

This class records the vertices of two shapes in collision through the use of the class DistanceProxy2D and also records the tilt and position of two shapes through the use of the class PhysicsPosition2D.

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)

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

GetProxyA()

This action gets the DistanceProxy2D of the second shape in collision.

Return

Libraries.Game.Collision.Narrowphase.DistanceProxy2D:

GetProxyB()

This action gets the DistanceProxy2D of the second shape in collision.

Return

Libraries.Game.Collision.Narrowphase.DistanceProxy2D:

GetTransformA()

This action gets the tilt and position of the first shape in collision.

Return

Libraries.Game.Collision.PhysicsPosition2D:

GetTransformB()

This action gets the tilt and position of the second shape in collision.

Return

Libraries.Game.Collision.PhysicsPosition2D:

GetUseRadii()

This action returns whether this DistanceInput2D class should be using the radii for both shapes.

Return

boolean:

SetProxyA(Libraries.Game.Collision.Narrowphase.DistanceProxy2D proxy)

This action sets the DistanceProxy2D of the first shape in collision.

Parameters

SetProxyB(Libraries.Game.Collision.Narrowphase.DistanceProxy2D proxy)

This action sets the DistanceProxy2D of the second shape in collision.

Parameters

SetTransformA(Libraries.Game.Collision.PhysicsPosition2D transform)

This action associates the tilt and position of the first shape in collision with this DistanceInput2D class.

Parameters

SetTransformB(Libraries.Game.Collision.PhysicsPosition2D transform)

This action associates the tilt and position of the second shape in collision with this DistanceInput2D class.

Parameters

SetUseRadii(boolean flag)

This action allows the DistanceInput2D class to use the radii for both shapes.

Parameters

  • boolean flag