Libraries.Game.Collision.Narrowphase.ConvexConvexFace Documentation

This class stores the faces given in terms of vertices of the face of a polyhedron.

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.
GetDistance()This action gets the distance from this face to the global origin.
GetEdges()This action returns all of the edges of the face.
GetFaces()This action gets all of the faces that is a part of the polyhedron that contains the current ConvexConvexFace.
GetHashCode()This action gets the hash code for an object.
GetMark()This action returns whether this face has been checked in the calculation of building a shape (polytope) that will allow us to calculate the distance between a convex shape and the origin.
GetNext()This action returns a ConvexConvexFace that is linked to the back of the current ConvexConvexFace.
GetNormal()This action returns a vector that is perpendicular to the face.
GetPrevious()This action returns a ConvexConvexFace that is linked in front of the current ConvexConvexFace.
GetVertices()This action gets all of the vertices for a face.
SetDistance(number distance)This action sets the distance from this face to the global origin.
SetMark(integer mark)This action sets whether this face has been checked in the calculation of building a shape (polytope) that will allow us to calculate the distance between a convex shape and the origin.
SetNext(Libraries.Game.Collision.Narrowphase.ConvexConvexFace face)This action sets a ConvexConvexFace that is linked to the back of the current ConvexConvexFace.
SetNormal(Libraries.Compute.Vector3 normal)This action sets a vector that is perpendicular to the face.
SetPrevious(Libraries.Game.Collision.Narrowphase.ConvexConvexFace face)This action sets a ConvexConvexFace that is linked in front of the current ConvexConvexFace.

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.

GetDistance()

This action gets the distance from this face to the global origin.

Return

number:

GetEdges()

This action returns all of the edges of the face.

Return

Libraries.Containers.Array:

GetFaces()

This action gets all of the faces that is a part of the polyhedron that contains the current ConvexConvexFace.

Return

Libraries.Containers.Array:

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.

GetMark()

This action returns whether this face has been checked in the calculation of building a shape (polytope) that will allow us to calculate the distance between a convex shape and the origin.

Return

integer:

GetNext()

This action returns a ConvexConvexFace that is linked to the back of the current ConvexConvexFace.

Return

Libraries.Game.Collision.Narrowphase.ConvexConvexFace:

GetNormal()

This action returns a vector that is perpendicular to the face.

Return

Libraries.Compute.Vector3:

GetPrevious()

This action returns a ConvexConvexFace that is linked in front of the current ConvexConvexFace.

Return

Libraries.Game.Collision.Narrowphase.ConvexConvexFace:

GetVertices()

This action gets all of the vertices for a face.

Return

Libraries.Containers.Array:

SetDistance(number distance)

This action sets the distance from this face to the global origin.

Parameters

SetMark(integer mark)

This action sets whether this face has been checked in the calculation of building a shape (polytope) that will allow us to calculate the distance between a convex shape and the origin.

Parameters

SetNext(Libraries.Game.Collision.Narrowphase.ConvexConvexFace face)

This action sets a ConvexConvexFace that is linked to the back of the current ConvexConvexFace.

Parameters

SetNormal(Libraries.Compute.Vector3 normal)

This action sets a vector that is perpendicular to the face.

Parameters

SetPrevious(Libraries.Game.Collision.Narrowphase.ConvexConvexFace face)

This action sets a ConvexConvexFace that is linked in front of the current ConvexConvexFace.

Parameters