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

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.
GetHashCode()This action gets the hash code for an object.
GetIdentifier()This action returns what type of collision was involved.
GetLocalPoint()This action returns the local point.
GetNormalImpulse()This action returns the normal impulse.
GetTangentImpulse()This action returns the tangential impulse.
Set(Libraries.Game.Collision.CollisionPoint2D point)This action sets the current CollisionPoint2D using another CollisionPoint2D.
SetLocalPoint(Libraries.Compute.Vector2 localPoint)This action sets the local point.
SetNormalImpulse(number normalImpulse)This action sets the normal impulse.
SetTangentImpulse(number tangentImpulse)This action sets the tangential impulse.

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.

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.

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

SetTangentImpulse(number tangentImpulse)

This action sets the tangential impulse.

Parameters