A polygon with the vertices defined by hex tile coordinates HCoords.
Attributes
- Companion
- object
- Graph
-
- Supertypes
-
trait PolygonLikeInt2[HCoord]trait PolygonLikeIntN[HCoord]trait PolygonValueN[HCoord]trait PolygonLike[HCoord]trait HCoordSeqSpectrait SeqSpecInt2[HCoord]trait SeqSpecIntN[HCoord]trait SeqSpecValueN[HCoord]trait HCoordSeqLiketrait SeqLikeInt2[HCoord]trait SeqLikeIntN[HCoord]trait ArrayIntBackedtrait SeqLikeValueN[HCoord]class AnyValtrait Matchableclass AnyShow all
Members list
Value members
Concrete methods
This applies the index value in a circular manner. So the 6th index of a Hexagon is applied at vertex 0, 7 at 1 and -1 at 5.
This applies the index value in a circular manner. So the 6th index of a Hexagon is applied at vertex 0, 7 at 1 and -1 at 5.
Attributes
Constructs the final type of these SeqLikeIntN from an Array[Int]. Mostly you will access this capability from the companion object or the appropriate builder, but it can be useful to access this from the class itself.
Constructs the final type of these SeqLikeIntN from an Array[Int]. Mostly you will access this capability from the companion object or the appropriate builder, but it can be useful to access this from the class itself.
Attributes
- Definition Classes
Returns a side of the appropriate type for the PolygonLike from the goven index. The index cycles.
Returns a side of the appropriate type for the PolygonLike from the goven index. The index cycles.
Attributes
- Definition Classes
Attributes
- Definition Classes
Attributes
- Definition Classes
String specifying the type of this object.
Attributes
- Definition Classes
Maps the vertices of this polygon to an immutable Array like sequence of type B.
Maps the vertices of this polygon to an immutable Array like sequence of type B.
Type parameters
- ArrB
-
The type of the immutable Array like sequence of B.
- B
-
The element type of the returned sequence.
Attributes
- Returns
-
the immutable sequence collection by applying the supplied function to each vertex.
- Definition Classes
This method does nothing if the vertNum < 2. Foreach vertex applies the side effecting function to the previous vertex with each vertex. The previous vertex to the first vertex is the last vertex of the PolygonLike. Note the function signature (previous, vertex) => U follows the foreach based convention of putting the collection element 2nd or last as seen for example in fold methods'(accumulator, element) => B signature.
This method does nothing if the vertNum < 2. Foreach vertex applies the side effecting function to the previous vertex with each vertex. The previous vertex to the first vertex is the last vertex of the PolygonLike. Note the function signature (previous, vertex) => U follows the foreach based convention of putting the collection element 2nd or last as seen for example in fold methods'(accumulator, element) => B signature.
Attributes
- Definition Classes
Inherited methods
Creates the Array[Int] need to implement the sides method.
Creates the Array[Int] need to implement the sides method.
Attributes
- Definition Classes
- Inherited from:
- PolygonLikeInt2
The length of the backing Array.
The number of atomic values, Ints, Doubles, Longs etc that specify / construct an element of this immutable flat Array based collection class.
The number of atomic values, Ints, Doubles, Longs etc that specify / construct an element of this immutable flat Array based collection class.
Attributes
- Definition Classes
- Inherited from:
- SeqLikeInt2
The element String allows the composition of toString for the whole collection. The syntax of the output will be reworked.
Attributes
- Definition Classes
- Inherited from:
- HCoordSeqLike
FlatMaps the vertices of this PolygonLike to a new to PolygonLike class of type BB.
FlatMaps the vertices of this PolygonLike to a new to PolygonLike class of type BB.
Attributes
- Inherited from:
- PolygonLike
Maps the vertices of this PolygonLike to a new to PolygonLike class of type BB.
Maps the vertices of this PolygonLike to a new to PolygonLike class of type BB.
Attributes
- Inherited from:
- PolygonLike
Attributes
- Definition Classes
- Inherited from:
- HCoordSeqLike
The number of vertices and also the number of sides in this Polygon.
The number of vertices and also the number of sides in this Polygon.
Attributes
- Definition Classes
- Inherited from:
- PolygonValueN
Optionally maps the vertices of this PolygonLike to vertices of a new to PolygonLike class of type BB. If the new PolygonLike has at least 3 vertices returns Some else returns None.
Optionally maps the vertices of this PolygonLike to vertices of a new to PolygonLike class of type BB. If the new PolygonLike has at least 3 vertices returns Some else returns None.
Attributes
- Inherited from:
- PolygonLike
Reverses the order of the elements of the specifying sequence.
Reverses the order of the elements of the specifying sequence.
Attributes
- Definition Classes
- Inherited from:
- SeqSpecIntN
Sets / mutates an element in the Arr. This method should rarely be needed by end users, but is used by the initialisation and factory methods.
Sets / mutates an element in the Arr. This method should rarely be needed by end users, but is used by the initialisation and factory methods.
Attributes
- Definition Classes
- Inherited from:
- SeqLikeInt2
Sets / mutates elements in the Arr. This method should rarely be needed by end users, but is used by the initialisation and factory methods.
Sets / mutates elements in the Arr. This method should rarely be needed by end users, but is used by the initialisation and factory methods.
Attributes
- Inherited from:
- SeqLike
Checks if 2 values of the specifying sequence are equal.
Checks if 2 values of the specifying sequence are equal.
Attributes
- Definition Classes
- Inherited from:
- SeqSpecInt2
specifying -sequence fold.
Attributes
- Inherited from:
- SeqSpecValueN
Performs a side effecting function on each element of the specifying sequence in order.
Performs a side effecting function on each element of the specifying sequence in order.
Attributes
- Inherited from:
- SeqSpec
Index with foreach on the data elements. Performs a side effecting function on the index and each element of the data sequence. It takes a function as a parameter. The function may return Unit. If it does return a non Unit value it is discarded. The [U] type parameter is there just to avoid warnings about discarded values and can be ignored by method users. The method has 2 versions / name overloads. The default start for the index is 0 if just the function parameter is passed. The second version name overload takes an Int for the first parameter list, to set the start value of the index. Note the function signature follows the foreach based convention of putting the collection element 2nd or last as seen for example in fold methods' (accumulator, element) => B signature.
Index with foreach on the data elements. Performs a side effecting function on the index and each element of the data sequence. It takes a function as a parameter. The function may return Unit. If it does return a non Unit value it is discarded. The [U] type parameter is there just to avoid warnings about discarded values and can be ignored by method users. The method has 2 versions / name overloads. The default start for the index is 0 if just the function parameter is passed. The second version name overload takes an Int for the first parameter list, to set the start value of the index. Note the function signature follows the foreach based convention of putting the collection element 2nd or last as seen for example in fold methods' (accumulator, element) => B signature.
Attributes
- Inherited from:
- SeqSpec
Index with foreach on the specifying sequence elements. Performs a side effecting function on the index and each element of the specifying sequence. It takes a function as a parameter. The function may return Unit. If it does return a non Unit value it is discarded. The [U] type parameter is there just to avoid warnings about discarded values and can be ignored by method users. The method has 2 versions / name overloads. The default start for the index is 0 if just the function parameter is passed. The second version name overload takes an Int for the first parameter list, to set the start value of the index. Note the function signature follows the foreach based convention of putting the collection element 2nd or last as seen for example in fold methods' (accumulator, element) => B signature.
Index with foreach on the specifying sequence elements. Performs a side effecting function on the index and each element of the specifying sequence. It takes a function as a parameter. The function may return Unit. If it does return a non Unit value it is discarded. The [U] type parameter is there just to avoid warnings about discarded values and can be ignored by method users. The method has 2 versions / name overloads. The default start for the index is 0 if just the function parameter is passed. The second version name overload takes an Int for the first parameter list, to set the start value of the index. Note the function signature follows the foreach based convention of putting the collection element 2nd or last as seen for example in fold methods' (accumulator, element) => B signature.
Attributes
- Inherited from:
- SeqSpec
Accesses the specifying sequence element by a 0 based index.
Accesses the specifying sequence element by a 0 based index.
Attributes
- Definition Classes
- Inherited from:
- SeqSpecInt2
Foreachs over the inner of the specifying sequence, excludes the first and last element. Performs a side effecting function on each element of the tail of the specifying sequence in order.
Foreachs over the inner of the specifying sequence, excludes the first and last element. Performs a side effecting function on each element of the tail of the specifying sequence in order.
Attributes
- Inherited from:
- SeqSpec
Last element of the specifying sequence.
The number of product elements in this collection. For example in a [[PolygonImp], this is the number of Pt2s in the Polygon
The number of product elements in this collection. For example in a [[PolygonImp], this is the number of Pt2s in the Polygon
Attributes
- Definition Classes
- Inherited from:
- SeqSpecValueN
Performs a side effecting function on each element of the specifying-sequence in reverse order. The function may return Unit. If it does return a non-Unit value it is discarded. The [U] type parameter is there just to avoid warnings about discarded values and can be ignored by method users.
Performs a side effecting function on each element of the specifying-sequence in reverse order. The function may return Unit. If it does return a non-Unit value it is discarded. The [U] type parameter is there just to avoid warnings about discarded values and can be ignored by method users.
Attributes
- Inherited from:
- SeqSpec
FoldLeft over the tail of the specifying sequence.
Foreachs over the tail of the specifying sequence. Performs a side effecting function on each element of the tail of the specifying sequence in order.
Foreachs over the tail of the specifying sequence. Performs a side effecting function on each element of the tail of the specifying sequence in order.
Attributes
- Inherited from:
- SeqSpec
Method for creating a new Array[Int] backed collection class of this collection class's final type.
Method for creating a new Array[Int] backed collection class of this collection class's final type.
Attributes
- Inherited from:
- SeqLikeIntN
Returns the vertex of the given index. Cycles around if the index is out of range, vert 3 retruns vert 0 on a triangle.
Returns the vertex of the given index. Cycles around if the index is out of range, vert 3 retruns vert 0 on a triangle.
Attributes
- Inherited from:
- PolygonLike
This method should be overridden in final classes.
Checks this polygon has at least 3 vertices.
Concrete fields
The backing Array[Int] of this collection class. End users should not normally need to interact with this directly.
The backing Array[Int] of this collection class. End users should not normally need to interact with this directly.