Libraries.Game.Physics.PositionSolver Documentation
This class contains variables and actions to help solving for the position constraint. This class is used by the CollisionSolver2D class.
Inherits from: Libraries.Language.Object
Summary
Actions Summary Table
Actions | Description |
---|---|
Compare(Libraries.Language.Object object) | This action compares two object hash codes and returns an integer. |
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. |
GetNormal() | This action returns the normal vector of this collision. |
GetPoint() | This action returns the clipping point of this collision. |
GetSeparation() | This action returns the minimum distance between the two objects colliding. |
Initialize(Libraries.Game.Physics.CollisionPositionConstraint pc, Libraries.Game.Collision.PhysicsPosition2D xfA, Libraries.Game.Collision.PhysicsPosition2D xfB, integer index) | This action initializes the variables stored inside this class. |
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.
Example Code
Object o
Object t
integer result = o:Compare(t) //1 (larger), 0 (equal), or -1 (smaller)
Parameters
- Libraries.Language.Object: The object to compare to.
Return
integer: 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
- Libraries.Language.Object: The to be compared.
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.
GetNormal()
This action returns the normal vector of this collision.
Return
Libraries.Compute.Vector2: the normal vector of this collision.
GetPoint()
This action returns the clipping point of this collision.
Return
Libraries.Compute.Vector2: the clipping point of this collision.
GetSeparation()
This action returns the minimum distance between the two objects colliding.
Return
number: the minimum distance between the two objects colliding.
Initialize(Libraries.Game.Physics.CollisionPositionConstraint pc, Libraries.Game.Collision.PhysicsPosition2D xfA, Libraries.Game.Collision.PhysicsPosition2D xfB, integer index)
This action initializes the variables stored inside this class.
Parameters
- Libraries.Game.Physics.CollisionPositionConstraint: The position constraint for a particular collision.
- Libraries.Game.Collision.PhysicsPosition2D: The position and tilt of object A.
- Libraries.Game.Collision.PhysicsPosition2D: The position and tilt of object B.
- integer index: The number of collision points was recorded in this collision.