PolygonKm3

ostrat.geom.PolygonKm3
See thePolygonKm3 companion object
final class PolygonKm3(val arrayUnsafe: Array[Double]) extends AnyVal, PolygonLength3[PtKm3]

A quasi Polygon specified in 3D metre points. This is not a proper polygon as the points do not have to lie within the same plane. I'm not sure how useful this class will prove. It has been created for the intermediary step of converting from LatLongss to PolygonM2Gens on world maps.

Attributes

Companion
object
Graph
Supertypes
trait SpecialT
trait SeqSpec[PtKm3]
trait SeqLike[PtKm3]
class AnyVal
trait Matchable
class Any
Show all

Members list

Type members

Types

override type SideT = LineSegKm3
override type ThisT = PolygonKm3

Gives the final type of this class.

Gives the final type of this class.

Attributes

Inherited and Abstract types

Attributes

Inherited from:
PolygonLength3

Value members

Concrete methods

override def elemFromDbls(d1: Double, d2: Double, d3: Double): PtKm3

Method for creating Dbl3Elems from 3 Doubles.

Method for creating Dbl3Elems from 3 Doubles.

Attributes

Definition Classes
override def fElemStr: PtKm3 => String

String for element, can be overridden.

String for element, can be overridden.

Attributes

Definition Classes
override def fromArray(array: Array[Double]): PolygonKm3

Attributes

Definition Classes
override def side(index: Int): LineSegKm3

Returns a side of the appropriate type for the PolygonBase from the given index. The index cycles.

Returns a side of the appropriate type for the PolygonBase from the given index. The index cycles.

Attributes

Definition Classes
override def sides: LineSegKm3Arr

Attributes

Definition Classes
override def sidesForeach[U](f: LineSegKm3 => U): Unit

Attributes

Definition Classes
override def typeStr: String

String specifying the type of this object.

String specifying the type of this object.

Attributes

Definition Classes
def vertX(index: Int): Double

Returns the X component of the vertex of the given number. Will throw an exception if the vertex index is out of range.

Returns the X component of the vertex of the given number. Will throw an exception if the vertex index is out of range.

Attributes

def vertY(index: Int): Double

Returns the Y component of the vertex of the given number. Will throw an exception if the vertex index is out of range. For maximum efficiency override the implementation in sub classes.

Returns the Y component of the vertex of the given number. Will throw an exception if the vertex index is out of range. For maximum efficiency override the implementation in sub classes.

Attributes

def vertZ(index: Int): Double

Returns the Z component of the vertex of the given number. Will throw an exception if the vertex index is out of range. For maximum efficiency override the implementation in sub classes.

Returns the Z component of the vertex of the given number. Will throw an exception if the vertex index is out of range. For maximum efficiency override the implementation in sub classes.

Attributes

override def verts: PtKm3Arr

Attributes

Definition Classes
override def vertsForeach[U](f: PtKm3 => U): Unit

Performs the side effecting function on the PtKm3 value of each vertex.

Performs the side effecting function on the PtKm3 value of each vertex.

Attributes

Definition Classes
override def vertsMap[B, ArrB <: Arr[B]](f: PtKm3 => B)(implicit builder: BuilderArrMap[B, ArrB]): ArrB

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
override def vertsPrevForEach[U](f: (PtKm3, PtKm3) => U): Unit

This method does nothing if the vertNum < 2. Foreach PtKm3 vertex applies the side effecting function to the previous PtKm3 vertex with each vertex. The previous vertex to the first vertex is the last vertex of this PolygonKm3. 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 PtKm3 vertex applies the side effecting function to the previous PtKm3 vertex with each vertex. The previous vertex to the first vertex is the last vertex of this PolygonKm3. 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

All vertices have a non negative Z component.

All vertices have a non negative Z component.

Attributes

Inherited methods

def appendArray(appendProductsLength: Int): Array[Double]

Builder helper method that provides a longer array, with the underlying array copied into the new extended Array.

Builder helper method that provides a longer array, with the underlying array copied into the new extended Array.

Attributes

Inherited from:
SeqSpecDblN
override protected def arrayForSides: Array[Double]

Creates the Array[Double] need to implement the sides method.

Creates the Array[Double] need to implement the sides method.

Attributes

Definition Classes
Inherited from:
PolygonDbl3
final def arrayLen: Int

The length of the backing Array Double.

The length of the backing Array Double.

Attributes

Inherited from:
ArrayDblBacked
final override def elem(index: Int): PtKm3

Accesses the specifying sequence element by a 0 based index. For Sequs this will an alternative name for apply.

Accesses the specifying sequence element by a 0 based index. For Sequs this will an alternative name for apply.

Attributes

Definition Classes
Inherited from:
SeqLikeImutDbl3
final override def elemEq(a1: PtKm3, a2: PtKm3): Boolean

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:
SeqLikeDbl3
final override def elemProdSize: Int

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:
SeqLikeDbl3

Attributes

Inherited from:
SeqSpecValueN
override def elemsStr: String

The element String allows the composition of toString for the whole collection. The syntax of the output will be reworked.

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:
SeqSpec
def flatMap[B <: ValueNElem, BB <: PolygonBase[B]](f: PtKm3 => SeqLike[B])(implicit build: PolygonLikeFlatBuilder[B, BB]): BB

FlatMaps the vertices of this PolygonBase to a new to PolygonLike class of type BB.

FlatMaps the vertices of this PolygonBase to a new to PolygonLike class of type BB.

Attributes

Inherited from:
PolygonBase
def foldLeft[B](initVal: B)(f: (B, PtKm3) => B): B

foldLeft over the specifying sequence.

foldLeft over the specifying sequence.

Attributes

Inherited from:
SeqSpec
override def foreach[U](f: PtKm3 => U): Unit

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

Definition Classes
Inherited from:
SeqSpec
def iForeach[U](initIndex: Int)(f: (Int, PtKm3) => U): Unit

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
def iForeach[U](f: (Int, PtKm3) => Any): Unit

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
def innerForeach[U](f: PtKm3 => U): Unit

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
def last: PtKm3

Last element of the specifying sequence.

Last element of the specifying sequence.

Attributes

Inherited from:
SeqSpec
def map[B <: ValueNElem, BB <: PolygonBase[B]](f: PtKm3 => B)(implicit build: PolygonLikeBuilderMap[B, BB]): BB

Maps the vertices of this PolygonBase to a new to PolygonLike class of type BB.

Maps the vertices of this PolygonBase to a new to PolygonLike class of type BB.

Attributes

Inherited from:
PolygonBase
def mapArr[B, ArrB <: Arr[B]](f: PtKm3 => B)(implicit ev: BuilderArrMap[B, ArrB]): ArrB

Specialised map to an immutable Arr of B. For Sequ dataMap is the same as map, but for other structures it will be different, for example a PolygonLike will map to another PolygonLike.

Specialised map to an immutable Arr of B. For Sequ dataMap is the same as map, but for other structures it will be different, for example a PolygonLike will map to another PolygonLike.

Attributes

Inherited from:
SeqSpec
def mutateElemUnsafe(index: Int, f: PtKm3 => PtKm3): Unit

Mutates an element in the Arr at the given index. This method should rarely be needed by end users, but is used by the initialisation and factory methods.

Mutates an element in the Arr at the given index. This method should rarely be needed by end users, but is used by the initialisation and factory methods.

Attributes

Inherited from:
SeqLikeBacked
final override def numElems: Int

The number of data elements in the defining sequence. These collections use underlying mutable Arrays and ArrayBuffers. The length of the underlying Array will be a multiple of this number. For Sequs this will be an alternative name for length.

The number of data elements in the defining sequence. These collections use underlying mutable Arrays and ArrayBuffers. The length of the underlying Array will be a multiple of this number. For Sequs this will be an alternative name for length.

Attributes

Definition Classes
Inherited from:
SeqLikeImutDbl3
override def numVerts: Int

The number of vertices.

The number of vertices.

Attributes

Definition Classes
Inherited from:
PolygonValueN
def optMap[B <: ValueNElem, BB <: PolygonBase[B]](f: PtKm3 => Option[B])(implicit build: PolygonLikeBuilderMap[B, BB]): Option[BB]

Optionally maps the vertices of this PolygonBase to vertices of a new to PolygonLike class of type BB. If the new PolygonBase has at least 3 vertices returns Some else returns None.

Optionally maps the vertices of this PolygonBase to vertices of a new to PolygonLike class of type BB. If the new PolygonBase has at least 3 vertices returns Some else returns None.

Attributes

Inherited from:
PolygonBase
override def reverse: ThisT

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:
SeqSpecDblN
def reverseForeach[U](f: PtKm3 => U): Unit

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
override def setElemUnsafe(index: Int, newElem: PtKm3): Unit

Sets / mutates an element in the Arr at the given index. 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 at the given index. This method should rarely be needed by end users, but is used by the initialisation and factory methods.

Attributes

Definition Classes
Inherited from:
SeqLikeImutDbl3
def setElemsUnsafe(index: Int, elems: PtKm3*): Unit

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:
SeqLikeBacked
def tailFold[B](initial: B)(f: (B, PtKm3) => B): B

FoldLeft over the tail of the specifying sequence.

FoldLeft over the tail of the specifying sequence.

Attributes

Inherited from:
SeqSpec
def tailForeach[U](f: PtKm3 => U): Unit

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
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
SeqLike -> Any
Inherited from:
SeqLike

Reverses the order of the elements in a new Array[Double] which is returned.

Reverses the order of the elements in a new Array[Double] which is returned.

Attributes

Inherited from:
SeqSpecDblN
def unsafeSameSize(length: Int): ThisT

Attributes

Inherited from:
SeqLikeImutDblN
def vert(vertNum: Int): PtKm3

Returns the vertex of the given index. Cycles around if the index is out of range, vert 3 returns vert 0 on a triangle.

Returns the vertex of the given index. Cycles around if the index is out of range, vert 3 returns vert 0 on a triangle.

Attributes

Inherited from:
PolygonBase

This method should be overridden in final classes.

This method should be overridden in final classes.

Attributes

Inherited from:
PolygonBase

Checks this polygon has at least 3 vertices.

Checks this polygon has at least 3 vertices.

Attributes

Inherited from:
PolygonBase

Concrete fields