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

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.

Parameters

Return

integer: The Compare result, Smaller, Equal, or Larger.

Example

Object o
Object t
integer result = o:Compare(t) //1 (larger), 0 (equal), or -1 (smaller)

Equals(Libraries.Language.Object object)

This action determines if two objects are equal based on their hash code values.

Parameters

Return

boolean: True if the hash codes are equal and false if they are not equal.

Example

use Libraries.Language.Object
use Libraries.Language.Types.Text
Object o
Text t
boolean result = o:Equals(t)

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.

Return

integer: The integer hash code of the object.

Example

Object o
integer hash = o:GetHashCode()

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

  • integer index: The child index of this Item3DNode.

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

  • integer id