ostrat.geom

A class that can transform itself in 2d geometry and can preserve its type across all affine transformations. This is a key trait, the object can be transformed in 2 dimensional space. Leaf classes must implement the single method fTrans(f: Vec2 => Vec2): T. The related trait TransDistable does the same for fTrans(f: Dist2 => Dist2): T.

The type class trait for transforming an object in 2d geometry. Note overrides necessary to preserve type.

The companion object for the Trans[T] type class, containing instances for common classes.

Angle of inclination. Its particularly important not to use this class to represent Latitudes as the Angle class has a normal range 0 <= a < 360 degrees, while Latitudes have a normal range +- 90 degrees. Unlike AngleVec this class has no multiply or divide, * or / methods. It has add and subtract, + and - methods, but these take AngleVecs as operands not other Angles. To Add,subtract or scale angles of inclination would make no sense.

Angle Companion object.

Base trait for Angle, AngleVec, Latitude and Longitude.

Angle vector, an angle of rotation. Values may be greater than 360 degrees and less than -360 degrees. Negative values represent clockwise rotation. So +720 degrees represents 2 complete anti-clockwise rotations, -1080 degrees represents 3 clockwise rotations.

Companion object for AngleVec trait contains factory methods.

Efficient Immutable Array[Double] based collection class, with the Angle values stored as arc seconds.

Companion object for Angles class.

To be removed.

This provides factory methods to create an ArcTail. There is no independent ArcTail class. This is one of 3 factory objects to CurveTail.

Object for producing arrow graphics to point at objects in diagrams.

This is a trait for geometric elements, GeomElems, that don't need special axes method implementations.

Indicates the back mouse button was pressed.

Baseline style for text.

Companion object for BaseLine trait, contains the object value instances of the trait.

Cubic bezier curve.

Functional class for Drawing a cubic Bezier curve.

Companion object for the BezierDraw class.

This provides factory methods to create a Bezier tail. There is no independent BezierTail class. This is one of 3 factory objects to CurveTail.

A 2D geometric element, that has a defined bounding rectangle, BoundingRect. This trait is for layout, such as placing Graphic elements in rows and columns. It includes polygon and shape graphics but not line and curve graphics.

This will be deprecated and its methods transfered to BoundingExtensions.

Type class for the production of bounding rectangles.

A specialised flat ArrayBuffer[Double] based class for PtM2s collections.

Circular arc. Has a rotation counter to allow rotation deltas greater than 360 degrees and less than - 360 degrees. The CArc is intended to function as closely as possible to the functioning of CArcTails in a curve path. Hence the decision to store the three points as fields rather using the AngleVec of the arc which would allow less data. This is to avoid calculation /rounding errors in the start and end points, which will be used by other CurveSegs in curve paths.

Companion object of CArc class, contains various factory methods for the construction of circular arcs.

A canvas element that can be rendered by the pgui.CanvasPlatform API. This trait is not sealed, but should not be extended outside of the library.

Companion object for the DisplayElem trait. Contains Implicit instances for 2d geometrical transformation type-classes.

ShapeFill element that is a CanvElem

A 2D geometric element with a defined centre.

Circle class is defined by its centre and radius. It fulfills the interface for an Ellipse.

This is the companion object for the Circle case class. It provides factory methods for creating Circles.

A pointable polygon without visual.

Compound Circle Graphic class.

A simple draw of a circle graphic.

A simple single colour fill of a circle graphic.

A circle based Graphic, may be simple or compound.

A Simple circle based graphic.

Utility object, contains various methods for creating crosses.

A segment of a curve that could be used in a closed shape or curve path. The names start and end are used in CurveSeg and its sub classes to provide consistent naming across line segments LineSegs, circular arcs CArcs, elliptical arcs EArcs and Square and cubic beziers Beziers, which require different numbers of points in their specification.

This class needs replacing.

Graphic based on a CurveSeg.

A CurveSeg can be a line segment or an arc segment or a bezier segment without its starting point, which is supplied by the previous curveTail. It takes its start point from the pEnd of the previous segment. There is no CurveSeg companion object as the LineSeg, ArcSeg and BezierSeg all have their own factory object apply methods.

This class will be replaced but extends CanvElem as a temporary measure.

Needs removing. A base trait for DistCurveSeg and DistCurveTail and their associated GraphicElemsDist (these haven't been implemented or precisely named yet).

Needs removing. A curve segment tail described in distance units rather than scalars. A DistCurveSeg without its starting point which will normally be supplied by the preceding DistCurveTail.

A Dodecahedron aligned with the X and Y Axis so v0 is vertically up from the centre and v6 vertically down.

Extension methods class for Double, for the geom package.

A 2D geometric element that can be drawn producing a GraphicElem.

Companion object for the Drawable trait contains implicit instances for various 2D geometric transformation type classes.

Elliptical Arc. the trait has 2 implementations CArc and EArc.EArcImp.

2D graphic that draws an arc of an ellipse. The trait has 2 implementations, CArcdraw, a cirular arc draw and the general case is implemented with EArcDraw.EArcDrawImp.

Companion object ofr the EArcDraw trait, contins the general implementation class EArcDrawImp and an apply factor method that delegates to EArcDrawImp.

An arc based on an ellipse whose axes are aligned to the X and Y axes. This is a trait as the EArclign.EArclignImp and CArc classes both fulfill this interface.

Companion object for EArclign trait, an arc that is based on Ellipse aligned to the X and Y axes.

The Ellipse trait can either be implemented as an Ellipse class or as a Circle. Which also fulfills the Ellipse interface. The factory methods in the Ellipse companion object return [Ellipse]].

Companion object for the Ellipse trait contains the EllipseImp implementation class and factory methods for Ellipse that delegate to EllipseImp.

Common trait for Ellipse and EArc. The main purpose of this trait is not to share code, but to establish naming conventions for elliptical properties.

Compound graphic trait for an ellipse. Note CircleCompound is a sub class of this trait.

Companion object for the EllipseCompound trait contains factory apply method and implicit instances for the 2D geometric transformations.

A simple single colour fill of a circle graphic.

Companion object for the EllipseFill class.

An Ellipse based Graphic. The Ellipse can be defined as a circle.

A Simple circle based graphic. Not sure if this trait is useful.

An ellipse whose axes are aligned to the X and Y axes. This is a trait as both Circle and Ellipselign.EllipselignImp classes implement this interface.

Starting off with simplified. Radial Gradient. Will expand later.

A 2D geometric element that can be drawn and filled producing GraphicElems.

Indicates the forward mouse button was pressed.

A 2D geometric element to which 2D geometric transformations can be applied. Not all elements preserve their full properties under all transformations. So for example a Circle is no longer a Circle after a Shear transformation, but remains an Ellipse. GraphicElem inherits from GeomElem. A Circle is not a GraphicElem but if we add a fill colour to make a CircleFill, or a line width and line colour to it, we have a GraphicElem a graphical element that can be displayed on a canvas or output to SVG. It is expected that all elements that inherit from GeomElem that are not GraphicElems will be Drawable elements, but this has not been finalised.

Companion object for the GeomElem trait. Contains implicit instances of type GeomElem for all the 2D geometric transformation type classes.

Produces an HTML file documentation for the Geom module.

This trait will be removed. The base trait for all objects that can have mouse / touch pad interaction.

The base trait for all objects that can have mouse / touch pad interaction.

A DisplayElem for which all leaf elements of this trait maintain their type through all affine transformation. This type is purely for the convenience of using the fTrans method to perform all the affine transformations. It is not a useful user type hence it has no type class instances associated with it.

This trait is for layout. For placing Display elements in rows and columns. It includes PolygonGraphic and ShapeGraphics but not Line and Curve graphics.

Companion object for the BoundedGraphic trait. Contains Implicit instances for 2d geometrical transformation type-classes.

This trait is for layout. For placing Display elements in rows and columns. It includes polygon and shape graphics but not line and curve graphics.

This trait is for layout. For placing Display elements in rows and columns. It includes polygon and shape graphics but not line and curve graphics.

This is the new active trait that will replace GraphicActive.

This will be sealed in due course. A graphic element is either an element that can be rendered to a display (or printed) or is an active element in a display or both. So I think the self type will force all GraphicElems to extend CanvElem or NoCanvElem.

Companion object for the DisplayElem trait. Contains Implicit instances for 2d geometrical transformation type-classes.

This is an active visual canvas object. A pointable polygon / shape with visual, that also knows how much display space it needs and preferred margin space. Not sure about the name. not sure if the trait is useful.

A DisplayElem for which all leaf elements of this trait maintain their type through all similar transformation. This type is purely for the convenience of using the fTrans method to perform all the Similar transformations. It is not a useful user type hence it has no type class instances associated with it.