KSLCore/ksl.modeling.spatial/RectangularGridSpatialModel2D

RectangularGridSpatialModel2D

class RectangularGridSpatialModel2D(width: Double = Double.MAX_VALUE, height: Double = Double.MAX_VALUE, numRows: Int = 1, numCols: Int = 1, upperX: Double = 0.0, upperY: Double = 0.0) : SpatialModel(source)

Creates a grid in the 2D plane. The grid is based on the standard user coordinate system, with (x,y) = (0,0) being the upper left most corner point, with the x-axis going from left to right and the y-axis going from the top down

Parameters

upperX

The x coordinate of the upper left most corner point

upperY

The y coordinate of the upper left most corner point

width

The width (along the x-axis) of the grid

height

The height (along the y-axis) of the grid

numRows

The number of rows in the grid (0-based)

numCols

The number of columns in the grid (0-based)

Constructors

RectangularGridSpatialModel2D

constructor(width: Double = Double.MAX_VALUE, height: Double = Double.MAX_VALUE, numRows: Int = 1, numCols: Int = 1, upperX: Double = 0.0, upperY: Double = 0.0)

Types

Companion

object Companion

GridPoint

inner class GridPoint(val x: Double, val y: Double, aName: String? = null) : SpatialModel.AbstractLocation

Represents a location within this spatial model.

RectangularCell2D

inner class RectangularCell2D(row: Int, col: Int)

Properties

bottomLine

val bottomLine: Line2D

The line at the bottom of the grid

cellIterator

val cellIterator: Iterator<RectangularGridSpatialModel2D.RectangularCell2D>

An iterator over the cells in the grid. The cells are accesses by rows (row, col): (0,0), then (0,1), etc 0th row first,

cells

val cells: List<RectangularGridSpatialModel2D.RectangularCell2D>

The cells in the grid as a list. The cells are accesses by rows (row, col): (0,0), then (0,1), etc 0th row first,

defaultLocation

open override var defaultLocation: LocationIfc

The default initial location.

defaultLocationPrecision

var defaultLocationPrecision: Double

leftLine

val leftLine: Line2D

The line on the left side of the grid

lowerLeftCorner

val lowerLeftCorner: Point2D

The lower left corner point for the grid

lowerRightCorner

val lowerRightCorner: Point2D

The lower right corner point for the grid

rightLine

val rightLine: Line2D

The line on the right side of the grid

shape

val shape: Shape

topLine

val topLine: Line2D

The line at the top of the grid

upperLeftCorner

val upperLeftCorner: Point2D

The upper left corner point for the grid

upperRightCorner

val upperRightCorner: Point2D

The upper right corner point for the grid

Functions

cell

fun cell(location: LocationIfc): RectangularGridSpatialModel2D.RectangularCell2D?

Returns the cell that the location is in or null

fun cell(element: SpatialElementIfc): RectangularGridSpatialModel2D.RectangularCell2D?

Returns the cell that the element is in or null

fun cell(x: Double, y: Double): RectangularGridSpatialModel2D.RectangularCell2D?

The cell that contains this (x,y) coordinate or null if no cell contains the coordinate.

fun cell(row: Int, col: Int): RectangularGridSpatialModel2D.RectangularCell2D?

The cell at this row, col. Null is returned if the row or column is outside the grid.

compareLocations

open override fun compareLocations(firstLocation: LocationIfc, secondLocation: LocationIfc): Boolean

Returns true if firstLocation is the same as secondLocation within the underlying spatial model. This is not object reference equality, but rather whether the locations within the underlying spatial model can be considered spatially (equivalent) according to the model. This may or may not imply that the distance between the locations is zero. No assumptions about distance are implied by true.

contains

fun contains(x: Double, y: Double): Boolean

Checks if the x and y values are in the grid

distance

open override fun distance(fromLocation: LocationIfc, toLocation: LocationIfc): Double

Computes the distance between fromLocation and toLocation based on the spatial model's distance metric

elementsInCell

fun elementsInCell(location: LocationIfc): List<SpatialElementIfc>

The elements in the cell containing location or an empty list

fun elementsInCell(spatialElement: SpatialElementIfc): List<SpatialElementIfc>

The elements in the cell containing spatialElement or an empty list.

fun elementsInCell(x: Double, y: Double): List<SpatialElementIfc>

The elements in the cell that contains x and y or an empty list

getRowMajorIndex

fun getRowMajorIndex(row: Int, col: Int): Int

The row major index is row(number of columns) + col + 1 Labeling starts at 1 and goes by row (across columns). For example for a 3 by 3 grid 4, 5, 6 7, 8, 9

mooreNeighborhood