KSLCore/ksl.animation/SpatialSpaceDescriptor

SpatialSpaceDescriptor

@Serializable

sealed class SpatialSpaceDescriptor(source)

Describes a spatial space (an agent projection or a station network) so the renderer can draw its background. The initial set covers continuous, grid, and network spaces (decision D8); voxel/flow-field spaces can be added without breaking the format.

Inheritors

Continuous

Grid

Network

Constructors

SpatialSpaceDescriptor

protected constructor()

Types

Continuous

@Serializable

@SerialName(value = "Continuous")

data class Continuous(val name: String, val xMin: Double, val xMax: Double, val yMin: Double, val yMax: Double, val torus: Boolean = false) : SpatialSpaceDescriptor

A 2D continuous (Euclidean) space with the given bounds. torus wraps motion at the edges.

Grid

@Serializable

@SerialName(value = "Grid")

data class Grid(val name: String, val cols: Int, val rows: Int, val cellSize: Double, val originX: Double = 0.0, val originY: Double = 0.0, val torus: Boolean = false) : SpatialSpaceDescriptor

A rectangular grid space. torus wraps motion at the edges.

Network

@Serializable

@SerialName(value = "Network")

data class Network(val name: String, val nodes: List<NetworkNode> = emptyList(), val edges: List<NetworkEdge> = emptyList()) : SpatialSpaceDescriptor

A network space of nodes and weighted edges.

Properties

name

abstract val name: String