DrawOutlineOptions

data class DrawOutlineOptions(val drawShare: Float = 0.7f, val startAt: VertexId? = null, val reversed: Boolean = false, val lineColor: ColorRgba? = null, val lineWidth: Float? = null, val penColor: ColorRgba = ColorRgba(0, 0, 0), val headColor: ColorRgba? = null, val trailShare: Float = 0.25f, val trailBands: Int = 10, val glow: Float = 1.0f)

How a polygon's outline is drawn by DrawOutline.

Constructors

Link copied to clipboard
constructor(drawShare: Float = 0.7f, startAt: VertexId? = null, reversed: Boolean = false, lineColor: ColorRgba? = null, lineWidth: Float? = null, penColor: ColorRgba = ColorRgba(0, 0, 0), headColor: ColorRgba? = null, trailShare: Float = 0.25f, trailBands: Int = 10, glow: Float = 1.0f)

Properties

Link copied to clipboard

how much of the effect (0..1 of its time) the outline takes to be drawn; the rest is the fill coming in. It must be more than 0 and less than 1.

Link copied to clipboard
val glow: Float

how much the line shines, like a neon tube: 0 for a plain line, 1 for a halo round the line and a hot core; more than 1 makes the light stronger and wider.

Link copied to clipboard

the colour at the tip of the pen and in the line right behind it; null for the line's colour made lighter.

Link copied to clipboard

the colour of the line the pen draws; null for the polygon's own outline colour (and penColor if it has none). As the fill comes in the line takes the polygon's own outline colour, so the effect ends on exactly the polygon.

Link copied to clipboard

the width of the line the pen draws, in screen pixels; null for the polygon's own outline width.

Link copied to clipboard

the colour of the line the pen draws, when neither lineColor nor a plain outline colour of the polygon is given.

Link copied to clipboard

whether the pen goes the other way round, against the order of the corners.

Link copied to clipboard

the corner the pen starts at, in the ring that has it (every ring starts at its first corner if this is null or is in another ring).

Link copied to clipboard

the number of pieces the cooling part is cut into (each is one colour); more is smoother and costs more shapes.

Link copied to clipboard

how much of the way round (0..1) the line behind the pen takes to cool from headColor to the line's own colour; the line behind that is the line's own colour. 0 for a line of one colour.