 | Bin2DT Class |
A simple GC-friendly two-dimensional Bin (aka Spatial Grid) implementation.
When you're done with the Bin, you should Dispose it so its resources can be freed in their object pool. If you forget this, no harm will be done but memory will be GC'ed.
Inheritance HierarchySystemObject
Archon.SwissArmyLib.PartitioningBin2DT
Archon.SwissArmyLib.PartitioningBin2DT
Namespace: Archon.SwissArmyLib.Partitioning
Assembly: Archon.SwissArmyLib (in Archon.SwissArmyLib.dll) Version: 1.0.0.0 (1.0.0.0)
SyntaxC#
public class Bin2D<T> : IDisposable
Type Parameters
- T
- The type of items this Bin will hold.
The Bin2DT type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | Bin2DT(Int32, Int32, Single, Single) |
Creates a new Bin.
|
| Bin2DT(Int32, Int32, Single, Single, Vector2) |
Creates a new Bin.
|
Properties| Name | Description | |
|---|---|---|
 | CellHeight |
Gets the height of cells in the Bin.
|
| CellWidth |
Gets the width of cells in the Bin.
|
| Height |
Gets the height (number of rows) of the Bin.
|
| Item |
Gets an IEnumerableT for the items in the given cell.
|
| Origin |
The coordinate at which this bin's bottom left corner lies.
|
| Width |
Gets the width (number of columns) of the Bin.
|
Methods| Name | Description | |
|---|---|---|
| Clear |
Removes all items from the Bin.
|
| Dispose |
Frees (clears) used resources that can be recycled.
Call this when you're done with the Bin.
|
| Equals | Determines whether the specified Object is equal to the current Object. (Inherited from Object.) |
 | Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
| GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) |
| GetType | Gets the type of the current instance. (Inherited from Object.) |
| Insert |
Inserts an item with the given bounds into the Bin.
|
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| Remove(T) |
Goes through all cells and removes the specified item if they contain it.
If you can you should use Remove(T, Rect) instead.
|
| Remove(T, Rect) |
Removes an item which was inserted with the given bounds from the Bin.
|
| Retrieve |
Gets all items in the Bin that could potentially intersect with the given bounds.
|
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
| Update |
Removes and reinserts an item with new bounds, essentially moving it.
|
See Also