AStar.Cell
Description
Provides access to data and methods associated with an A* grid cell.
Properties
| col | Gets the cell's column address, or its numbering in the x direction. |
| row | Gets the cell's row address, or its numbering in the y direction. |
Methods
| adjacentCell | Gets the cell's adjacent cell, in the given direction. |
| canGo | Returns true if the travel grid allows a traveler to travel from this cell to an adjacent cell in the defined direction. |
| getAllocation | Gets the AStar.Allocation, if any, that is currently active for the cell or is scheduled to be active at a given time. |
Constructor
| AStar.Cell | Constructs an AStar.Cell based on the grid, row, and column address. |
Operators
| ! | Returns true if the cell is not a valid address in the A* grid. |
| != | Returns true if the cell is not the same address as a compared cell. |
| == | Returns true if the cell is the same address as a compared cell. |
| bool | Returns true if the cell is a valid address in the A* grid. |
Details
AStar.Cell.col
int col
Description
Gets the cell's column address, or its numbering in the x direction.
Increasing column numbers are associated with increasing x locations.
AStar.Cell.row
int row
Description
Gets the cell's row address, or its numbering in the y direction.
Increasing row numbers are associated with increasing y locations.
AStar.Cell.adjacentCell()
| AStar.Cell adjacentCell( int direction ) |
Parameters
| direction | The desired travel direction. This should be an enumeration of AStar.Direction |
Description
Gets the cell's adjacent cell, in the given direction.
AStar.Cell.canGo()
| int canGo( int direction ) |
Parameters
| direction | The desired travel direction. This should be an enumeration of AStar.Direction |
Description
Returns true if the travel grid allows a traveler to travel from this cell to an adjacent cell in the defined direction.
AStar.Cell.getAllocation()
| AStar.Allocation getAllocation( double time = -1 ) |
Parameters
| time | The target simulation time. |
Description
Gets the AStar.Allocation, if any, that is currently active for the cell or is scheduled to be active at a given time.
AStar.Cell Constructor
| AStar.Cell( int grid , int row , int column ) |
Parameters
| grid | Reserved for future use. Should be 1. |
| row | The row address. |
| column | The column address. |
Description
Constructs an AStar.Cell based on the grid, row, and column address.
AStar.Cell.operator !
| int operator !( ) |
Description
Returns true if the cell is not a valid address in the A* grid.
Returns true if the cell address is outside the bounds of the A* grid, otherwise false.
AStar.Cell.operator !=
| int operator !=( AStar.Cell other ) |
Parameters
| other | The cell to compare this cell with. |
Description
Returns true if the cell is not the same address as a compared cell.
AStar.Cell.operator ==
| int operator ==( AStar.Cell other ) |
Parameters
| other | The cell to compare this cell with. |
Description
Returns true if the cell is the same address as a compared cell.
AStar.Cell.operator bool
| int operator bool( ) |
Description
Returns true if the cell is a valid address in the A* grid.
Returns false if the cell address is outside the bounds of the A* grid.