JsAgg
API
Generated with
JsAgg/ostrat/ostrat.geom/PolygonValueN

PolygonValueN

ostrat.geom.PolygonValueN
trait PolygonValueN[VT <: ValueNElem] extends PolygonLike[VT], SeqSpecValueN[VT]

Attributes

Graph
Supertypes
trait SeqSpecValueN[VT]
trait SeqLikeValueN[VT]
trait PolygonLike[VT]
trait SeqSpec[VT]
trait SeqLike[VT]
class Any
Show all
Known subtypes
trait PolygonLikeDblN[VT]
trait PolygonLikeDbl2[VT]
class PolygonLL
trait Polygon
trait Polygon3Plus
trait Polygon4Plus
trait Polygon5Plus
trait Polygon6Plus
class DoDeclign
trait HexReg
class HexRegImp
trait Hexlign
class HexParrX
class HexParrY
trait Rectangle
trait PhiRectangle
class PhiRect
class PhiRectY
trait Rect
object NoBounds
class RectImp
class Sqlign
class RectangleImp
trait Square
class SquareImp
trait Triangle
class TriangleImp
trait TriangleIsos
class TriangleEqui
class PolygonGen
trait PolygonLength2[VT]
class PolygonKm2
class PolygonM2
trait PolygonLikeDbl3[VT]
trait PolygonLength3[VT]
class PolygonKm3
class PolygonM3
trait PolygonLikeIntN[VT]
trait PolygonLikeInt2[VT]
class PolygonHC
class PolygonSqC
trait PolygonLikeInt3[VT]
Show all

Members list

Type members

Inherited and Abstract types

type SideT <: LineSegLike[VT]

Attributes

Inherited from:
PolygonLike
type ThisT <: SeqSpecValueN[VT]

Gives the final type of this class.

Gives the final type of this class.

Attributes

Inherited from:
SeqSpecValueN

Value members

Concrete methods

override def numVerts: Int

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
override def vertsForeach[U](f: VT => U): Unit

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

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

Attributes

Definition Classes

Inherited methods

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 <: PolygonLike[B]](f: VT => SeqLike[B])(implicit build: PolygonLikeFlatBuilder[B, BB]): BB

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
def map[B <: ValueNElem, BB <: PolygonLike[B]](f: VT => B)(implicit build: PolygonLikeBuilderMap[B, BB]): BB

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
def optMap[B <: ValueNElem, BB <: PolygonLike[B]](f: VT => Option[B])(implicit build: PolygonLikeBuilderMap[B, BB]): Option[BB]

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
def setElemsUnsafe(index: Int, elems: VT*): 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:
SeqLike
def ssFold[B](initVal: B)(f: (B, VT) => B): B

specifying -sequence fold.

specifying -sequence fold.

Attributes

Inherited from:
SeqSpec
def ssForAll(f: VT => Boolean): Boolean

Attributes

Inherited from:
SeqSpecValueN
def ssForeach[U](f: VT => 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

Inherited from:
SeqSpec
def ssIForeach[U](initIndex: Int)(f: (Int, VT) => 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 ssIForeach[U](f: (Int, VT) => 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 ssInnerForeach[U](f: VT => 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 ssLast: VT

Last element of the specifying sequence.

Last element of the specifying sequence.

Attributes

Inherited from:
SeqSpec
override def ssLength: Int

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
def ssMap[B, ArrB <: Arr[B]](f: VT => 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 ssReverseForeach[U](f: VT => 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
def ssTailFold[B](initial: B)(f: (B, VT) => B): B

FoldLeft over the tail of the specifying sequence.

FoldLeft over the tail of the specifying sequence.

Attributes

Inherited from:
SeqSpec
def ssTailForeach[U](f: VT => 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
def vert(index: Int): VT

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
def vertsForAll(f: VT => Boolean): Boolean

This method should be overridden in final classes.

This method should be overridden in final classes.

Attributes

Inherited from:
PolygonLike
def vertsMap[B, ArrB <: Arr[B]](f: VT => 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.

Inherited from:
PolygonLike
def vertsMin3: Boolean

Checks this polygon has at least 3 vertices.

Checks this polygon has at least 3 vertices.

Attributes

Inherited from:
PolygonLike
def vertsPrevForEach[U](f: (VT, VT) => U): Unit

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

Inherited from:
PolygonLike

Inherited and Abstract methods

def arrayLen: Int

The total number of atomic values, Ints, Doubles, Longs etc in the backing Array.

The total number of atomic values, Ints, Doubles, Longs etc in the backing Array.

Attributes

Inherited from:
SeqLikeValueN
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

Inherited from:
SeqLikeValueN
def fElemStr: VT => String

Attributes

Inherited from:
SeqLike
def reverse: ThisT

Reverses the order of the elements of the specifying sequence.

Reverses the order of the elements of the specifying sequence.

Attributes

Inherited from:
SeqSpecValueN
def setElemUnsafe(i: Int, newElem: VT): Unit

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

Inherited from:
SeqLike
def side(index: Int): SideT

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

Inherited from:
PolygonLike
def sides: Arr[SideT]

Attributes

Inherited from:
PolygonLike
def sidesForeach[U](f: SideT => U): Unit

Attributes

Inherited from:
PolygonLike
def ssElemEq(a1: VT, a2: VT): Boolean

Checks if 2 values of the specifying sequence are equal.

Checks if 2 values of the specifying sequence are equal.

Attributes

Inherited from:
SeqSpecValueN
def ssIndex(index: Int): VT

Accesses the specifying sequence element by a 0 based index.

Accesses the specifying sequence element by a 0 based index.

Attributes

Inherited from:
SeqSpec
def typeStr: String

String specifying the type of this object.

String specifying the type of this object.

Attributes

Inherited from:
SeqLike
def verts: Arr[VT]

Attributes

Inherited from:
PolygonLike
Generated with