Libraries.Game.Collision.Narrowphase.ConvexConvexCollisionSolverResults Documentation

This class stores the result from a collision of two convex shapes. This class is used by ConvexConvexCollisionSolver.

Inherits from: Libraries.Language.Object

Summary

Variable Summary Table

VariablesDescription
integer DISTANCE_FAILED
integer PENETRATING
integer SEPARATED
integer PENETRATION_FAILED

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.
GetDepth()This action returns the depth of penetration when two objects collide.
GetDistanceIterations()This action returns how many iterations that the distance solver has been in use.
GetHashCode()This action gets the hash code for an object.
GetNormal()This action returns the direction that you should move the objects so that they are not penetrating anymore.
GetPenetrationIterations()This action returns how many iterations that the penetration solver has been in use.
GetStatus()This action returns whether the two objects have penetrated, separated, or if any of the distance or penetration solvers have failed.
GetWitness()This action gets an array that stores the closest points of two colliding objects relative to each other.
SetDepth(number depth)This action sets the depth of penetration when two objects collide.
SetDistanceIterations(integer iterations)This action sets how many iterations that the distance solver has been in use.
SetNormal(Libraries.Compute.Vector3 normal)This action sets the direction that you should move the objects so that they are not penetrating anymore.
SetPenetrationIterations(integer iterations)This action sets how many iterations that the penetration solver has been in use.
SetStatus(integer status)This action sets whether the two objects have penetrated, separated, or if any of the distance or penetration solvers have failed.

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.

GetDepth()

This action returns the depth of penetration when two objects collide.

Return

number:

GetDistanceIterations()

This action returns how many iterations that the distance solver has been in use.

Return

integer:

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.

GetNormal()

This action returns the direction that you should move the objects so that they are not penetrating anymore.

Return

Libraries.Compute.Vector3:

GetPenetrationIterations()

This action returns how many iterations that the penetration solver has been in use.

Return

integer:

GetStatus()

This action returns whether the two objects have penetrated, separated, or if any of the distance or penetration solvers have failed.

Return

integer:

GetWitness()

This action gets an array that stores the closest points of two colliding objects relative to each other.

Return

Libraries.Containers.Array:

SetDepth(number depth)

This action sets the depth of penetration when two objects collide.

Parameters

SetDistanceIterations(integer iterations)

This action sets how many iterations that the distance solver has been in use.

Parameters

SetNormal(Libraries.Compute.Vector3 normal)

This action sets the direction that you should move the objects so that they are not penetrating anymore.

Parameters

SetPenetrationIterations(integer iterations)

This action sets how many iterations that the penetration solver has been in use.

Parameters

SetStatus(integer status)

This action sets whether the two objects have penetrated, separated, or if any of the distance or penetration solvers have failed.

Parameters