Libraries.Game.Collision.CollisionPoint2D Documentation

This class contains the one estimated local collision point for a 2D collision from the perspective of the reference object that is involved in the collision. This class also records what kind of impulses should be applied to the objects to resolve the collision. This class is also known as manifold points. This class is used internally by LocalCollisionPoints2D.

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

GetIdentifier()

This action returns what type of collision was involved.

Return

Libraries.Game.Collision.CollisionIdentifier2D: what type of collision was involved stored inside CollisionIdentifier2D.

GetLocalPoint()

This action returns the local point.

Return

Libraries.Compute.Vector2: one collision point with respect to the object that is not the reference object.

GetNormalImpulse()

This action returns the normal impulse.

Return

number: the magnitude of the impulse that should be applied to separate the two objects in collision.

GetTangentImpulse()

This action returns the tangential impulse.

Return

number: the magnitude of impulse that should be applied to simulate the friction between the two objects during collision.

Set(Libraries.Game.Collision.CollisionPoint2D point)

This action sets the current CollisionPoint2D using another CollisionPoint2D.

Parameters

SetLocalPoint(Libraries.Compute.Vector2 localPoint)

This action sets the local point.

Parameters

SetNormalImpulse(number normalImpulse)

This action sets the normal impulse.

Parameters

  • number normalImpulse: The magnitude of the impulse that should be applied to separate the two objects in collision.

SetTangentImpulse(number tangentImpulse)

This action sets the tangential impulse.

Parameters

  • number tangentImpulse: The magnitude of impulse that should be applied to simulate the friction between the two objects during collision.