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

Circle

ostrat.geom.Circle
See theCircle companion object
final case class Circle(diameter: Double, cenX: Double, cenY: Double) extends Ellipselign, OrdinaledElem, AxisFree

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

Attributes

Companion
object
Graph
Supertypes
trait Serializable
trait Product
trait Equals
trait AxisFree
trait Ellipselign
trait Ellipse
trait ShapeCentred
trait CentredElem
trait Shape
trait BoundedElem
trait Fillable
trait Drawable
trait EllipseBased
trait WithCentre
trait GeomElem
class Object
trait Matchable
class Any
Show all

Members list

Type members

Types

type ThisT = Circle

Value members

Concrete methods

override def area: Double

Attributes

Definition Classes
override def attribs: RArr[XmlAtt]

Attributes

Definition Classes
override def axesPt1x: Double

The X component of the end point of axis 1. By default this is on the right of the Ellipse. Mathematically this can be referred to as a vertex for the major axis or a co-vertex for the minor axis.

The X component of the end point of axis 1. By default this is on the right of the Ellipse. Mathematically this can be referred to as a vertex for the major axis or a co-vertex for the minor axis.

Attributes

Definition Classes
override def axesPt1y: Double

The Y component of the end point of axis 1. By default this is on the right of the Ellipse. Mathematically this can be referred to as a vertex for the major axis or a co-vertex for the minor axis.

The Y component of the end point of axis 1. By default this is on the right of the Ellipse. Mathematically this can be referred to as a vertex for the major axis or a co-vertex for the minor axis.

Attributes

Definition Classes
override def axesPt2x: Double

The X component of the start point of axis 2. By default this is at the bottom of the Ellipse. Mathematically this can be referred to as a vertex for the major axis or a co-vertex for the minor axis.

The X component of the start point of axis 2. By default this is at the bottom of the Ellipse. Mathematically this can be referred to as a vertex for the major axis or a co-vertex for the minor axis.

Attributes

Definition Classes
override def axesPt2y: Double

The Y component of the start point of axis 2. By default this is at the bottom of the Ellipse. Mathematically this can be referred to as a vertex for the major axis or a co-vertex for the minor axis.

The Y component of the start point of axis 2. By default this is at the bottom of the Ellipse. Mathematically this can be referred to as a vertex for the major axis or a co-vertex for the minor axis.

Attributes

Definition Classes
override def axesPt3x: Double

The X component of the start point of axis 1. By default this is on the left of the Ellipse. Mathematically this can be referred to as a vertex for the major axis or a co-vertex for the minor axis.

The X component of the start point of axis 1. By default this is on the left of the Ellipse. Mathematically this can be referred to as a vertex for the major axis or a co-vertex for the minor axis.

Attributes

Definition Classes
override def axesPt3y: Double

The Y component of the start point of axis 1. By default this is on the left of the Ellipse. Mathematically this can be referred to as a vertex for the major axis or a co-vertex for the minor axis.

The Y component of the start point of axis 1. By default this is on the left of the Ellipse. Mathematically this can be referred to as a vertex for the major axis or a co-vertex for the minor axis.

Attributes

Definition Classes
override def axesPt4: Pt2

The end point of axis 2. By default this is at the top of the Ellipse. Mathematically this can be referred to as a vertex for the major axis or a co-vertex for the minor axis.

The end point of axis 2. By default this is at the top of the Ellipse. Mathematically this can be referred to as a vertex for the major axis or a co-vertex for the minor axis.

Attributes

Definition Classes
override def axesPt4x: Double

The X component of the end point of axis 2. By default this is at the top of the Ellipse. Mathematically this can be referred to as a vertex for the major axis or a co-vertex for the minor axis.

The X component of the end point of axis 2. By default this is at the top of the Ellipse. Mathematically this can be referred to as a vertex for the major axis or a co-vertex for the minor axis.

Attributes

Definition Classes
override def axesPt4y: Double

The Y component of the end point of axis 2. By default this is at the top of the Ellipse. Mathematically this can be referred to as a vertex for the major axis or a co-vertex for the minor axis.

The Y component of the end point of axis 2. By default this is at the top of the Ellipse. Mathematically this can be referred to as a vertex for the major axis or a co-vertex for the minor axis.

Attributes

Definition Classes
override def bottomLeft: Pt2

Attributes

Definition Classes
override def bottomRight: Pt2

Attributes

Definition Classes
override def boundingHeight: Double

The height of the BoundingRect of this object.

The height of the BoundingRect of this object.

Attributes

Definition Classes
def boundingRect: Rect

The bounding Rectangle provides an initial exclusion test as to whether the pointer is inside the polygon / shape

The bounding Rectangle provides an initial exclusion test as to whether the pointer is inside the polygon / shape

Attributes

override def boundingWidth: Double

The width of the BoundingRect of this object.

The width of the BoundingRect of this object.

Attributes

Definition Classes
override def cenP1: Vec2

The 2D vector Vec2 from the centre point to pAxes1, the end point of axis 1, by default on the right of the Ellipse this arc is based on.

The 2D vector Vec2 from the centre point to pAxes1, the end point of axis 1, by default on the right of the Ellipse this arc is based on.

Attributes

Definition Classes
override def cenP2: Vec2

The 2D vector Vec2 from the centre point to pAxes2, the start point of axis 2, by default at the bottom of the Ellipse this arc is based on.

The 2D vector Vec2 from the centre point to pAxes2, the start point of axis 2, by default at the bottom of the Ellipse this arc is based on.

Attributes

Definition Classes
override def cenP3: Vec2

The 2D vector Vec2 from the centre point to pAxes3, the start point of axis 1 , by default on the left of the Ellipse this arc is based on.

The 2D vector Vec2 from the centre point to pAxes3, the start point of axis 1 , by default on the left of the Ellipse this arc is based on.

Attributes

Definition Classes
override def cenP4: Vec2

The 2D vector Vec2 from the centre point to pAxes4, the end point of axis 2, by default at the top of the Ellipse this arc is based on.

The 2D vector Vec2 from the centre point to pAxes4, the end point of axis 2, by default at the top of the Ellipse this arc is based on.

Attributes

Definition Classes
override def draw(lineWidth: Double, lineColour: Colour): CircleDraw

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
override def e: Double

Eccentricity of ellipse.

Eccentricity of ellipse.

Attributes

Definition Classes
override def fTrans(f: Pt2 => Pt2): Circle

Attributes

Definition Classes
override def fill(fillColour: Colour): CircleFill

Returns a fill graphic of this geometric object.

Returns a fill graphic of this geometric object.

Attributes

Definition Classes
override def fillActive(fillColour: Colour, pointerID: Any): CircleCompound

Attributes

Definition Classes
override def fillActiveText(fillColour: Colour, pointerEv: Any, str: String, fontRatio: Double, fontColour: Colour, align: TextAlign, baseLine: BaseLine, minSize: Double): CircleCompound

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
def fillActiveTextAbs(fillColour: Colour, pointerID: Any, str: String, fontSize: Double, fontColour: Colour): CircleCompound
def fillActiveTextlign(fillColour: Colour, pointerEv: Any, str: String, fontSize: Double, fontColour: Colour, align: TextAlign): CircleCompound
override def fillDraw(fillColour: Colour, lineColour: Colour, lineWidth: Double): CircleCompound

Returns a CircleCompound with a FillFacet and a DrawFact.

Returns a CircleCompound with a FillFacet and a DrawFact.

Attributes

Definition Classes
override def fillInt(intValue: Int): CircleFill

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
def fillRadial(cenColour: Colour, outerColour: Colour): CircleCompound
override def h: Double

The h value of this ellipse.

The h value of this ellipse.

Attributes

Definition Classes
override def prolign(matrix: ProlignMatrix): Circle

2D Transformation using a ProlignMatrix on a Shape, returns a Shape. The Return type will be narrowed in sub traits / classes.

2D Transformation using a ProlignMatrix on a Shape, returns a Shape. The Return type will be narrowed in sub traits / classes.

Attributes

Definition Classes
override def ptInside(pt: Pt2): Boolean

Determines if the parameter point lies inside this Circle.

Determines if the parameter point lies inside this Circle.

Attributes

Definition Classes
override def rMajor: Double

The major radius of this ellipse, often referred to as a in maths.

The major radius of this ellipse, often referred to as a in maths.

Attributes

Definition Classes
override def rMinor: Double

The major radius of this ellipse,often refered to as b in maths.

The major radius of this ellipse,often refered to as b in maths.

Attributes

Definition Classes
def radius: Double

Diameter of the circle. This has the same value as width, a property that hasn't been created yet.

Diameter of the circle. This has the same value as width, a property that hasn't been created yet.

Attributes

override def radius1: Double

Radius 1 of the ellipse. By default this is the horizontal axis of the ellipse. This can be the major or minor axis.

Radius 1 of the ellipse. By default this is the horizontal axis of the ellipse. This can be the major or minor axis.

Attributes

Definition Classes
override def radius2: Double

Radius 2 of the ellipse. By default this is the vertical axis of the ellipse. This can be the major or minor axis.

Radius 2 of the ellipse. By default this is the vertical axis of the ellipse. This can be the major or minor axis.

Attributes

Definition Classes
override def reflect(lineLike: LineLike): Circle

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

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

Attributes

Definition Classes
override def rotate(angle: AngleVec): Circle

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

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

Attributes

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

uniform scaling transformation on a Circle returns a circle. Use the xyScale method for differential scaling.

uniform scaling transformation on a Circle returns a circle. Use the xyScale method for differential scaling.

Attributes

Definition Classes
override def slateXY(xDelta: Double, yDelta: Double): Circle

Translate geometric transformation on a Circle returns a Circle.

Translate geometric transformation on a Circle returns a Circle.

Attributes

Definition Classes
override def topLeft: Pt2

Attributes

Definition Classes
override def topRight: Pt2

Attributes

Definition Classes
override def xRadius: Double

The radius of the axis of the ellipse aligned to the X axis.

The radius of the axis of the ellipse aligned to the X axis.

Attributes

Definition Classes
override def yRadius: Double

The radius of the axis of the ellipse aligned to the Y axis.

The radius of the axis of the ellipse aligned to the Y axis.

Attributes

Definition Classes

Inherited methods

final override def alignAngle: Angle

The alignment angle of axis 1 in an Ellipselign including the special case of Circle is by definition 0°.

The alignment angle of axis 1 in an Ellipselign including the special case of Circle is by definition 0°.

Attributes

Definition Classes
Inherited from:
Ellipselign
final def axesPt1: Pt2

The end point of axis 1. By default this is on the right of the Ellipse. Mathematically this can be referred to as a vertex for the major axis or a co-vertex for the minor axis.

The end point of axis 1. By default this is on the right of the Ellipse. Mathematically this can be referred to as a vertex for the major axis or a co-vertex for the minor axis.

Attributes

Inherited from:
Ellipse
final def axesPt2: Pt2

The start point of axis 2. By default this is at the bottom of the Ellipse. Mathematically this can be referred to as a vertex for the major axis or a co-vertex for the minor axis.

The start point of axis 2. By default this is at the bottom of the Ellipse. Mathematically this can be referred to as a vertex for the major axis or a co-vertex for the minor axis.

Attributes

Inherited from:
Ellipse
override def axesPt3: Pt2

The start point of axis 1. By default this is on the left of the Ellipse. Mathematically this can be referred to as a vertex for the major axis or a co-vertex for the minor axis.

The start point of axis 1. By default this is on the left of the Ellipse. Mathematically this can be referred to as a vertex for the major axis or a co-vertex for the minor axis.

Attributes

Definition Classes
Inherited from:
Ellipse
def blBounding: Pt2

Attributes

Inherited from:
BoundedElem
def blOffset: Vec2

Attributes

Inherited from:
OrdinalEdgePoints
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
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:
Ellipse
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
def cxAttrib: XmlAtt

Attributes

Inherited from:
Ellipse
def cyAttrib: XmlAtt

Attributes

Inherited from:
Ellipse
final def diameter1: Double

Diameter 1 of the ellipse. By default this is the horizontal axis of the ellipse.This can be the major or minor axis.

Diameter 1 of the ellipse. By default this is the horizontal axis of the ellipse.This can be the major or minor axis.

Attributes

Inherited from:
EllipseBased
final def diameter2: Double

Diameter 2 of this ellipse. By default this is the vertical axis of the ellipse. This can be the major or minor axis.

Diameter 2 of this ellipse. By default this is the vertical axis of the ellipse. This can be the major or minor axis.

Attributes

Inherited from:
EllipseBased
def fillOrDraw(lineWidth: Double, colour: Colour): GraphicElem

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
override def negX: ThisT

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
Inherited from:
AxisFree
override def negY: ThisT

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
Inherited from:
AxisFree
def productElementNames: Iterator[String]

Attributes

Inherited from:
Product
def productIterator: Iterator[Any]

Attributes

Inherited from:
Product
override def rotate180: ThisT

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

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

Attributes

Definition Classes
Inherited from:
AxisFree
override def rotate270: ThisT

Rotation positive or anti clockwise 270 degrees, 2D geometric transformation on a GeomElem, returns a GeomElem. The return type will be narrowed in sub classes 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 sub classes and traits.

Attributes

Definition Classes
Inherited from:
AxisFree
override def rotate90: ThisT

Rotation positive or anti clockwise 90 degrees, 2D geometric transformation on a GeomElem, returns a GeomElem. The return type will be narrowed in sub classes 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 sub classes and traits.

Attributes

Definition Classes
Inherited from:
AxisFree
def rxAttrib: XmlAtt

Attributes

Inherited from:
Ellipse
def ryAttrib: XmlAtt

Attributes

Inherited from:
Ellipse
override def scaleXY(xOperand: Double, yOperand: Double): Ellipse

XY scaling 2D geometric transformation on a Shape returns a Shape. This allows different scaling factors across X and Y dimensions. The return type will be narrowed in sub classes and traits.

XY scaling 2D geometric transformation on a Shape returns a Shape. This allows different scaling factors across X and Y dimensions. The return type will be narrowed in sub classes and traits.

Attributes

Definition Classes
Inherited from:
Ellipse
override def shearX(operand: Double): Ellipse

Shear 2D geometric transformation along the X Axis on a Shape, returns a Shape. The return type will be narrowed in sub classes and traits.

Shear 2D geometric transformation along the X Axis on a Shape, returns a Shape. The return type will be narrowed in sub classes and traits.

Attributes

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

Shear 2D geometric transformation along the Y Axis on a Shape, returns a Shape. The return type will be narrowed in sub classes and traits.

Shear 2D geometric transformation along the Y Axis on a Shape, returns a Shape. The return type will be narrowed in sub classes and traits.

Attributes

Definition Classes
Inherited from:
Ellipse
def tlBounding: Pt2

Attributes

Inherited from:
BoundedElem
def tlOffset: Vec2

Attributes

Inherited from:
OrdinalEdgePoints
def trOffset: Vec2

Top right offset from centre.

Top right offset from centre.

Attributes

Inherited from:
OrdinalEdgePoints
Generated with