OpenStrat
API
Generated with
OpenStrat/ostrat/ostrat.geom/Sqlign

Sqlign

ostrat.geom.Sqlign
See theSqlign companion object
final class Sqlign extends Square, Rect, Tell2[Double, Pt2]

A square aligned to the X and Y axes. So these squares can be defined by their widths and their centre points. However, the position of the vertices 0, 1, 2 and 3 are not fixed. they can be changed by rotations and reflections. The clockwise, anticlockwise ordering of the vertices can be changed by reflections. The convention is for vertex 0 to be left top but this can change.

Attributes

Companion
object
Graph
Supertypes
trait Tell2[Double, Pt2]
trait Persist2[Double, Pt2]
trait PersistN
trait TellN
trait Tell
trait Persist
trait Rect
trait Square
trait Rectangle
trait Polygon4Plus
trait Polygon3Plus
trait Polygon
trait PolygonBase[Pt2]
trait VertSeqSpec[Pt2]
trait SeqSpec[Pt2]
trait SeqLike[Pt2]
trait Approx[Double]
trait Equals
trait ShapeCentred
trait CentredElem
trait WithCentre
trait Shape
trait BoundedElem
trait Fillable
trait Drawable
trait Aff2Elem
trait Simil2Elem
trait Axlign2Elem
class Object
trait Matchable
class Any
Show all

Members list

Type members

Types

override type ThisT = Sqlign

Gives the final type of this class.

Gives the final type of this class.

Attributes

Inherited types

override type SideT = LSeg2

Attributes

Inherited from:
Polygon

Value members

Concrete methods

override def addMargin(delta: Double): Sqlign

Adds a margin to this Rect, rectangle aligned with the XY axes, moving the sides out by the given parameter.

Adds a margin to this Rect, rectangle aligned with the XY axes, moving the sides out by the given parameter.

Attributes

Definition Classes
override def height: Double

Attributes

Definition Classes
override def name1: String

1st parameter name.

1st parameter name.

Attributes

Definition Classes
override def name2: String

2nd parameter name.

2nd parameter name.

Attributes

Definition Classes
override def negX: Sqlign

Mirror, reflection 2D geometric transformation across the Y axis by negating X. The return type will be narrowed in sub traits / classes.

Mirror, reflection 2D geometric transformation across the Y axis by negating X. The return type will be narrowed in sub traits / classes.

Attributes

Definition Classes
override def negY: Sqlign

Mirror, reflection 2D geometric transformation across the X axis by negating y. The return type will be narrowed in sub traits / classes.

Mirror, reflection 2D geometric transformation across the X axis by negating y. The return type will be narrowed in sub traits / classes.

Attributes

Definition Classes
override def prolign(matrix: AxlignMatrix): Sqlign

2D Transformation using a AxlignMatrix. The return type will be narrowed in subclasses / traits.

2D Transformation using a AxlignMatrix. The return type will be narrowed in subclasses / traits.

Attributes

Definition Classes
override def rotate180: Sqlign

Rotation of 180 degrees, 2D geometric transformation on a GeomElem, returns a GeomElem. The return type will be narrowed in subclasses and traits.

Rotation of 180 degrees, 2D geometric transformation on a GeomElem, returns a GeomElem. The return type will be narrowed in subclasses and traits.

Attributes

Definition Classes
override def rotate270: Sqlign

Rotation positive or anti-clockwise 270 degrees, 2D geometric transformation on a GeomElem, returns a GeomElem. The return type will be narrowed in subclasses and traits.

Rotation positive or anti-clockwise 270 degrees, 2D geometric transformation on a GeomElem, returns a GeomElem. The return type will be narrowed in subclasses and traits.

Attributes

Definition Classes
override def rotate90: Sqlign

Rotation positive or anti-clockwise 90 degrees, 2D geometric transformation on a GeomElem, returns a GeomElem. The return type will be narrowed in subclasses and traits.

Rotation positive or anti-clockwise 90 degrees, 2D geometric transformation on a GeomElem, returns a GeomElem. The return type will be narrowed in subclasses and traits.

Attributes

Definition Classes
override def scale(operand: Double): Sqlign

Uniform 2D geometric scaling transformation. The scale name was chosen for this operation as it is normally the desired operation and preserves Circles and Squares. Use the xyScale method for differential scaling. The Return type will be narrowed in sub traits / classes.

Uniform 2D geometric scaling transformation. The scale name was chosen for this operation as it is normally the desired operation and preserves Circles and Squares. Use the xyScale method for differential scaling. The Return type will be narrowed in sub traits / classes.

Attributes

Definition Classes
override def slate(operand: VecPt2): Sqlign

Translate 2D geometric transformation, taking the xOffset and yOffset as parameters on this GeomElem returning a GeomElem. The Return type will be narrowed in sub traits. End users will often want to use the slate method taking a Pt2 or Vec2 as a parameter, the slateX or the slateY methods. These methods will be offered as extension methods using this method for their implementations.

Translate 2D geometric transformation, taking the xOffset and yOffset as parameters on this GeomElem returning a GeomElem. The Return type will be narrowed in sub traits. End users will often want to use the slate method taking a Pt2 or Vec2 as a parameter, the slateX or the slateY methods. These methods will be offered as extension methods using this method for their implementations.

Attributes

Definition Classes
override def slate(xOperand: Double, yOperand: Double): Sqlign

Translate 2D geometric transformation, taking the xOffset and yOffset as parameters on this GeomElem returning a GeomElem. The Return type will be narrowed in sub traits. End users will often want to use the slate method taking a Pt2 or Vec2 as a parameter, the slateX or the slateY methods. These methods will be offered as extension methods using this method for their implementations.

Translate 2D geometric transformation, taking the xOffset and yOffset as parameters on this GeomElem returning a GeomElem. The Return type will be narrowed in sub traits. End users will often want to use the slate method taking a Pt2 or Vec2 as a parameter, the slateX or the slateY methods. These methods will be offered as extension methods using this method for their implementations.

Attributes

Definition Classes
override def slateX(xOperand: Double): Sqlign

Translate 2D geometric transformation in the X dimension, returning a GeomElem. The Return type will be narrowed in sub traits.

Translate 2D geometric transformation in the X dimension, returning a GeomElem. The Return type will be narrowed in sub traits.

Attributes

Definition Classes
override def slateY(yOperand: Double): Sqlign

Translate 2D geometric transformation in the Y dimension, returning a GeomElem. The Return type will be narrowed in sub traits.

Translate 2D geometric transformation in the Y dimension, returning a GeomElem. The Return type will be narrowed in sub traits.

Attributes

Definition Classes
override def tell1: Double

Element 1 of this Tell2+ element product.

Element 1 of this Tell2+ element product.

Attributes

Definition Classes
override def tell2: Pt2

Element 2 of this Tell2+ element product.

Element 2 of this Tell2+ element product.

Attributes

Definition Classes
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
Tell2 -> Tell
override def typeStr: String

The type of the object to be persisted.

The type of the object to be persisted.

Attributes

Definition Classes
override def width1: Double

length from v1 to v2 and v3 to v4.

length from v1 to v2 and v3 to v4.

Attributes

Definition Classes
override def width2: Double

length from v2 to v3 and v03 to v1.

length from v2 to v3 and v03 to v1.

Attributes

Definition Classes

Inherited methods

def active(id: AnyRef): PolygonActive

Attributes

Inherited from:
Polygon
override def activeChildren(id: AnyRef, children: GraphicElems): RectCompound

Attributes

Definition Classes
Inherited from:
Rect
def addHorrMargin(delta: Double): Rect

Adds a margin to the left and right of this Rect, rectangle aligned with the XY axes, moving the sides out by the given parameter.

Adds a margin to the left and right of this Rect, rectangle aligned with the XY axes, moving the sides out by the given parameter.

Attributes

Inherited from:
Rect
def addHorrVertMargin(horrDelta: Double, vertDelta: Double): Rect

Adds a margin to this Rect, rectangle aligned with the XY axes, moving the sides out by the given parameter.

Adds a margin to this Rect, rectangle aligned with the XY axes, moving the sides out by the given parameter.

Attributes

Inherited from:
Rect
def addVertMargin(delta: Double): Rect

Adds a margin to top and bottom of this Rect, rectangle aligned with the XY axes, moving the sides out by the given parameter.

Adds a margin to top and bottom of this Rect, rectangle aligned with the XY axes, moving the sides out by the given parameter.

Attributes

Inherited from:
Rect
final def alignAngle: Angle

Attributes

Inherited from:
Rectangle
override def approx(that: Any, precision: Double): Boolean

Attributes

Definition Classes
Inherited from:
Polygon
final override def arrayUnsafe: Array[Double]

Attributes

Definition Classes
Inherited from:
Quadrilateral
override def attribs: RArr[XAtt]

The SVG attributes for this polygon.

The SVG attributes for this polygon.

Attributes

Definition Classes
Inherited from:
Polygon
def blBounding: Pt2

Attributes

Inherited from:
BoundedElem
def blOffset: Vec2

Attributes

Inherited from:
OrdinalEdgePoints
def bottom: Double

Attributes

Inherited from:
Rectangularlign
def bottomLeft: Pt2

Attributes

Inherited from:
Rectangularlign
def bottomRight: Pt2

Attributes

Inherited from:
Rectangularlign
def boundRight: Double

Attributes

Inherited from:
BoundedElem
def boundTopRight: Pt2

Attributes

Inherited from:
BoundedElem
final def boundingCen: Pt2

The centre of the bounding rectangle. consider also using cenDefault.

The centre of the bounding rectangle. consider also using cenDefault.

Attributes

Inherited from:
BoundedElem
override def boundingHeight: Double

The height of the BoundingRect of this object.

The height of the BoundingRect of this object.

Attributes

Definition Classes
Inherited from:
Polygon
final override def boundingRect: Rect

Currently throws, not sure if that is the correct behaviour. Creates a bounding rectangle for a collection of 2d points.

Currently throws, not sure if that is the correct behaviour. Creates a bounding rectangle for a collection of 2d points.

Attributes

Definition Classes
Inherited from:
Rect
override def boundingWidth: Double

The width of the BoundingRect of this object.

The width of the BoundingRect of this object.

Attributes

Definition Classes
Inherited from:
Polygon
def brBounding: Pt2

Attributes

Inherited from:
BoundedElem
def brOffset: Vec2

Attributes

Inherited from:
OrdinalEdgePoints
def canEqual(that: Any): Boolean

This canEqual override allow the comparison of Shapes.

This canEqual override allow the comparison of Shapes.

Attributes

Inherited from:
Shape
final override def cen: Pt2

The centre of this geometric / graphical element. The centre will not change if the object type is capable of being rotated and is rotated. The cenDefault on other bounded elements may move relative to points on the object when the object is rotated.

The centre of this geometric / graphical element. The centre will not change if the object type is capable of being rotated and is rotated. The cenDefault on other bounded elements may move relative to points on the object when the object is rotated.

Attributes

Definition Classes
Inherited from:
Rectangle
final override def cenDefault: Pt2

The default centre of this object is the centre. The centre will not change if the object type is capable of being rotated and is rotated.

The default centre of this object is the centre. The centre will not change if the object type is capable of being rotated and is rotated.

Attributes

Definition Classes
Inherited from:
CentredElem
final override def cenPt: Pt2

The centre point of this Polygon. The default centre for Polygons is the centre of the bounding rectangle.

The centre point of this Polygon. The default centre for Polygons is the centre of the bounding rectangle.

Attributes

Definition Classes
Inherited from:
Rect
final override def cenVec: Vec2

Attributes

Definition Classes
Inherited from:
Rect
final override def cenX: Double

The X component of the centre.

The X component of the centre.

Attributes

Definition Classes
Inherited from:
Rectangle
final override def cenY: Double

The Y component of the centre.

The Y component of the centre.

Attributes

Definition Classes
Inherited from:
Rectangle
def diag1: LSeg2

Attributes

Inherited from:
Quadrilateral
def diag2: LSeg2

Attributes

Inherited from:
Quadrilateral
def diags: LSeg2Arr

Attributes

Inherited from:
Quadrilateral
override def draw(lineWidth: Double, lineColour: Colour): RectDraw

Draws this geometric element to produce a GraphElem graphical element, that can be displayed or printed.

Draws this geometric element to produce a GraphElem graphical element, that can be displayed or printed.

Attributes

Definition Classes
Inherited from:
Rect
def drawActive(lineColour: Colour, lineWidth: Double, pointerID: Any): PolygonCompound

Attributes

Inherited from:
Polygon
def dropVert(v: Int): Polygon

Attributes

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

Attributes

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

Attributes

Inherited from:
Tell2
final override def elem(index: Int): Pt2

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:
Rectangle
def elemTypeNames: StrArr

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
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 fElemStr: Pt2 => String

String for element, can be overridden.

String for element, can be overridden.

Attributes

Inherited from:
SeqLike
override def fill(fillfacet: FillFacet): RectangleFill

Returns a fill graphic of this geometric object.

Returns a fill graphic of this geometric object.

Attributes

Definition Classes
Inherited from:
Rect
def fillActive(fillColour: Colour, pointerID: Any): PolygonCompound

Attributes

Inherited from:
Polygon
override def fillActiveDraw(fillColour: Colour, pointerID: Any, lineColour: Colour, lineWidth: Double): RectCompound

Creates a PolygonCompound graphic that is active with a simple 1 colour fill and has a draw graphic for the Polygon. The default values for the draw area line width of 2 and a colour of Black.

Creates a PolygonCompound graphic that is active with a simple 1 colour fill and has a draw graphic for the Polygon. The default values for the draw area line width of 2 and a colour of Black.

Attributes

Definition Classes
Inherited from:
Rect
def fillActiveDrawText(fillColour: Colour, pointerID: Any, str: String, fontSize: Double, lineWidth: Double, lineColour: Colour, textColour: Colour, align: TextAlign): PolygonCompound

Attributes

Inherited from:
Polygon
override def fillActiveText(fillColour: Colour, pointerEv: Any, str: String, fontRatio: Double, fontColour: Colour, align: TextAlign, baseLine: BaseLine, minSize: Double): PolygonCompound

ShapeCompound graphic with a FillFacet, a TextFacet and a ShapeActive child.

ShapeCompound graphic with a FillFacet, a TextFacet and a ShapeActive child.

Attributes

Definition Classes
Inherited from:
Polygon
def fillActiveTextAbs(fillColour: Colour, pointerEv: Any, str: String, fontSize: Double, fontColour: Colour, align: TextAlign): PolygonCompound

Returns compound polygon graphic with fill, active and Text members. The element parameters being entered in name order.

Returns compound polygon graphic with fill, active and Text members. The element parameters being entered in name order.

Attributes

Inherited from:
Polygon
def fillActiveTextlign(fillColour: Colour, pointerEv: Any, str: String, fontSize: Double, fontColour: Colour, align: TextAlign): PolygonCompound

Attributes

Inherited from:
Polygon
override def fillDraw(fillColour: Colour, lineColour: Colour, lineWidth: Double): PolygonCompound

Graphically fill and draws this object.

Graphically fill and draws this object.

Attributes

Definition Classes
Inherited from:
Polygon
def fillDrawText(fillColour: Colour, str: String, fontSize: Double, lineColour: Colour, lineWidth: Double): PolygonCompound

Attributes

Inherited from:
Polygon
override def fillInt(intValue: Int): RectFill

Returns a fill graphic of this geometric object from the Int RGBA value.

Returns a fill graphic of this geometric object from the Int RGBA value.

Attributes

Definition Classes
Inherited from:
Rect
def fillOrDraw(lineWidth: Double, colour: Colour): Graphic2Elem

If this element is Fillable applies the fill method, ignoring the line width parameter, else applies the draw method.

If this element is Fillable applies the fill method, ignoring the line width parameter, else applies the draw method.

Attributes

Inherited from:
Drawable
def fillTextAbs(fillColour: Colour, str: String, fontSize: Double, textColour: Colour, layer: Int): PolygonCompound

Returns compound polygon graphic with fill and Text members. The element parameters being entered in name order.

Returns compound polygon graphic with fill and Text members. The element parameters being entered in name order.

Attributes

Inherited from:
Polygon
def flatMap[B <: ValueNElem, BB <: PolygonBase[B]](f: Pt2 => 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, Pt2) => B): B

foldLeft over the specifying sequence.

foldLeft over the specifying sequence.

Attributes

Inherited from:
SeqSpec
override def foreach[U](f: Pt2 => 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 heightAtt: HeightAtt

Attributes

Inherited from:
Rectangle
def iForeach[U](initIndex: Int)(f: (Int, Pt2) => 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, Pt2) => 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 inRect(ratio: Double): Rect

Attributes

Inherited from:
Polygon
def inRectFrom(startCen: Pt2, ratio: Double): Rect

Approximation for an inner rectangle given a starting centre.

Approximation for an inner rectangle given a starting centre.

Attributes

Inherited from:
Polygon
def innerForeach[U](f: Pt2 => 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 insVert(insertionPoint: Int, newVec: Pt2): Polygon

Insert vertex.

Insert vertex.

Attributes

Inherited from:
Polygon
def insVertDbls(insertionPoint: Int, newPts: Double*): Polygon

Insert vertices as Doubles before the specified insertion vertex.

Insert vertices as Doubles before the specified insertion vertex.

Attributes

Inherited from:
Polygon
def insVerts(insertionPoint: Int, newPts: Pt2*): Polygon

Insert vertices before the specified insertion vertex.

Insert vertices before the specified insertion vertex.

Attributes

Inherited from:
Polygon
def last: Pt2

Last element of the specifying sequence.

Last element of the specifying sequence.

Attributes

Inherited from:
SeqSpec
def left: Double

Attributes

Inherited from:
Rectangularlign
def map[B <: ValueNElem, BB <: PolygonBase[B]](f: Pt2 => 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: Pt2 => 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
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:
Quadrilateral
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 numVerts: Int

The number of vertices.

The number of vertices.

Attributes

Definition Classes
Inherited from:
Quadrilateral
override def opt1: Option[Double]

The optional default value for parameter 1.

The optional default value for parameter 1.

Attributes

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

The optional default value for parameter 2.

The optional default value for parameter 2.

Attributes

Definition Classes
Inherited from:
Tell2Plused
def optMap[B <: ValueNElem, BB <: PolygonBase[B]](f: Pt2 => 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 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
def pointsAttrib: XAtt

The SVG points attributes for this polygon.

The SVG points attributes for this polygon.

Attributes

Inherited from:
Polygon
def precisionDefault: Double

Attributes

Inherited from:
Polygon
def ptInside(pt: Pt2): Boolean

Determines if the parameter point lies inside this Polygon.

Determines if the parameter point lies inside this Polygon.

Attributes

Inherited from:
Polygon
override def reflect(lineLike: LineLike): Square

Reflect 2D geometric transformation across a line, line segment or ray on a GeomElem. The return type will be narrowed in subclasses and traits.

Reflect 2D geometric transformation across a line, line segment or ray on a GeomElem. The return type will be narrowed in subclasses and traits.

Attributes

Definition Classes
Inherited from:
Square
def reverseForeach[U](f: Pt2 => 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 right: Double

Attributes

Inherited from:
Rectangularlign
override def rotate(rotation: AngleVec): Square

Rotation 2D geometric transformation on a GeomElem. The return type will be narrowed in subclasses and traits.

Rotation 2D geometric transformation on a GeomElem. The return type will be narrowed in subclasses and traits.

Attributes

Definition Classes
Inherited from:
Square
override def rotation: AngleVec

The rotation of this square from alignment with the X and Y axes.

The rotation of this square from alignment with the X and Y axes.

Attributes

Definition Classes
Inherited from:
Rect
override def scaleXY(xOperand: Double, yOperand: Double): Rect

Scaling X and Y axes independently, 2D geometric transformation on this Aff2Elem, returns a new Aff2Elem. This allows different scaling factors across X and Y dimensions. The return type will be narrowed in subclasses and traits. This is an affine transformation, but it is not a similar transformation.

Scaling X and Y axes independently, 2D geometric transformation on this Aff2Elem, returns a new Aff2Elem. This allows different scaling factors across X and Y dimensions. The return type will be narrowed in subclasses and traits. This is an affine transformation, but it is not a similar transformation.

Attributes

Definition Classes
Inherited from:
Rect
final override def sd0Cen: Pt2

The centre or halfway point of side 0 of this polygon. Side 0 starts at the vertex v0 and ends at the vertex v1. This can be thought of as vertex 0.5.

The centre or halfway point of side 0 of this polygon. Side 0 starts at the vertex v0 and ends at the vertex v1. This can be thought of as vertex 0.5.

Attributes

Definition Classes
Inherited from:
Quadrilateral
final override def sd0CenX: Double

The X component of the centre or halfway point of side 0 of this polygon.

The X component of the centre or halfway point of side 0 of this polygon.

Attributes

Definition Classes
Inherited from:
Quadrilateral
final override def sd0CenY: Double

The Y component of the centre or halfway point of side 0 of this polygon.

The Y component of the centre or halfway point of side 0 of this polygon.

Attributes

Definition Classes
Inherited from:
Quadrilateral
final def sd1Cen: Pt2

The centre or halfway point of side 1 of this polygon. Side 1 starts at the v1 vertex and ends at the v2 vertex. This can be thought of as vertex 1.5

The centre or halfway point of side 1 of this polygon. Side 1 starts at the v1 vertex and ends at the v2 vertex. This can be thought of as vertex 1.5

Attributes

Inherited from:
Polygon3Plus
final def sd1CenX: Double

The X component of the centre or halfway point of side 1 of this polygon. The midway point between v0 and v1.

The X component of the centre or halfway point of side 1 of this polygon. The midway point between v0 and v1.

Attributes

Inherited from:
Polygon3Plus
final def sd1CenY: Double

The Y component of the centre or halfway point of side 1 of this polygon. the midway point between v1 and v2.

The Y component of the centre or halfway point of side 1 of this polygon. the midway point between v1 and v2.

Attributes

Inherited from:
Polygon3Plus
final def sd2Cen: Pt2

The centre or halfway point of side 2 of this polygon. Side 2 starts at the v1 vertex and ends at the v2 vertex. This can be thought of as vertex 2.5.

The centre or halfway point of side 2 of this polygon. Side 2 starts at the v1 vertex and ends at the v2 vertex. This can be thought of as vertex 2.5.

Attributes

Inherited from:
Polygon3Plus
final def sd2CenX: Double

The X component of the centre or half way point of side 2 of this polygon.

The X component of the centre or half way point of side 2 of this polygon.

Attributes

Inherited from:
Polygon3Plus
final def sd2CenY: Double

The Y component of the centre or halfway point of side 2 of this polygon.

The Y component of the centre or halfway point of side 2 of this polygon.

Attributes

Inherited from:
Polygon3Plus
final def sd3Cen: Pt2

The centre or halfway point of side 3 of this polygon.

The centre or halfway point of side 3 of this polygon.

Attributes

Inherited from:
Polygon4Plus
final def sd3CenX: Double

The X component of the centre or halfway point of side 3 of this polygon.

The X component of the centre or halfway point of side 3 of this polygon.

Attributes

Inherited from:
Polygon4Plus
final def sd3CenY: Double

The Y component of the centre or halfway point of side 3 of this polygon.

The Y component of the centre or halfway point of side 3 of this polygon.

Attributes

Inherited from:
Polygon4Plus
override def shearX(operand: Double): Polygon

Shear 2D geometric transformation along the X Axis on a GeomElem. The return type will be narrowed in subclasses and traits. This is an affine transformation, but it is not a similar transformation.

Shear 2D geometric transformation along the X Axis on a GeomElem. The return type will be narrowed in subclasses and traits. This is an affine transformation, but it is not a similar transformation.

Attributes

Definition Classes
Inherited from:
Polygon
override def shearY(operand: Double): Polygon

Shear 2D geometric transformation along the Y Axis on a GeomElem. The return type will be narrowed in subclasses and traits. This is an affine transformation, but it is not a similar transformation.

Shear 2D geometric transformation along the Y Axis on a GeomElem. The return type will be narrowed in subclasses and traits. This is an affine transformation, but it is not a similar transformation.

Attributes

Definition Classes
Inherited from:
Polygon
override def side(index: Int): LSeg2

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
Inherited from:
Polygon
final override def side0: LSeg2

Polygon side 0 from vertex 0 to vertex 1.

Polygon side 0 from vertex 0 to vertex 1.

Attributes

Definition Classes
Inherited from:
Quadrilateral
final def side1: LSeg2

Polygon side 1 from vertex 0 to vertex 1.

Polygon side 1 from vertex 0 to vertex 1.

Attributes

Inherited from:
Polygon3Plus
final def side2: LSeg2

Polygon side 2 from vertex 1 to vertex 2.

Polygon side 2 from vertex 1 to vertex 2.

Attributes

Inherited from:
Polygon3Plus
final def side3: LSeg2

Polygon side 3 from vertex 2 to vertex 3.

Polygon side 3 from vertex 2 to vertex 3.

Attributes

Inherited from:
Polygon4Plus
final override def sides: LSeg2Arr

Attributes

Definition Classes
Inherited from:
Quadrilateral
def sidesFold[A](init: A)(f: (A, LSeg2) => A): A

Attributes

Inherited from:
Polygon
override def sidesForeach[U](f: LSeg2 => U): Unit

Attributes

Definition Classes
Inherited from:
Polygon
def sidesMap[A, AA <: Arr[A]](f: LSeg2 => A)(implicit build: BuilderArrMap[A, AA]): AA

maps over the sides or edges of the Polygon These are of type LSeg2.

maps over the sides or edges of the Polygon These are of type LSeg2.

Attributes

Inherited from:
Polygon
def sline(index: Int): LSeg2

Attributes

Inherited from:
Polygon
def spacedPts(nx: Int, ny: Int): Pt2Arr

Attributes

Inherited from:
Rect
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
def tailFold[B](initial: B)(f: (B, Pt2) => 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: Pt2 => 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 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 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 textSized(str: String, colour: Colour): TextFixed

Text centred and sized from the bounding rectangle.

Text centred and sized from the bounding rectangle.

Attributes

Inherited from:
Polygon
def tlBounding: Pt2

Attributes

Inherited from:
BoundedElem
def tlOffset: Vec2

Attributes

Inherited from:
OrdinalEdgePoints
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 top: Double

Attributes

Inherited from:
Rectangularlign
def topLeft: Pt2

Attributes

Inherited from:
Rectangularlign
def topRight: Pt2

Attributes

Inherited from:
Rectangularlign
def trOffset: Vec2

Top right offset from centre.

Top right offset from centre.

Attributes

Inherited from:
OrdinalEdgePoints
final def unsafeVert(rawIndex: Int): Pt2

Returns the vertex of the given index. Throws if the index is out of range, if it less than 1 or greater than the number of vertices.

Returns the vertex of the given index. Throws if the index is out of range, if it less than 1 or greater than the number of vertices.

Attributes

Inherited from:
Polygon
def useMultiple: Boolean

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
final override def v0: Pt2

Vertex v0, will throw on a 0 vertices polygon. By convention the default position for this vertex is at the top or 12 o'clock position of the polygon or the vertex immediately anti-clockwise if there is no vertex in this position.

Vertex v0, will throw on a 0 vertices polygon. By convention the default position for this vertex is at the top or 12 o'clock position of the polygon or the vertex immediately anti-clockwise if there is no vertex in this position.

Attributes

Definition Classes
Inherited from:
Quadrilateral
final def v1: Pt2

The v1 Vertex. The default convention is for the vertices to be numbered in a clockwise direction with the 1 immediately clockwise from 12 o'clock.

The v1 Vertex. The default convention is for the vertices to be numbered in a clockwise direction with the 1 immediately clockwise from 12 o'clock.

Attributes

Inherited from:
Polygon3Plus
final def v2: Pt2

The v2 vertex. The default convention is for the vertices to be numbered in a clockwise direction with the 0 vertex at or immediately clockwise from 12 o'clock.

The v2 vertex. The default convention is for the vertices to be numbered in a clockwise direction with the 0 vertex at or immediately clockwise from 12 o'clock.

Attributes

Inherited from:
Polygon3Plus
final def v3: Pt2

Vertex 4. The default convention is for the vertices to be numbered in a clockwise direction with the vertex 1 immediately clockwise from 12 o'clock.

Vertex 4. The default convention is for the vertices to be numbered in a clockwise direction with the vertex 1 immediately clockwise from 12 o'clock.

Attributes

Inherited from:
Polygon4Plus
final override def v3x: Double

The X component of vertex 3. The default convention is for the vertices to be numbered in a clockwise direction with vertex 1 immediately clockwise from 12 o'clock.

The X component of vertex 3. The default convention is for the vertices to be numbered in a clockwise direction with vertex 1 immediately clockwise from 12 o'clock.

Attributes

Definition Classes
Inherited from:
Rectangle
final override def v3y: Double

The Y component of the 4th Vertex. The default convention is for the vertices to be numbered in a clockwise direction with vertex 1 immediately clockwise from 12 o'clock.

The Y component of the 4th Vertex. The default convention is for the vertices to be numbered in a clockwise direction with vertex 1 immediately clockwise from 12 o'clock.

Attributes

Definition Classes
Inherited from:
Rectangle
final override def vLast: Pt2

The last vertex. The default convention places this just anti-clockwise of 12 o'clock.

The last vertex. The default convention places this just anti-clockwise of 12 o'clock.

Attributes

Definition Classes
Inherited from:
Quadrilateral
final override def vLastX: Double

Attributes

Definition Classes
Inherited from:
Quadrilateral
final override def vLastY: Double

Attributes

Definition Classes
Inherited from:
Quadrilateral
def vert(vertNum: Int): Pt2

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
final override 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

Definition Classes
Inherited from:
Quadrilateral
final override 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 subclasses.

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 subclasses.

Attributes

Definition Classes
Inherited from:
Quadrilateral
override def verts: Pt2Arr

Attributes

Definition Classes
Inherited from:
Polygon
def vertsForAll(f: Pt2 => Boolean): Boolean

This method should be overridden in final classes.

This method should be overridden in final classes.

Attributes

Inherited from:
PolygonBase
override def vertsForeach[U](f: Pt2 => U): Unit

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

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

Attributes

Definition Classes
Inherited from:
Polygon
override def vertsMap[B, ArrB <: Arr[B]](f: Pt2 => B)(implicit build: 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
Inherited from:
Polygon
def vertsMin3: Boolean

Checks this polygon has at least 3 vertices.

Checks this polygon has at least 3 vertices.

Attributes

Inherited from:
PolygonBase
def vertsMultiply(n: Int): Polygon

Increase the number of vertices and LSeg2s by breaking up the LSeg2s into parts.

Increase the number of vertices and LSeg2s by breaking up the LSeg2s into parts.

Attributes

Inherited from:
Polygon
def vertsPrevForEach[U](f: (Pt2, Pt2) => 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 PolygonBase. 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 PolygonBase. 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:
PolygonBase
override def vertsTrans(f: Pt2 => Pt2): Square

Attributes

Definition Classes
Inherited from:
Square
final override def width: Double

Attributes

Definition Classes
Inherited from:
Rect
def widthAtt: XAtt

Attributes

Inherited from:
Rectangle
def widthHeightMin(ratio: Double): Double

The shortest of the width and height dimensions relative to the given ratio.

The shortest of the width and height dimensions relative to the given ratio.

Attributes

Inherited from:
Rect
def widthHeightMin: Double

The shortest of the width and height dimensions.

The shortest of the width and height dimensions.

Attributes

Inherited from:
Rect
def xAttrib: XXmlAtt

The X component of the bottom left point is used. This becomes the top left point in SVG space.

The X component of the bottom left point is used. This becomes the top left point in SVG space.

Attributes

Inherited from:
Rectangle
def xBottomLeft: Double

Attributes

Inherited from:
Rectangularlign
def xBottomRight: Double

Attributes

Inherited from:
Rectangularlign
def xTopLeft: Double

Attributes

Inherited from:
Rectangularlign
def xTopRight: Double

Attributes

Inherited from:
Rectangularlign
final override def xVertsArray: Array[Double]

Attributes

Definition Classes
Inherited from:
Quadrilateral
def yAttrib: YXmlAtt

The Y component of the bottom left point is negated to convert to SVG space and the SVG shape origin of the top left vertex.

The Y component of the bottom left point is negated to convert to SVG space and the SVG shape origin of the top left vertex.

Attributes

Inherited from:
Rectangle
def yBottomLeft: Double

Attributes

Inherited from:
Rectangularlign
def yBottomRight: Double

Attributes

Inherited from:
Rectangularlign
def yTopLeft: Double

Attributes

Inherited from:
Rectangularlign
def yTopRight: Double

Attributes

Inherited from:
Rectangularlign
final override def yVertsArray: Array[Double]

Attributes

Definition Classes
Inherited from:
Quadrilateral
def ||(operand: Rect): Rect

Creates a union of the Rects for bounding rectangles.

Creates a union of the Rects for bounding rectangles.

Attributes

Inherited from:
Rect

Concrete fields

val v0x: Double

The X component of vertex v0, will throw on a 0 vertices polygon.

The X component of vertex v0, will throw on a 0 vertices polygon.

Attributes

val v0y: Double

The Y component of vertex v1, will throw on a 0 vertices polygon.

The Y component of vertex v1, will throw on a 0 vertices polygon.

Attributes

val v1x: Double

The X component of the v1 vertex. The default convention is for the vertices to be numbered in a clockwise direction with the 0 vertex at or immediately clockwise from 12 o'clock.

The X component of the v1 vertex. The default convention is for the vertices to be numbered in a clockwise direction with the 0 vertex at or immediately clockwise from 12 o'clock.

Attributes

val v1y: Double

The Y component of the v1 vertex. The default convention is for the vertices to be numbered in a clockwise direction with vertex immediately clockwise from 12 o'clock.

The Y component of the v1 vertex. The default convention is for the vertices to be numbered in a clockwise direction with vertex immediately clockwise from 12 o'clock.

Attributes

val v2x: Double

The X component of the v2 vertex. The default convention is for the vertices to be numbered in a clockwise direction with vertex 1 immediately clockwise from 12 o'clock.

The X component of the v2 vertex. The default convention is for the vertices to be numbered in a clockwise direction with vertex 1 immediately clockwise from 12 o'clock.

Attributes

val v2y: Double

The Y component of the v2 vertex. The default convention is for the vertices to be numbered in a clockwise direction with vertex immediately clockwise from 12 o'clock.

The Y component of the v2 vertex. The default convention is for the vertices to be numbered in a clockwise direction with vertex immediately clockwise from 12 o'clock.

Attributes

Implicits

Implicits

implicit override def show1: Show[Double]

Attributes

Definition Classes
implicit override def show2: Show[Pt2]

Attributes

Definition Classes
Generated with