Libraries.Game.Collision.ClipVertex2D Documentation

This class contains the data needed for the CollisionEvent2D class to store the clipping points of a shape that has collided.

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 the type of collision that happened to the shape that is associated with this ClipVertex2D.
GetVertex()This action returns best estimate of the point of contact of a shape with another shape.
Set(Libraries.Game.Collision.ClipVertex2D clipVertex)This action sets the variables in this ClipVertex2D class using another ClipVertex2D class.
SetIdentifier(Libraries.Game.Collision.CollisionIdentifier2D identifier)This action sets the type of collision that happened to the shape that is associated with this ClipVertex2D.
SetVertex(Libraries.Compute.Vector2 vertex)This action sets the best estimate of the point of contact of a shape with another shape, which is calculated in actions inside the CollisionEvent2D class.

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 the type of collision that happened to the shape that is associated with this ClipVertex2D.

Return

Libraries.Game.Collision.CollisionIdentifier2D: the type of collision that happened to the shape that is associated with this ClipVertex2D.

GetVertex()

This action returns best estimate of the point of contact of a shape with another shape.

Return

Libraries.Compute.Vector2: the best estimate of the point of contact of a shape with another shape.

Set(Libraries.Game.Collision.ClipVertex2D clipVertex)

This action sets the variables in this ClipVertex2D class using another ClipVertex2D class.

Parameters

SetIdentifier(Libraries.Game.Collision.CollisionIdentifier2D identifier)

This action sets the type of collision that happened to the shape that is associated with this ClipVertex2D.

Parameters

SetVertex(Libraries.Compute.Vector2 vertex)

This action sets the best estimate of the point of contact of a shape with another shape, which is calculated in actions inside the CollisionEvent2D class.

Parameters