maps-kt-features/space.kscience.maps.features

Package-level declarations

Types

object AlphaAttribute : Attribute<Float>

@Stable

data class ArcFeature<T : Any>(val space: CoordinateSpace<T>, val oval: Rectangle<T>, val startAngle: Angle, val arcLength: Angle, val attributes: Attributes = Attributes.EMPTY) : DraggableFeature<T>

Area

interface Area<T : Any>

BitmapIconFeature

@Stable

data class BitmapIconFeature<T : Any>(val space: CoordinateSpace<T>, val center: T, val size: DpSize, val image: ImageBitmap, val attributes: Attributes = Attributes.EMPTY) : MarkerFeature<T>

Fixed size bitmap icon

CanvasState

abstract class CanvasState<T : Any>(val viewConfig: ViewConfig<T>)

A state holder for current canvas size and view point. Allows transformation from coordinates to pixels and back

CircleFeature

@Stable

data class CircleFeature<T : Any>(val space: CoordinateSpace<T>, val center: T, val radius: Dp = 5.dp, val attributes: Attributes = Attributes.EMPTY) : MarkerFeature<T>

ClickListenerAttribute

object ClickListenerAttribute : SetAttribute<MouseListener<Any>>

ClickRadius

object ClickRadius : Attribute<Float>

Click radius for point-like and line objects

ColorAttribute

object ColorAttribute : Attribute<Color>

ComposeFeatureDrawScope

class ComposeFeatureDrawScope<T : Any>(drawScope: DrawScope, state: CanvasState<T>, painterCache: Map<PainterFeature<T>, Painter>, textMeasurer: TextMeasurer?) : FeatureDrawScope<T> , DrawScope

Default implementation of FeatureDrawScope to be used in Compose (both schemes and Maps)

CoordinateSpace

interface CoordinateSpace<T : Any>

A context for map/scheme coordinates manipulation

DomainFeature

interface DomainFeature<T : Any> : Feature<T>

DraggableAttribute

object DraggableAttribute : Attribute<DragHandle<Any>>

DraggableFeature

interface DraggableFeature<T : Any> : DomainFeature<T>

DragHandle

fun interface DragHandle<T : Any>

DragListener

fun interface DragListener<in T : Any>

DragListenerAttribute

object DragListenerAttribute : SetAttribute<DragListener<Any>>

DragResult

data class DragResult<T : Any>(val result: ViewPoint<T>, val handleNext: Boolean = true)

DrawFeature

data class DrawFeature<T : Any>(val space: CoordinateSpace<T>, val position: T, val attributes: Attributes = Attributes.EMPTY, val drawFeature: DrawScope.() -> Unit) : DraggableFeature<T>

Feature

interface Feature<T : Any>

FeatureBuilder

interface FeatureBuilder<T : Any>

FeatureDrawScope

abstract class FeatureDrawScope<T : Any>(val state: CanvasState<T>) : DrawScope

An extension of DrawScope to include map-specific features

FeatureGroup

data class FeatureGroup<T : Any> : CoordinateSpace<T> , Feature<T> , FeatureBuilder<T> , FeatureSet<T>

A group of other features

FeatureRef

class FeatureRef<T : Any, out F : Feature<T>>

A reference to a feature inside a FeatureStore

FeatureSelector

@Stable

data class FeatureSelector<T : Any>(val space: CoordinateSpace<T>, val attributes: Attributes = Attributes.EMPTY, val selector: (zoom: Float) -> Feature<T>) : Feature<T>

A feature that decides what to show depending on the zoom value (it could change size of shape)

FeatureSet

interface FeatureSet<T : Any>

FeatureStore

class FeatureStore<T : Any>(val space: CoordinateSpace<T>) : CoordinateSpace<T> , FeatureBuilder<T> , FeatureSet<T>

FloatRange

typealias FloatRange = ClosedFloatingPointRange<Float>

HoverListenerAttribute

object HoverListenerAttribute : SetAttribute<MouseListener<Any>>

LineFeature

@Stable

data class LineFeature<T : Any>(val space: CoordinateSpace<T>, val a: T, val b: T, val attributes: Attributes = Attributes.EMPTY) : DomainFeature<T> , LineSegmentFeature<T>

LineSegmentFeature

interface LineSegmentFeature<T : Any> : Feature<T>

MarkerFeature

interface MarkerFeature<T : Any> : DraggableFeature<T>

A draggable marker feature. Other features could be bound to this one.

MouseListener

fun interface MouseListener<in T : Any>

MultiLineFeature

data class MultiLineFeature<T : Any>(val space: CoordinateSpace<T>, val points: List<T>, val attributes: Attributes = Attributes.EMPTY) : DomainFeature<T> , LineSegmentFeature<T>

PainterFeature

interface PainterFeature<T : Any> : Feature<T>

PathEffectAttribute

object PathEffectAttribute : Attribute<PathEffect>

PathFeature

@Stable

data class PathFeature<T : Any>(val space: CoordinateSpace<T>, val rectangle: Rectangle<T>, val path: Path, val brush: Brush, val style: DrawStyle = Fill, val targetRect: Rect = path.getBounds(), val attributes: Attributes = Attributes.EMPTY) : DraggableFeature<T>

PixelMapFeature

data class PixelMapFeature<T : Any>(val space: CoordinateSpace<T>, val rectangle: Rectangle<T>, val pixelMap: Structure2D<Color?>, val attributes: Attributes = Attributes.EMPTY) : Feature<T>

A pixel map representation on the map/scheme. rectangle describes the boundary of the pixel map. pixelMap contained indexed color of pixels. Minimal indices correspond to bottom-left corner of the rectangle. Maximal indices - top-right.

PointsFeature

@Stable

data class PointsFeature<T : Any>(val space: CoordinateSpace<T>, val points: List<T>, val attributes: Attributes = Attributes.EMPTY) : Feature<T>

PolygonFeature

@Stable

data class PolygonFeature<T : Any>(val space: CoordinateSpace<T>, val points: List<T>, val attributes: Attributes = Attributes.EMPTY) : DomainFeature<T>

Rectangle

interface Rectangle<T : Any> : Area<T>

A map coordinates rectangle. a and b represent opposing angles of the rectangle without specifying which ones.

RectangleFeature

@Stable

data class RectangleFeature<T : Any>(val space: CoordinateSpace<T>, val center: T, val size: DpSize = DpSize(5.dp, 5.dp), val attributes: Attributes = Attributes.EMPTY) : MarkerFeature<T>

ScalableImageFeature

data class ScalableImageFeature<T : Any>(val space: CoordinateSpace<T>, val rectangle: Rectangle<T>, val attributes: Attributes = Attributes.EMPTY, val painter: @Composable () -> Painter) : Feature<T> , PainterFeature<T>

An image that is bound to coordinates and is scaled (and possibly warped) together with them

StrokeAttribute

object StrokeAttribute : Attribute<Float>

TextFeature

data class TextFeature<T : Any>(val space: CoordinateSpace<T>, val position: T, val text: String, val attributes: Attributes = Attributes.EMPTY, val fontConfig: Font.() -> Unit) : DraggableFeature<T>

VectorIconFeature

@Stable

data class VectorIconFeature<T : Any>(val space: CoordinateSpace<T>, val center: T, val size: DpSize, val image: ImageVector, val attributes: Attributes = Attributes.EMPTY) : MarkerFeature<T> , PainterFeature<T>

Fixed size vector icon

ViewConfig

data class ViewConfig<T : Any>(val zoomSpeed: Float = 1f / 3f, val onClick: MouseListener<T>? = null, val dragHandle: DragHandle<T>? = null, val onViewChange: ViewPoint<T>.() -> Unit = {}, val onSelect: (Rectangle<T>) -> Unit = {}, val onCanvasSizeChange: (DpSize) -> Unit = {}, val zoomOnSelect: Boolean = true, val zoomOnDoubleClick: Boolean = true)

ViewPoint

interface ViewPoint<out T : Any>

VisibleAttribute

object VisibleAttribute : Attribute<Boolean>

ZAttribute

object ZAttribute : Attribute<Float>

ZoomRangeAttribute

object ZoomRangeAttribute : Attribute<FloatRange>

Properties

attributes

val <T : Any, F : Feature<T>> FeatureRef<T, F>.attributes: Attributes

bottomRight

val DpRect.bottomRight: DpOffset

color

val Feature<*>.color: Color?

name

val Feature<*>.name: String?

topLeft

val DpRect.topLeft: DpOffset

val Feature<*>.z: Float

zoomRange

val Feature<*>.zoomRange: FloatRange

Functions

alpha

fun <T : Any, F : Feature<T>> FeatureRef<T, F>.alpha(alpha: Float): FeatureRef<T, F>

arc

fun <T : Any> FeatureBuilder<T>.arc(oval: Rectangle<T>, startAngle: Angle, arcLength: Angle, attributes: Attributes = Attributes.EMPTY, id: String? = null): FeatureRef<T, ArcFeature<T>>

circle

fun <T : Any> FeatureBuilder<T>.circle(center: T, size: Dp = 5.dp, attributes: Attributes = Attributes.EMPTY, id: String? = null): FeatureRef<T, CircleFeature<T>>

color

fun <T : Any, F : Feature<T>> FeatureRef<T, F>.color(color: Color): FeatureRef<T, F>

computeBoundingBox

fun <T : Any> Iterable<Feature<T>>.computeBoundingBox(space: CoordinateSpace<T>, zoom: Float): Rectangle<T>?

draggable

fun <T : Any, F : DraggableFeature<T>> FeatureRef<T, F>.draggable(constraint: (T) -> T? = null, listener: PointerEvent.(from: ViewPoint<T>, to: ViewPoint<T>) -> Unit? = null): FeatureRef<T, F>

Add drag to this feature

draggableLine

fun <T : Any> FeatureBuilder<T>.draggableLine(aId: FeatureRef<T, MarkerFeature<T>>, bId: FeatureRef<T, MarkerFeature<T>>, id: String? = null): FeatureRef<T, LineFeature<T>>

draggableMultiLine

@JvmName(name = "draggableMultiLineFromPoints")

fun <T : Any> FeatureBuilder<T>.draggableMultiLine(points: List<T>, id: String? = null): FeatureRef<T, MultiLineFeature<T>>

fun <T : Any> FeatureBuilder<T>.draggableMultiLine(points: List<FeatureRef<T, MarkerFeature<T>>>, id: String? = null): FeatureRef<T, MultiLineFeature<T>>

draw

fun <T : Any> FeatureBuilder<T>.draw(position: T, attributes: Attributes = Attributes.EMPTY, id: String? = null, draw: DrawScope.() -> Unit): FeatureRef<T, DrawFeature<T>>

drawFeature

fun <T : Any> FeatureDrawScope<T>.drawFeature(feature: Feature<T>, baseAttributes: Attributes)

FeatureCanvas

@Composable

fun <T : Any> FeatureCanvas(state: CanvasState<T>, featureFlow: StateFlow<Map<String, Feature<T>>>, modifier: Modifier = Modifier, sampleDuration: Duration = 20.milliseconds, draw: FeatureDrawScope<T>.() -> Unit = {})

Create a canvas with extended functionality (e.g., drawing text)

forEachUntil

fun <T : Any> FeatureSet<T>.forEachUntil(block: FeatureSet<T>.(ref: FeatureRef<T, *>, feature: Feature<T>) -> Boolean)

Recursively search for feature until function returns true

forEachWithAttribute

inline fun <T : Any, A> FeatureSet<T>.forEachWithAttribute(key: Attribute<A>, block: FeatureSet<T>.(ref: FeatureRef<T, *>, feature: Feature<T>, attribute: A) -> Unit)

Process all features with a given attribute from the one with highest z to lowest

forEachWithAttributeUntil

inline fun <T : Any, A> FeatureSet<T>.forEachWithAttributeUntil(key: Attribute<A>, block: FeatureSet<T>.(ref: FeatureRef<T, *>, feature: Feature<T>, attribute: A) -> Boolean)

forEachWithType

inline fun <T : Any, F : Feature<T>> FeatureSet<T>.forEachWithType(crossinline block: FeatureSet<T>.(ref: FeatureRef<T, F>, feature: F) -> Unit)

icon

fun <T : Any> FeatureBuilder<T>.icon(position: T, image: ImageVector, size: DpSize = DpSize(image.defaultWidth, image.defaultHeight), attributes: Attributes = Attributes.EMPTY, id: String? = null): FeatureRef<T, VectorIconFeature<T>>

line

fun <T : Any> FeatureBuilder<T>.line(aCoordinates: T, bCoordinates: T, attributes: Attributes = Attributes.EMPTY, id: String? = null): FeatureRef<T, LineFeature<T>>

modifyAttribute

fun <T : Any, F : Feature<T>, V> FeatureRef<T, F>.modifyAttribute(key: Attribute<V>, value: V): FeatureRef<T, F>

modifyAttributes

fun <T : Any, F : Feature<T>> FeatureRef<T, F>.modifyAttributes(modification: AttributesBuilder<F>.() -> Unit): FeatureRef<T, F>

multiLine

fun <T : Any> FeatureBuilder<T>.multiLine(points: List<T>, attributes: Attributes = Attributes.EMPTY, id: String? = null): FeatureRef<T, MultiLineFeature<T>>

onClick

fun <T : Any, F : DomainFeature<T>> FeatureRef<T, F>.onClick(onClick: PointerEvent.(click: ViewPoint<T>) -> Unit): FeatureRef<T, F>

fun <T : Any, F : DomainFeature<T>> FeatureRef<T, F>.onClick(pointerMatcher: PointerMatcher, keyboardModifiers: PointerKeyboardModifiers.() -> Boolean = { true }, onClick: PointerEvent.(click: ViewPoint<T>) -> Unit): FeatureRef<T, F>

onDrag

fun <T : Any, F : DraggableFeature<T>> FeatureRef<T, F>.onDrag(listener: PointerEvent.(from: ViewPoint<T>, to: ViewPoint<T>) -> Unit): FeatureRef<T, F>

onHover

fun <T : Any, F : DomainFeature<T>> FeatureRef<T, F>.onHover(onClick: PointerEvent.(move: ViewPoint<T>) -> Unit): FeatureRef<T, F>

pathEffect

fun <T : Any> FeatureRef<T, LineSegmentFeature<T>>.pathEffect(effect: PathEffect): FeatureRef<T, LineSegmentFeature<T>>

pixelMap

fun <T : Any> FeatureStore<T>.pixelMap(rectangle: Rectangle<T>, pixelMap: Structure2D<Color?>, attributes: Attributes = Attributes.EMPTY, id: String? = null): FeatureRef<T, PixelMapFeature<T>>

pointerCache

@Composable

fun <T : Any> FeatureSet<T>.pointerCache(): Map<PainterFeature<T>, Painter>

points

fun <T : Any> FeatureBuilder<T>.points(points: List<T>, attributes: Attributes = Attributes.EMPTY, id: String? = null): FeatureRef<T, PointsFeature<T>>

pointSize

fun <T : Any, F : PointsFeature<T>> FeatureRef<T, F>.pointSize(width: Float): FeatureRef<T, F>

polygon

fun <T : Any> FeatureBuilder<T>.polygon(points: List<T>, attributes: Attributes = Attributes.EMPTY, id: String? = null): FeatureRef<T, PolygonFeature<T>>

Rectangle

fun <T : Any> CoordinateSpace<T>.Rectangle(viewPoint: ViewPoint<T>, size: DpSize): Rectangle<T>

rectangle

fun <T : Any> FeatureBuilder<T>.rectangle(centerCoordinates: T, size: DpSize = DpSize(5.dp, 5.dp), attributes: Attributes = Attributes.EMPTY, id: String? = null): FeatureRef<T, RectangleFeature<T>>

resolve

fun <T : Any, F : Feature<T>> FeatureRef<T, F>.resolve(): F

scalableImage

fun <T : Any> FeatureBuilder<T>.scalableImage(box: Rectangle<T>, attributes: Attributes = Attributes.EMPTY, id: String? = null, painter: @Composable () -> Painter): FeatureRef<T, ScalableImageFeature<T>>

stroke

fun <T : Any, F : LineSegmentFeature<T>> FeatureRef<T, F>.stroke(width: Float): FeatureRef<T, F>

Structure2D

inline fun <T> Structure2D(rows: Int, columns: Int, initializer: (IntArray) -> T): Structure2D<T>

text

fun <T : Any> FeatureBuilder<T>.text(position: T, text: String, font: Font.() -> Unit = { size = 16f }, attributes: Attributes = Attributes.EMPTY, id: String? = null): FeatureRef<T, TextFeature<T>>

toIndex

fun Uuid.toIndex(): String

toPrettyString

fun FeatureGroup<*>.toPrettyString(): String

Create a pretty tree-like representation of this feature group

zoomRange

fun <T : Any, F : Feature<T>> FeatureRef<T, F>.zoomRange(range: FloatRange): FeatureRef<T, F>