TreeLayoutKMP/io.github.linde9821.treelayout.result/TreeLayoutResult

TreeLayoutResult

class TreeLayoutResult<T>(positions: Map<T, Point>, maxDepth: Int)(source)

The result of a tree layout computation, providing access to node positions, layout metadata, and transformation utilities.

Type Parameters

The node type of the external tree.

Constructors

TreeLayoutResult

constructor(positions: Map<T, Point>, maxDepth: Int)

Types

Companion

object Companion

Functions

centered

fun centered(width: Float, height: Float): TreeLayoutResult<T>

Returns a new result centered within a viewport of width×height. The layout is first scaled to fit (preserving aspect ratio), then offset so that the bounding box is centered in the viewport.

getBounds

fun getBounds(): Bounds

Returns the axis-aligned bounding box of all node positions.

getMaxDepth

fun getMaxDepth(): Int

Returns the maximum depth of the tree.

getPosition

fun getPosition(node: T): Point

Returns the position assigned to node.

getPositions

fun getPositions(): Map<T, Point>

Returns all node-to-position mappings.

mapped

fun mapped(transform: (Point) -> Point): TreeLayoutResult<T>

Returns a new result with all positions transformed by transform.

normalized

fun normalized(): TreeLayoutResult<T>

Returns a new result with all positions shifted so the minimum corner is at the origin.

scaledTo

fun scaledTo(width: Float, height: Float): TreeLayoutResult<T>

Returns a new result uniformly scaled to fit within width×height, preserving aspect ratio. Positions are normalized to origin before scaling.

toJson

fun <T> TreeLayoutResult<T>.toJson(nodeToKey: (T) -> String): String

Serializes a TreeLayoutResult to a JSON string.

translated

fun translated(dx: Float, dy: Float): TreeLayoutResult<T>

Returns a new result with all positions shifted by dx and dy.