HCoord

ostrat.prid.phex.HCoord
See theHCoord companion object
trait HCoord extends TCoord, Ordered[HCoord]

A coordinate with in a Hex grid. It may be a Hex tile centre HCen, a HexSide HSep or Hex tile vertice HVert.

Attributes

Companion
object
Graph
Supertypes
trait Ordered[HCoord]
trait Comparable[HCoord]
class Object
trait Matchable
trait TCoord
trait TellElemInt2
trait Int2Elem
trait IntNElem
trait ValueNElem
trait SpecialT
trait TellInt2
trait Tell2[Int, Int]
trait Persist2[Int, Int]
trait Tell2Plused[Int, Int]
trait Persist2Plus[Int, Int]
trait Persist1Plus[Int]
trait PersistN
trait TellN
trait Tell
trait Persist
trait Point
class Any
Show all
Known subtypes
trait HNotVert
trait HCenOrSep
class HCen
trait HSep
class HSepA
class HSepB
class HSepC
class HCoordOther
trait HVert
class HVertHigh
class HVertLow
Show all

Members list

Type members

Types

override type LineSegT = LineSegHC

The type of LineSegLike that this Point can start or ends.

The type of LineSegLike that this Point can start or ends.

Attributes

override type ThisT = HCoord

The type of this point for the purposes of LineSegT. May not be the final type.

The type of this point for the purposes of LineSegT. May not be the final type.

Attributes

Value members

Concrete methods

def canEqual(a: Any): Boolean
override def compare(that: HCoord): Int

Attributes

Definition Classes
override def equals(obj: Any): Boolean

Compares the receiver object (this) with the argument object (that) for equivalence.

Compares the receiver object (this) with the argument object (that) for equivalence.

Any implementation of this method should be an equivalence relation:

  • It is reflexive: for any instance x of type Any, x.equals(x) should return true.
  • It is symmetric: for any instances x and y of type Any, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any instances x, y, and z of type Any if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.

If you override this method, you should verify that your implementation remains an equivalence relation. Additionally, when overriding this method it is usually necessary to override hashCode to ensure that objects which are "equal" (o1.equals(o2) returns true) hash to the same scala.Int. (o1.hashCode.equals(o2.hashCode)).

Value parameters

that

the object to compare against this object for equality.

Attributes

Returns

true if the receiver object is equivalent to the argument; false otherwise.

Definition Classes
Any
override def hashCode: Int

Calculates a hash code value for the object.

Calculates a hash code value for the object.

The default hashing algorithm is platform dependent.

Note that it is allowed for two objects to have identical hash codes (o1.hashCode.equals(o2.hashCode)) yet not be equal (o1.equals(o2) returns false). A degenerate implementation could always return 0. However, it is required that if two objects are equal (o1.equals(o2) returns true) that they have identical hash codes (o1.hashCode.equals(o2.hashCode)). Therefore, when overriding this method, be sure to verify that the behavior is consistent with the equals method.

Attributes

Returns

the hash code value for this object.

Definition Classes
Any
def isCen: Boolean
override def lineSegFrom(startPt: HCoord): LineSegHC

LinSegHC from the parameter HCoord to this HCoord.

LinSegHC from the parameter HCoord to this HCoord.

Attributes

Definition Classes
override def lineSegTo(endPt: HCoord): LineSegHC

LineSegHC from this HCoord to the parameter HCoord.

LineSegHC from this HCoord to the parameter HCoord.

Attributes

Definition Classes
def projPt2(implicit proj: HSysProjection): Pt2

Uses the implicit HGridSysProjection to convert to Pt2.

Uses the implicit HGridSysProjection to convert to Pt2.

Attributes

def subR(rDelta: Int): HCoord
def view(pxScale: Double): HGView

Inherited methods

def <(that: HCoord): Boolean

Attributes

Inherited from:
Ordered

Attributes

Inherited from:
Ordered
def >(that: HCoord): Boolean

Attributes

Inherited from:
Ordered

Attributes

Inherited from:
Ordered
def c: Int

Column number for the coordinate of a tile grid.

Column number for the coordinate of a tile grid.

Attributes

Inherited from:
TCoord

Attributes

Inherited from:
Ordered
def el1Show(style: ShowStyle, maxPlaces: Int): String

Attributes

Inherited from:
Tell2
def el2Show(style: ShowStyle, maxPlaces: Int): String

Attributes

Inherited from:
Tell2

A StrArr Arr of the element type names of this Show Product class.

A StrArr Arr of the element type names of this Show Product class.

Attributes

Inherited from:
Tell2
final override def int1: Int

Attributes

Definition Classes
Inherited from:
TellElemInt2
final override def int2: Int

Attributes

Definition Classes
Inherited from:
TellElemInt2
override def intBufferAppend(buffer: ArrayBuffer[Int]): Unit

Utility method to append this element on to an ArrayBuffer[Int]. End users should rarely need to use this method. This is useful for methods like filter.

Utility method to append this element on to an ArrayBuffer[Int]. End users should rarely need to use this method. This is useful for methods like filter.

Attributes

Definition Classes
Inherited from:
Int2Elem
override def intForeach(f: Int => Unit): Unit

Performs the side effecting function on each Double in this Product element.

Performs the side effecting function on each Double in this Product element.

Attributes

Definition Classes
Inherited from:
Int2Elem
override def name1: String

1st parameter name.

1st parameter name.

Attributes

Definition Classes
Inherited from:
TCoord
override def name2: String

2nd parameter name.

2nd parameter name.

Attributes

Definition Classes
Inherited from:
TCoord
override def numParams: Int

Number of parameter constituents of this class.

Number of parameter constituents of this class.

Attributes

Definition Classes
Inherited from:
Persist2
override def opt1: Option[Int]

The optional default value for parameter 1.

The optional default value for parameter 1.

Attributes

Definition Classes
Inherited from:
Tell2Plused
override def opt2: Option[Int]

The optional default value for parameter 2.

The optional default value for parameter 2.

Attributes

Definition Classes
Inherited from:
Tell2Plused
override def paramNames: StrArr

Sequence of the names of parameter constituents of this class.

Sequence of the names of parameter constituents of this class.

Attributes

Definition Classes
Inherited from:
Tell2

Attributes

Inherited from:
TCoord
def r: Int

Row number for the coordinate of a tile grid.

Row number for the coordinate of a tile grid.

Attributes

Inherited from:
TCoord
def rcStr: String

Attributes

Inherited from:
TCoord

Attributes

Inherited from:
TCoord
override def str: String

The most basic Show method, paralleling the strT method on ShowT type class instances.

The most basic Show method, paralleling the strT method on ShowT type class instances.

Attributes

Definition Classes
TellN -> Tell
Inherited from:
TellN
def str0: String

Show with decimal precision of 0 places.

Show with decimal precision of 0 places.

Attributes

Inherited from:
Tell
def str1: String

Show with decimal precision of 1 place padding with a zero if necessary.

Show with decimal precision of 1 place padding with a zero if necessary.

Attributes

Inherited from:
Tell
def str2: String

Show with decimal precision of 2 places padding with zeros if necessary.

Show with decimal precision of 2 places padding with zeros if necessary.

Attributes

Inherited from:
Tell
def str3: String

Show with decimal precision of 3 places padding with zeros if necessary.

Show with decimal precision of 3 places padding with zeros if necessary.

Attributes

Inherited from:
Tell
override def tell(style: ShowStyle, maxPlaces: Int, minPlaces: Int): String

Intended to be a multiple parameter comprehensive Show method. Intended to be paralleled by show method on Show type class instances.

Intended to be a multiple parameter comprehensive Show method. Intended to be paralleled by show method on Show type class instances.

Attributes

Definition Classes
TellN -> Tell
Inherited from:
TellN
override def tell1: Int

Element 1 of this Tell2+ element product.

Element 1 of this Tell2+ element product.

Attributes

Definition Classes
Inherited from:
TCoord
override def tell2: Int

Element 2 of this Tell2+ element product.

Element 2 of this Tell2+ element product.

Attributes

Definition Classes
Inherited from:
TCoord
final override def tellDepth: Int

The syntactic depth of the tell String for this object.

The syntactic depth of the tell String for this object.

Attributes

Definition Classes
Inherited from:
TellInt2
override def tellElemStrs(way: ShowStyle, decimalPlaces: Int, minPlaces: Int): StrArr

A StrArr Arr collection of the show methods return values of the elements of this Show Product class.

A StrArr Arr collection of the show methods return values of the elements of this Show Product class.

Attributes

Definition Classes
Inherited from:
Tell2
def tellSemisNames(maxPlaces: Int, minPlaces: Int): String

Attributes

Inherited from:
TellN
def toPt2Reg: Pt2

Attributes

Inherited from:
TCoord
override def toString: String

Returns a string representation of the object.

Returns a string representation of the object.

The default representation is platform dependent.

Attributes

Returns

a string representation of the object.

Definition Classes
Tell -> Any
Inherited from:
Tell
def toVecReg: Vec2

Attributes

Inherited from:
TCoord

The type of the object to be persisted.

The type of the object to be persisted.

Attributes

Inherited from:
TCoord

This property determines if the type can be used with Multiple syntax.

This property determines if the type can be used with Multiple syntax.

MyObj * 7

. for describing sequences succinctly. This is not desirable for some types such as numerical and mathematical vector types as this could be confusing 3 * 4 should resolve to an Int of value 12, not a Multiple(3, 4).

Attributes

Inherited from:
Persist

Implicits

Inherited implicits

final implicit override def show1: Show[Int]

Attributes

Definition Classes
Inherited from:
TellInt2
final implicit override def show2: Show[Int]

Attributes

Definition Classes
Inherited from:
TellInt2