WxCircleBorder class
A border that fits a circle within the available space.
Typically used with ShapeDecoration to draw a circle.
The dimensions
assume that the border is being used in a square space.
When applied to a rectangular space, the border paints in the center of the
rectangle.
The eccentricity parameter describes how much a circle will deform to fit the rectangle it is a border for. A value of zero implies no deformation (a circle touching at least two sides of the rectangle), a value of one implies full deformation (an oval touching all sides of the rectangle).
See also:
- OvalBorder, which draws a Circle touching all the edges of the box.
- WxBorderSide, which is used to describe each side of the box.
- Inheritance
-
- Object
- ShapeBorder
- WxCircleBorder
Constructors
- WxCircleBorder({WxBorderSide? side, Color? color, Gradient? gradient, double? offset, WxBorderStyle? style, double? width, double eccentricity = 0.0})
-
Create a circle border.
const
Properties
- color → Color?
-
The color of the outline, if specified. Can be overridden by
gradient
.finalinherited - dimensions → EdgeInsetsGeometry
-
The widths of the sides of this border represented as an EdgeInsets.
no setterinherited
- eccentricity → double
-
Defines the ratio (0.0-1.0) from which the border will deform
to fit a rectangle.
When 0.0, it draws a circle touching at least two sides of the rectangle.
When 1.0, it draws an oval touching all sides of the rectangle.
final
- effectiveSide → WxBorderSide
-
Returns the effective WxBorderSide considering any provided overrides.
no setterinherited
- gradient → Gradient?
-
A gradient to use for painting the outline, if provided.
finalinherited
- hashCode → int
-
The hash code for this object.
no setteroverride
- offset → double?
-
An offset to apply to the outline, in logical pixels.
finalinherited
- preferPaintInterior → bool
-
Reports whether paintInterior is implemented.
no setteroverride
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- side → WxBorderSide?
-
The border outline's color and weight.
finalinherited
- style → WxBorderStyle?
-
The style of the outline (e.g., solid, dashed). Can be overridden by subclasses.
finalinherited
- width → double?
-
The desired width of the outline, in logical pixels.
finalinherited
Methods
-
add(
ShapeBorder other, {bool reversed = false}) → ShapeBorder? -
Attempts to create a new object that represents the amalgamation of
this
border and theother
border.inherited -
copyWith(
{WxBorderSide? side, WxBorderStyle? style, Color? color, Gradient? gradient, double? width, double? offset, double? eccentricity}) → WxCircleBorder -
Creates a copy of this
WxOutlinedBorder
with modified properties. -
getInnerPath(
Rect rect, {TextDirection? textDirection}) → Path -
Create a Path that describes the inner edge of the border.
override
-
getNonSolidPath(
Path source, {TextDirection? textDirection}) → Path -
Calculates the path for a non-solid outline style (e.g., dashed).
inherited
-
getOuterPath(
Rect rect, {TextDirection? textDirection}) → Path -
Create a Path that describes the outer edge of the border.
override
-
lerpFrom(
ShapeBorder? a, double t) → ShapeBorder? -
Linearly interpolates from another ShapeBorder (possibly of another
class) to
this
. -
lerpTo(
ShapeBorder? b, double t) → ShapeBorder? -
Linearly interpolates from
this
to another ShapeBorder (possibly of another class). -
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
paint(
Canvas canvas, Rect rect, {TextDirection? textDirection}) → void -
Paints the border within the given Rect on the given Canvas.
override
-
paintInterior(
Canvas canvas, Rect rect, Paint paint, {TextDirection? textDirection}) → void -
Paint a canvas with the appropriate shape.
override
-
scale(
double t) → ShapeBorder -
Creates a copy of this border, scaled by the factor
t
. -
toString(
) → String -
A string representation of this object.
override
Operators
-
operator +(
ShapeBorder other) → ShapeBorder -
Creates a new border consisting of the two borders on either side of the
operator.
inherited
-
operator ==(
Object other) → bool -
The equality operator.
override