Libraries.Game.Collision.Item2DNode Documentation

The Item2DNode 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

Example Code

use Libraries.Game.Collision.DynamicBoundingVolumeTree2D
use Libraries.Game.Collision.Item2DNode

    DynamicBoundingVolumeTree2D tree

    Item2DNode item1
    Item2DNode item2
    
    integer id1 = tree:CreateNode(item1:GetBoundingBox(), item1)
    integer id2 = tree:CreateNode(item2:GetBoundingBox(), item2)

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 BoundingBox2D 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 Item2D this node represents.
GetNodeID()This action gets the id of this node.
SetBoundingBox(Libraries.Game.Collision.BoundingBox2D boundingBox)This action sets the BoundingBox2D 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.Item2D item)This action sets the Item2D 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 BoundingBox2D which contains the item this node represents. This action is used internally.

Example Code

use Libraries.Game.Collision.Item2DNode
        use Libraries.Game.Collision.BoundingBox2D

            Item2DNode node
            BoundingBox2D boundingBox
            boundingBox = node:GetBoundingBox()

Return

Libraries.Game.Collision.BoundingBox2D: The BoundingBox2D represented by this Item2DNode.

GetChildIndex()

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

Example Code

use Libraries.Game.Collision.Item2DNode

            Item2DNode node
            integer index = node:GetChildIndex()

Return

integer: The child index of this Item2DNode.

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 Item2D this node represents. This action is used internally.

Example Code

use Libraries.Game.Collision.Item2DNode
        use Libraries.Game.Collision.Item2D

            Item2DNode node
            Item2D item
            item = node:GetItem()

Return

Libraries.Interface.Item2D: The Item2D represented by this Item2DNode.

GetNodeID()

This action gets the id of this node. This action is used internally.

Example Code

use Libraries.Game.Collision.Item2DNode
        
        Item2DNode node
        integer id = node:GetID()

Return

integer: The id of this node.

SetBoundingBox(Libraries.Game.Collision.BoundingBox2D boundingBox)

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

Example Code

use Libraries.Game.Collision.Item2DNode
        use Libraries.Game.Collision.BoundingBox2D

            Item2DNode node
            BoundingBox2D boundingBox
            node:SetBoundingBox(boundingBox)

Parameters

SetChildIndex(integer index)

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

Example Code

use Libraries.Game.Collision.Item2DNode
        
            integer nodeCount = 5
            integer counter = 0
            repeat while counter < nodeCount
                Item2DNode node
                node:SetChildIndex(i)
                nodes:Add(node)
                counter = counter + 1
            end

Parameters

SetItem(Libraries.Interface.Item2D item)

This action sets the Item2D this node represents to be the passed item. This action is used internally.

Example Code

use Libraries.Game.Collision.Item2DNode
        use Libraries.Game.Collision.Item2D

            Item2DNode node
            Item2D item
            node:SetItem()

Parameters

SetNodeID(integer id)

This action sets the id of this node. This action is used internally.

Example Code

use Libraries.Game.Collision.Item2DNode
        
        Item2DNode node
        integer nodeID = 0
        node:SetID(nodeID)

Parameters