class Cursor extends AnyRef

Represents a cursor that can be used to iterate over cells within a focal neighborhood.

Linear Supertypes
AnyRef, Any
Known Subclasses
KernelCursor
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Cursor
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Cursor(r: Tile, analysisArea: GridBounds[Int], extent: Int)

    r

    Tile that this cursor runs over

    analysisArea

    Analysis area

    extent

    The distance from the focus that the bounding box of this cursor extends. e.g. if the bounding box is 3x3, then the distance from center is 1.

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. val addedCells: CellSet

    A CellSet reperesenting unmasked cells currently within the cursor bounds, that were added by the previous cursor movement.

    A CellSet reperesenting unmasked cells currently within the cursor bounds, that were added by the previous cursor movement. If the cursor has not been moved (i.e. if isReset == true) then addedCells represents the same thing as allCells.

  5. val allCells: CellSet

    A CellSet reperesenting all unmasked cells that are within the cursor bounds.

  6. val analysisOffsetCols: Int
  7. val analysisOffsetRows: Int
  8. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  9. def asciiDraw: String
  10. def centerOn(col: Int, row: Int): Unit

    Centers the cursor on a cell of the raster.

    Centers the cursor on a cell of the raster. Added\Removed cells are not kept track of between centering moves, and centering the cursor resets the state.

    col

    Column of raster to center on.

    row

    Row of raster to center on.

  11. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  12. def col: Int

    Cursor column relative to the analysis area.

    Cursor column relative to the analysis area.

    For example, if the analysis area starts at col 2 and the focusX is currently 3, then the col should be 1.

  13. def colmax: Int
    Attributes
    protected
  14. def colmin: Int
    Attributes
    protected
  15. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  16. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  17. val extent: Int
  18. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  19. def focusCol: Int
  20. def focusRow: Int
  21. def foreach(f: (Int, Int) ⇒ Unit): Unit

    Iterates over all cell values of the raster which are covered by the cursor and not masked.

    Iterates over all cell values of the raster which are covered by the cursor and not masked.

    f

    Function that receives from each cell it's col and row coordinates and it's value.

    Attributes
    protected
  22. def foreachAdded(f: (Int, Int) ⇒ Unit): Unit

    Iterates over all cell values of the raster which are covered by the cursor and not masked, that were exposed as part of the last move of the cursor.

    Iterates over all cell values of the raster which are covered by the cursor and not masked, that were exposed as part of the last move of the cursor.

    For instance, if move(Movement.Up) is called, then there will potentially be a new row that is now covered by the cursor, which are now covered. These values will be included for the iterations of this function, as well any previously masked cell values that were unmasked as part of the move.

    f

    Function that receives from each cell it's col and row coordinates and it's value.

    Attributes
    protected
  23. def foreachRemoved(f: (Int, Int) ⇒ Unit): Unit

    Iterates over all cell values of the raster which are no longer covered by the cursor as part of the last move last move of the cursor.

    Iterates over all cell values of the raster which are no longer covered by the cursor as part of the last move last move of the cursor.

    For instance, if move(Movement.Up) is called, then there will potentially be a new row at the bottom of the cursor that is now uncovered by the cursor. These values will be included for the iterations of this function, as well any previously unmasked cell values that were masked as part of the move.

    f

    Function that receives from each cell it's col and row coordinates and it's value.

    Attributes
    protected
  24. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  25. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  26. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  27. def isReset: Boolean

    Indicates whether or not this cursor has been moved and is tracking state between the previous position and the current position

  28. def move(m: Movement): Unit

    Move the cursor one cell space in a horizontal of vertical direction.

    Move the cursor one cell space in a horizontal of vertical direction. The cursor will keep track of what cells became added by this move (covered by the cursor or unmasked), and what cells became removed by this move (no longer covered by the cursor or masked when previously unmasked). The cursor will only keep the state of one move, so if two moves are done in a row, the state of the first move is forgotten. Only the difference between the cursor and it's most recent previous position are accounted for.

    param m Movement enum that represents moving the cursor Up, Down, Left or Right.

  29. var movement: Movement
  30. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  31. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  32. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  33. val removedCells: CellSet

    A CellSet reperesenting cells that were moved outside the cursor bounds, or unmasked cells that were masked, by the previous cursor movement.

    A CellSet reperesenting cells that were moved outside the cursor bounds, or unmasked cells that were masked, by the previous cursor movement. If the cursor has not been moved this will be a no-op.

  34. def row: Int

    Cursor row relative to the analysis area

  35. def rowmax: Int
    Attributes
    protected
  36. def rowmin: Int
    Attributes
    protected
  37. def setMask(f: (Int, Int) ⇒ Boolean): Unit

    Sets the mask for this cursor.

    Sets the mask for this cursor.

    f

    Function that takes a col and row of the neighborhood coordinates and returns true if that cell should be masked. The neighborhood coordinates are the size of the cursor's bounding box, with (0, 0) being the top right corner.

  38. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  39. def toString(): String
    Definition Classes
    AnyRef → Any
  40. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  41. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  42. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()

Inherited from AnyRef

Inherited from Any

Ungrouped