Class: PickedObjectList

PickedObjectList()

Holds a collection of picked objects.

Constructor

new PickedObjectList()

Constructs a picked-object list.
Source:

Members

objects :Array

The picked objects.
Type:
  • Array
Source:

Methods

add(pickedObject)

Adds a picked object to this list. If the picked object is a terrain object and the list already contains a terrain object, the terrain object in the list is replaced by the specified one.
Parameters:
Name Type Description
pickedObject PickedObject The picked object to add. If null, this list remains unchanged.
Source:

clear()

Removes all items from this list.
Source:

hasNonTerrainObjects() → {Boolean}

Indicates whether this list contains picked objects that are not terrain.
Source:
Returns:
true if this list contains objects that are not terrain, otherwise false.
Type
Boolean

terrainObject() → {PickedObject}

Returns the terrain object within this list, if this list contains a terrain object.
Source:
Returns:
The terrain object, or null if this list does not contain a terrain object.
Type
PickedObject

topPickedObject() → {PickedObject}

Returns the top-most picked object in this list.
Source:
Returns:
The top-most picked object in this list, or null if this list is empty.
Type
PickedObject