isometric-core/io.github.jayteealao.isometric

Package-level declarations

Types

@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.FUNCTION, AnnotationTarget.PROPERTY, AnnotationTarget.VALUE_PARAMETER])

annotation class ExperimentalIsometricApi

Marks APIs that are experimental and may change or be removed in future releases. Use at your own risk.

HitOrder

enum HitOrder : Enum<HitOrder>

Search order for hit testing.

IntersectionUtils

object IntersectionUtils

Utility functions for geometric intersection and point-in-polygon tests

IsoColor

data class IsoColor @JvmOverloads constructor(val r: Double, val g: Double, val b: Double, val a: Double = 255.0)

Represents a color with RGB and HSL representations.

IsometricEngine

class IsometricEngine @JvmOverloads constructor(angle: Double = PI / 6, scale: Double = 70.0, colorDifference: Double = 0.2, lightColor: IsoColor = IsoColor.WHITE) : SceneProjector

Core isometric rendering engine. Platform-agnostic — outputs PreparedScene that can be rendered by any platform.

Path

open class Path(points: List<Point>)

Represents a polygon face in 3D space, defined by an ordered list of vertices.

Point

class Point @JvmOverloads constructor(val x: Double = 0.0, val y: Double = 0.0, val z: Double = 0.0)

A point in 3D isometric space.

Point2D

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

A 2D point in screen space (after isometric projection).

PreparedScene

class PreparedScene(val commands: List<RenderCommand>, val width: Int, val height: Int)

A prepared scene ready for rendering. Contains platform-agnostic render commands sorted by depth.

RenderCommand

class RenderCommand(val commandId: String, val points: List<Point2D>, val color: IsoColor, val originalPath: Path, val originalShape: Shape?, val ownerNodeId: String? = null)

A platform-agnostic rendering command representing a single polygon to draw. Contains the 2D screen-space points and color, ready for rendering.

RenderOptions

class RenderOptions @JvmOverloads constructor(val enableDepthSorting: Boolean = true, val enableBackfaceCulling: Boolean = true, val enableBoundsChecking: Boolean = true, val enableBroadPhaseSort: Boolean = true, val broadPhaseCellSize: Double = DEFAULT_BROAD_PHASE_CELL_SIZE)

Configuration options for rendering

SceneProjector

interface SceneProjector

Abstraction over the isometric projection pipeline.

Shape

open class Shape(val paths: List<Path>)

Represents a 3D shape composed of multiple polygon faces (Path instances).

StackAxis

enum StackAxis : Enum<StackAxis>

The world axis along which a io.github.jayteealao.isometric.compose.runtime.Stack composable arranges its children.

TileCoordinate

class TileCoordinate(val x: Int, val y: Int)

Discrete 2D tile grid coordinate.

TileGridConfig

class TileGridConfig(val tileSize: Double = 1.0, val originOffset: Point = Point.ORIGIN, val elevation: (TileCoordinate) -> Double? = null)

Configuration for a io.github.jayteealao.isometric.compose.runtime.TileGrid composable.

Vector

class Vector(val x: Double, val y: Double, val z: Double)

A three-dimensional vector used for directions, normals, and light calculations.

Functions

screenToTile

fun IsometricEngine.screenToTile(screenX: Double, screenY: Double, viewportWidth: Int, viewportHeight: Int, tileSize: Double = 1.0, elevation: Double = 0.0, originOffset: Point = Point.ORIGIN): TileCoordinate

Returns the TileCoordinate of the tile at the given screen position on the specified z-plane.

toTileCoordinate

fun Point.toTileCoordinate(tileSize: Double = 1.0, originOffset: Point = Point.ORIGIN): TileCoordinate

Converts a continuous world Point to the TileCoordinate of the tile cell that contains it.