case class GridPos(x: Int, y: Int) extends Product with Serializable
An object of type GridPos represents a pair of integer coordinates on two axes named x and y.
Such a pair can be used to reference a point on a Grid.
In this coordinate system, x increases "eastwards" and y increases "southwards".
GridPos objecta are immutable.
This class has an alias in the top-level package o1, so it’s accessible to students
simply via import o1._.
- x
an x coordinate
- y
a y coordinate
- Alphabetic
- By Inheritance
- GridPos
- Serializable
- Product
- Equals
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new GridPos(x: Int, y: Int)
- x
an x coordinate
- y
a y coordinate
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##(): Int
- Definition Classes
- AnyRef → Any
- def ==(another: GridPos): Boolean
Determines whether this grid position equals the given one.
Determines whether this grid position equals the given one. This is the case if the two have identical x and y coordinates.
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
- def diff(another: GridPos): (Int, Int)
Returns the xDiff and yDiff between this
GridPosand the given one as a pair. - def distance(another: GridPos): Int
Returns the "grid distance" between this
GridPosand the given one.Returns the "grid distance" between this
GridPosand the given one. The grid distance betweenaandbequalsa.xDiff(b).abs + a.yDiff(b).abs. - final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def neighbor(direction: CompassDir): GridPos
Returns a grid position that "neighbors" this one in the given direction.
Returns a grid position that "neighbors" this one in the given direction. For instance, if this position has an
xof 10 and ayof 20, and thedirectionparameter is given the valueCompassDir.South, then the result has anxof 10 and ayof 21. Calling this method is essentially the same as callingrelativewith adistanceof one. - final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- def pathTowards(direction: CompassDir): LazyList[GridPos]
Returns an infinite lazy-list of locations at increasing distances from this
GridPosin the given direction.Returns an infinite lazy-list of locations at increasing distances from this
GridPosin the given direction. For example, if thisGridPosis (10,1), and the direction isSouth, returns a list of (10,2), (10,3), (10,4), etc. - def productElementNames: Iterator[String]
- Definition Classes
- Product
- def relative(direction: CompassDir, distance: Int): GridPos
Returns another grid position that is in the given direction from this one and at a given distance.
Returns another grid position that is in the given direction from this one and at a given distance.
For instance, say this position has an
xof 10 and ayof 20. IfdirectionisCompassDir.Northanddistanceis 3, then the result has anxof 10 and ayof 17.- See also
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString: String
Returns a textual description of this position.
Returns a textual description of this position. The description is of the form
"(x,y)".- Definition Classes
- GridPos → AnyRef → Any
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- val x: Int
- def xDiff(another: GridPos): Int
Returns the difference between the x coordinate of this
GridPosand that of the givenGridPos.Returns the difference between the x coordinate of this
GridPosand that of the givenGridPos. The result is negative if the x coordinate of thisGridPosis greater. - def xDirectionOf(another: GridPos): Option[CompassDir]
Determines if the given
GridPosis west or east of this one.Determines if the given
GridPosis west or east of this one. ReturnsEastif thisGridPos’s x coordinate is less thananother’s andWestif the opposite is true. Wraps that return value in anOption;Nonemeans that the x coordinates are equal. - val y: Int
- def yDiff(another: GridPos): Int
Returns the difference between the y coordinate of this
GridPosand that of the givenGridPos.Returns the difference between the y coordinate of this
GridPosand that of the givenGridPos. The result is negative if the y coordinate of thisGridPosis greater. - def yDirectionOf(another: GridPos): Option[CompassDir]
Determines if the given
GridPosis north or south of this one.Determines if the given
GridPosis north or south of this one. ReturnsSouthif thisGridPos’s y coordinate is less thananother’s andNorthif the opposite is true. Wraps that direction in anOption;Nonemeans that the y coordinates are equal.
Deprecated Value Members
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable]) @Deprecated @deprecated
- Deprecated
(Since version ) see corresponding Javadoc for more information.