Libraries.Game.Collision.Item3DNode Documentation

The Item3DNode class represents a node to be contained within a tree. It has an item and a boundingBox plus a node ID and the index of this node among its sibings.

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.
GetBoundingBox()This action returns the BoundingBox3D which contains the item this node represents.
GetChildIndex()This action returns the child index of this node within its tree.
GetHashCode()This action gets the hash code for an object.
GetItem()This action returns the Item3D this node represents.
GetNodeID()This action gets the id of this node.
SetBoundingBox(Libraries.Game.BoundingBox boundingBox)This action sets the BoundingBox3D which contains the item this node represents.
SetChildIndex(integer index)This action sets the child index of this node within its tree.
SetItem(Libraries.Interface.Item3D item)This action sets the Item3D this node represents to be the passed item.
SetNodeID(integer id)This action sets the id of this node.

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.

GetBoundingBox()

This action returns the BoundingBox3D which contains the item this node represents. This action is used internally.

Return

Libraries.Game.BoundingBox: The BoundingBox3D represented by this Item3DNode.

GetChildIndex()

This action returns the child index of this node within its tree.

Return

integer: The child index of this Item3DNode.

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.

GetItem()

This action returns the Item3D this node represents.

Return

Libraries.Interface.Item3D: The Item3D represented by this Item3DNode.

GetNodeID()

This action gets the id of this node.

Return

integer: the id of this node.

SetBoundingBox(Libraries.Game.BoundingBox boundingBox)

This action sets the BoundingBox3D which contains the item this node represents. This action is used internally.

Parameters

SetChildIndex(integer index)

This action sets the child index of this node within its tree.

Parameters

SetItem(Libraries.Interface.Item3D item)

This action sets the Item3D this node represents to be the passed item.

Parameters

SetNodeID(integer id)

This action sets the id of this node.

Parameters