isometric-compose/io.github.jayteealao.isometric.compose.runtime

Package-level declarations

Types

class AdvancedSceneConfig(renderOptions: RenderOptions = RenderOptions.Default, lightDirection: Vector = SceneProjector.DEFAULT_LIGHT_DIRECTION.normalize(), defaultColor: IsoColor = IsoColor(33.0, 150.0, 243.0), colorPalette: ColorPalette = ColorPalette(), strokeStyle: StrokeStyle = StrokeStyle.FillAndStroke(), gestures: GestureConfig = GestureConfig.Disabled, useNativeCanvas: Boolean = false, cameraState: CameraState? = null, val engine: SceneProjector = IsometricEngine(), val enablePathCaching: Boolean = false, val enableSpatialIndex: Boolean = true, val spatialIndexCellSize: Double = IsometricRenderer.DEFAULT_SPATIAL_INDEX_CELL_SIZE, val forceRebuild: Boolean = false, val frameVersion: Long = 0, val onHitTestReady: (hitTest: (x: Double, y: Double) -> IsometricNode?) -> Unit? = null, val onFlagsReady: (RuntimeFlagSnapshot) -> Unit? = null, val onRenderError: (commandId: String, error: Throwable) -> Unit? = null, val onEngineReady: (SceneProjector) -> Unit? = null, val onRendererReady: (IsometricRenderer) -> Unit? = null, val onBeforeDraw: DrawScope.() -> Unit? = null, val onAfterDraw: DrawScope.() -> Unit? = null, val onPreparedSceneReady: (PreparedScene) -> Unit? = null) : SceneConfig

Extended scene configuration that adds engine-level tuning and lifecycle hook callbacks on top of SceneConfig.

BatchNode

class BatchNode(var shapes: List<Shape>, var color: IsoColor) : IsometricNode

Node for batch rendering multiple shapes with the same color Useful for performance optimization

CameraState

@Stable

class CameraState(panX: Double = 0.0, panY: Double = 0.0, zoom: Double = 1.0)

Mutable camera state for programmatic viewport control.

ColorPalette

@Immutable

class ColorPalette(val primary: IsoColor = IsoColor(33.0, 150.0, 243.0), val secondary: IsoColor = IsoColor(255.0, 100.0, 0.0), val accent: IsoColor = IsoColor(0.0, 200.0, 100.0), val background: IsoColor = IsoColor(245.0, 245.0, 245.0), val surface: IsoColor = IsoColor(255.0, 255.0, 255.0), val error: IsoColor = IsoColor(244.0, 67.0, 54.0))

A palette of named semantic colors for theming an isometric scene.

CustomRenderNode

class CustomRenderNode(var renderFunction: (context: RenderContext, nodeId: String) -> List<RenderCommand>) : IsometricNode

Node that delegates rendering to a user-provided function.

DragEvent

data class DragEvent(val x: Double, val y: Double)

Describes a drag interaction within an isometric scene.

GestureConfig

@Stable

class GestureConfig(val onTap: (TapEvent) -> Unit? = null, val onDrag: (DragEvent) -> Unit? = null, val onDragStart: (DragEvent) -> Unit? = null, val onDragEnd: () -> Unit? = null, val dragThreshold: Float = 8.0f)

Configuration for gesture handling within an isometric scene.

GroupNode

class GroupNode : IsometricNode

Container node that groups other nodes and applies transforms

IsometricApplier

class IsometricApplier(root: GroupNode) : AbstractApplier<IsometricNode>

Custom Applier that teaches the Compose runtime how to build and update the isometric node tree.

IsometricComposable

annotation class IsometricComposable

Composable annotation for isometric nodes

IsometricNode

abstract class IsometricNode

Base node for the isometric scene graph. This is the fundamental building block that Compose Runtime manages. Open for extension to support custom node types via low-level ComposeNode primitives.

IsometricRenderer

class IsometricRenderer(engine: SceneProjector, enablePathCaching: Boolean = false, enableSpatialIndex: Boolean = true, spatialIndexCellSize: Double = DEFAULT_SPATIAL_INDEX_CELL_SIZE) : Closeable

Renderer that converts the isometric node tree to visual output using a SceneProjector for projection and depth sorting.

IsometricScope

@Stable

interface IsometricScope

Scope for building isometric scenes with a DSL-like syntax

PathNode

class PathNode(var path: Path, var color: IsoColor) : IsometricNode

Node representing a raw 2D path

RenderBenchmarkHooks

interface RenderBenchmarkHooks

Hooks for benchmark instrumentation of the rendering pipeline.

RenderContext

@Immutable

class RenderContext(val width: Int, val height: Int, val renderOptions: RenderOptions, val lightDirection: Vector = SceneProjector.DEFAULT_LIGHT_DIRECTION.normalize(), accumulatedPosition: Point = Point(0.0, 0.0, 0.0), accumulatedRotation: Double = 0.0, accumulatedScale: Double = 1.0, rotationOrigin: Point? = null, scaleOrigin: Point? = null)

Context for rendering that accumulates transforms through the tree hierarchy

RuntimeFlagSnapshot

data class RuntimeFlagSnapshot(val enablePathCaching: Boolean, val enableSpatialIndex: Boolean, val enableBroadPhaseSort: Boolean, val forceRebuild: Boolean, val useNativeCanvas: Boolean, val canvasWidth: Int, val canvasHeight: Int)

Snapshot of the actual runtime flag configuration applied to the renderer. Used by benchmarks to validate that flags took effect.

SceneConfig

@Immutable

open class SceneConfig(val renderOptions: RenderOptions = RenderOptions.Default, val lightDirection: Vector = DEFAULT_LIGHT_DIRECTION.normalize(), val defaultColor: IsoColor = IsoColor(33.0, 150.0, 243.0), val colorPalette: ColorPalette = ColorPalette(), val strokeStyle: StrokeStyle = StrokeStyle.FillAndStroke(), val gestures: GestureConfig = GestureConfig.Disabled, val useNativeCanvas: Boolean = false, val cameraState: CameraState? = null)

Core configuration for an isometric scene.

ShapeNode

class ShapeNode(var shape: Shape, var color: IsoColor) : IsometricNode

Node representing a 3D shape

StrokeStyle

@Immutable

sealed class StrokeStyle

Describes how shape faces are painted in an isometric scene.

TapEvent

data class TapEvent(val x: Double, val y: Double, val node: IsometricNode? = null)

Describes a tap interaction within an isometric scene.

Properties

LocalBenchmarkHooks

val LocalBenchmarkHooks: ProvidableCompositionLocal<RenderBenchmarkHooks?>

CompositionLocal for providing benchmark hooks to the renderer.

LocalColorPalette

val LocalColorPalette: ProvidableCompositionLocal<ColorPalette>

CompositionLocal for providing a ColorPalette of named semantic colors.

LocalDefaultColor

val LocalDefaultColor: ProvidableCompositionLocal<IsoColor>

CompositionLocal for providing the default IsoColor applied to shapes that do not specify an explicit color.

LocalIsometricEngine

val LocalIsometricEngine: ProvidableCompositionLocal<IsometricEngine>

CompositionLocal for providing the IsometricEngine to child composables.

LocalLightDirection

val LocalLightDirection: ProvidableCompositionLocal<Vector>

CompositionLocal for providing the directional-light vector used to shade faces.

LocalRenderOptions

val LocalRenderOptions: ProvidableCompositionLocal<RenderOptions>

CompositionLocal for providing RenderOptions that control depth sorting, back-face culling, bounds checking, and broad-phase sort behaviour.

LocalStrokeStyle

val LocalStrokeStyle: ProvidableCompositionLocal<StrokeStyle>

CompositionLocal for providing the current StrokeStyle to shapes in the scene.

Functions

Batch

@Composable

fun IsometricScope.Batch(shapes: List<Shape>, color: IsoColor = LocalDefaultColor.current, position: Point = Point(0.0, 0.0, 0.0), rotation: Double = 0.0, scale: Double = 1.0, rotationOrigin: Point? = null, scaleOrigin: Point? = null, visible: Boolean = true)

Batch multiple shapes with the same color for performance.

CustomNode

@Composable

fun IsometricScope.CustomNode(position: Point = Point(0.0, 0.0, 0.0), rotation: Double = 0.0, scale: Double = 1.0, rotationOrigin: Point? = null, scaleOrigin: Point? = null, visible: Boolean = true, renderOptions: RenderOptions? = null, render: (context: RenderContext, nodeId: String) -> List<RenderCommand>)

Add a custom-rendered node to the isometric scene.

ForEach

@Composable

fun <T> IsometricScope.ForEach(items: List<T>, key: (T) -> Any? = null, content: @Composable IsometricScope.(T) -> Unit)

Renders content once for each item in items.

Group

@Composable

fun IsometricScope.Group(position: Point = Point(0.0, 0.0, 0.0), rotation: Double = 0.0, scale: Double = 1.0, rotationOrigin: Point? = null, scaleOrigin: Point? = null, visible: Boolean = true, renderOptions: RenderOptions? = null, content: @Composable IsometricScope.() -> Unit)

Create a group that applies transforms to all its children.

@Composable

fun IsometricScope.If(condition: Boolean, content: @Composable IsometricScope.() -> Unit)

Conditionally renders content based on condition.

IsometricScene

@Composable

fun IsometricScene(modifier: Modifier = Modifier, config: AdvancedSceneConfig, content: @Composable IsometricScope.() -> Unit)

Advanced entry point exposing the full renderer and benchmark configuration.

@Composable

fun IsometricScene(modifier: Modifier = Modifier, config: SceneConfig = SceneConfig(), content: @Composable IsometricScope.() -> Unit)

High-level entry point for standard scene usage.

Path

@Composable

fun IsometricScope.Path(path: Path, color: IsoColor = LocalDefaultColor.current, position: Point = Point(0.0, 0.0, 0.0), rotation: Double = 0.0, scale: Double = 1.0, rotationOrigin: Point? = null, scaleOrigin: Point? = null, visible: Boolean = true)

Add a raw 2D path to the isometric scene.

Shape

@Composable

fun IsometricScope.Shape(geometry: Shape, color: IsoColor = LocalDefaultColor.current, position: Point = Point(0.0, 0.0, 0.0), rotation: Double = 0.0, scale: Double = 1.0, rotationOrigin: Point? = null, scaleOrigin: Point? = null, visible: Boolean = true)

Add a 3D shape to the isometric scene.

Stack

@Composable

fun IsometricScope.Stack(count: Int, axis: StackAxis = StackAxis.Z, gap: Double = 1.0, content: @Composable IsometricScope.(index: Int) -> Unit)

Renders count children arranged along axis at equal gap spacing.

TileGrid

@Composable

fun IsometricScope.TileGrid(width: Int, height: Int, config: TileGridConfig = TileGridConfig(), onTileClick: (TileCoordinate) -> Unit? = null, content: @Composable IsometricScope.(TileCoordinate) -> Unit)

Renders an isometric tile grid and routes tap events to tile coordinates.