Libraries.Game.Physics.VelocityConstraintPoint Documentation

This class is used internally by CollisionSolver2D.

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.
GetNormalImpulse()This action returns the normal impulse.
GetNormalMass()This action returns the effective mass of the object in the normal direction.
GetRadiusA()This action returns the effective radius of object A.
GetRadiusB()This action returns the effective radius of object B.
GetTangentImpulse()This action returns the tangential impulse.
GetTangentMass()This action returns the effective mass of the object in the tangent direction.
GetVelocityBias()This action returns the velocity to subtract from the actual velocity of the object to improve calculations.
SetNormalImpulse(number impulse)This action sets the normal impulse.
SetNormalMass(number mass)This action sets the effective mass of the object in the normal direction.
SetRadiusA(Libraries.Compute.Vector2 radius)This action sets the effective radius of object A.
SetRadiusB(Libraries.Compute.Vector2 radius)This action sets the effective radius of object B.
SetTangentImpulse(number impulse)This action sets the tangential impulse.
SetTangentMass(number mass)This action sets the effective mass of the object in the tangent direction.
SetVelocityBias(number bias)This action sets the velocity to subtract from the actual velocity of the object to improve calculations.

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.

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.

GetNormalMass()

This action returns the effective mass of the object in the normal direction.

Return

number: the effective mass of the object in the normal direction.

GetRadiusA()

This action returns the effective radius of object A.

Return

Libraries.Compute.Vector2: the effective radius of object A.

GetRadiusB()

This action returns the effective radius of object B.

Return

Libraries.Compute.Vector2: the effective radius of object B.

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.

GetTangentMass()

This action returns the effective mass of the object in the tangent direction.

Return

number: the effective mass of the object in the tangent direction.

GetVelocityBias()

This action returns the velocity to subtract from the actual velocity of the object to improve calculations.

Return

number: velocity bias.

SetNormalImpulse(number impulse)

This action sets the normal impulse.

Parameters

SetNormalMass(number mass)

This action sets the effective mass of the object in the normal direction.

Parameters

SetRadiusA(Libraries.Compute.Vector2 radius)

This action sets the effective radius of object A.

Parameters

SetRadiusB(Libraries.Compute.Vector2 radius)

This action sets the effective radius of object B.

Parameters

SetTangentImpulse(number impulse)

This action sets the tangential impulse.

Parameters

SetTangentMass(number mass)

This action sets the effective mass of the object in the tangent direction.

Parameters

SetVelocityBias(number bias)

This action sets the velocity to subtract from the actual velocity of the object to improve calculations.

Parameters