Represents a 3D path composed of multiple segments. The class supports operations on the path, such as transformations, sampling, sub-path extraction, and various geometric calculations. It also provides methods for creating paths from points or segments and combines functionality for both open and closed paths.

Path3DBuilder

class Path3DBuilder

PathProjection3D

class PathProjection3D(val segmentProjection: SegmentProjection3D, val projection: Double, val distance: Double, val point: Vector3)

Rectangle

@Serializable

@JvmRecord

data class Rectangle(val corner: Vector2, val width: Double, val height: Double = width) : Movable, Scalable2D, ShapeProvider, ShapeContourProvider, LinearType<Rectangle>

Creates a new axis-aligned Rectangle.

Scalable1D

sealed interface Scalable1D

Scalable2D

sealed interface Scalable2D : Scalable1D

Scalable3D

interface Scalable3D

Segment1D

@Serializable

@JvmRecord

data class Segment1D(val start: Double, val control: Array<Double>, val end: Double) : LinearType<Segment1D>

Segment2D

@Serializable

data class Segment2D(val start: Vector2, val control: List<Vector2>, val end: Vector2, val corner: Boolean = false) : BezierSegment<Vector2> , ShapeContourProvider

Creates a new Segment2D, which specifies a linear or a Bézier curve path between two anchor points (and up to two control points for curvature).

Segment3D

@Serializable

class Segment3D(val start: Vector3, val control: List<Vector3>, val end: Vector3) : BezierSegment<Vector3>

SegmentIntersection

class SegmentIntersection(val a: SegmentPoint, val b: SegmentPoint, val position: Vector2)

SegmentJoin

enum SegmentJoin : Enum<SegmentJoin>

SegmentPoint

@JvmRecord

data class SegmentPoint(val segment: Segment2D, val segmentT: Double, val position: Vector2) : BezierSegmentPoint<Vector2>

Representation of a point on a Segment2D.

SegmentProjection3D

class SegmentProjection3D(val segment: Segment3D, val projection: Double, val distance: Double, val point: Vector3)

SegmentType

enum SegmentType : Enum<SegmentType>

Indicates the type of Segment2D.

Shape

@Serializable

class Shape(val contours: List<ShapeContour>) : ShapeProvider

A simple interface for managing a List of ShapeContour.

ShapeBuilder

class ShapeBuilder

Shape builder class, used by shape

ShapeContour

@Serializable

data class ShapeContour(val segments: List<Segment2D>, val closed: Boolean, val polarity: YPolarity = YPolarity.CW_NEGATIVE_Y) : ShapeProvider, ShapeContourProvider, Path<Vector2>

Represents a geometric contour within a 2D shape. A ShapeContour consists of a collection of segments, which define its path. The shape can be open or closed, and additional properties provide detailed information about its geometry.

ShapeContourProvider

interface ShapeContourProvider

provider of ShapeContour

ShapeProvider

interface ShapeProvider

provider of Shape

ShapeTopology

enum ShapeTopology : Enum<ShapeTopology>

Indicates the Shape topology.

Triangle

@Serializable

data class Triangle(val x1: Vector2, val x2: Vector2, val x3: Vector2) : ShapeProvider, ShapeContourProvider

Creates a simple three-point polygon.

Winding

enum Winding : Enum<Winding>

Indicates the winding order of the ShapeContour.

Properties

bounds

@get:JvmName(name = "getVector2Bounds")

val List<Vector2>.bounds: Rectangle

Calculates Rectangle-bounds from a List of Vector2 instances.

@get:JvmName(name = "getVector3Bounds")

val List<Vector3>.bounds: Box

Calculate Box-bounds from a List of Vector3 instances.

@get:JvmName(name = "getBoxBounds")

val List<Box>.bounds: Box

Calculate Box-bounds from a List of Box instances.

@get:JvmName(name = "getRectangleBounds")

val List<Rectangle>.bounds: Rectangle

Calculates Rectangle-bounds for a list of Rectangle instances.

compound

@Transient

val List<Shape>.compound: Shape

Converts a List of Shape items into a single org.openrndr.shape.compound Shape.

shape

val List<ShapeContour>.shape: Shape

Converts a List of ShapeContours to a single Shape.

Functions

Box

fun Box(x: Double, y: Double, z: Double, width: Double, height: Double = width, depth: Double = width): Box

Creates a Box instance using the specified position and dimensions.

Circle

fun Circle(x: Double, y: Double, radius: Double): Circle

clamp

fun Vector2.clamp(bounds: Rectangle): Vector2

Clamps a Vector2 within the bounds of the bounds Rectangle.

compound

fun compound(f: CompoundBuilder.() -> List<Shape>): List<Shape>

contains

operator fun Shape.contains(v: Vector2): Boolean

Returns true if given Vector2 is inside the Shape.

operator fun ShapeContour.contains(point: Vector2): Boolean

Returns true if given point lies inside the ShapeContour.

contour

fun contour(f: ContourBuilder.() -> Unit): ShapeContour

Build a contour

contours

fun contours(f: ContourBuilder.() -> Unit): List<ShapeContour>

Build multiple org.openrndr.shape.contours

difference

@JvmName(name = "differenceIterative")

fun difference(from: List<Shape>, subtract: List<List<Shape>>): List<Shape>

Applies a boolean difference operation iteratively between a List of Shapes and a two-dimensional List of Shapes.

fun difference(from: List<Shape>, subtract: List<Shape>): List<Shape>

Applies a boolean difference operation between two Lists of Shapes.

fun difference(from: List<Shape>, subtract: Shape): List<Shape>

Applies a boolean difference operation between a List of Shapes and a Shape.

fun difference(from: List<Shape>, subtract: ShapeContour): List<Shape>

Applies a boolean difference operation between a List of Shapes and a ShapeContour.

fun difference(from: Shape, subtract: Shape): Shape

Applies a boolean difference operation between two Shapes.

fun difference(from: Shape, subtract: ShapeContour): Shape

Applies a boolean difference operation between a Shape and a ShapeContour.

fun difference(from: ShapeContour, subtract: Shape): Shape

Applies a boolean difference operation between a ShapeContour and a Shape.

fun difference(from: ShapeContour, subtract: ShapeContour): Shape

Applies a boolean difference operation between two ShapeContours.

difference

fun Shape.difference(other: Shape): Shape

Applies a boolean difference operation between two Shapes.

fun ShapeContour.difference(other: Shape): Shape

Applies a boolean difference operation between the ShapeContour and another Shape.

Ellipse

fun Ellipse(x: Double, y: Double, xRadius: Double, yRadius: Double): Ellipse

intersection

@JvmName(name = "intersectionIterative")

fun intersection(from: List<Shape>, with: List<List<Shape>>): List<Shape>

Applies a boolean intersection operation iteratively between a List of Shapes and a two-dimensional List of Shapes.

fun intersection(from: List<Shape>, with: List<Shape>): List<Shape>

Applies a boolean intersection operation between two Lists of Shapes.

fun intersection(from: List<Shape>, with: Shape): List<Shape>

Applies a boolean intersection operation between a List of Shapes and a Shape.

fun intersection(from: List<Shape>, with: ShapeContour): List<Shape>

Applies a boolean intersection operation between a List of Shapes and a ShapeContour.

fun intersection(from: Shape, with: Shape): Shape

Applies a boolean intersection operation between two Shapes.

fun intersection(from: Shape, with: ShapeContour): Shape

Applies a boolean intersection operation between a Shape and a ShapeContour.

fun intersection(from: ShapeContour, with: Shape): Shape

Applies a boolean intersection operation between a ShapeContour and Shape.

fun intersection(from: ShapeContour, with: ShapeContour): Shape

Applies a boolean intersection operation between two ShapeContours.

fun intersection(a: LineSegment, b: LineSegment, eps: Double = 0.0): Vector2

fun intersection(a0: Vector2, a1: Vector2, b0: Vector2, b1: Vector2, eps: Double = 0.0): Vector2

Finds the intersection point between two LineSegments.

intersection

fun Shape.intersection(other: Shape): Shape

Applies a boolean intersection operation between two Shapes.

fun ShapeContour.intersection(other: Shape): Shape

Applies a boolean intersection operation between the ShapeContour and a Shape.

intersections

fun intersections(a: Shape, b: Shape): List<ContourIntersection>

Calculates a List of all points of where paths intersect between the two Shapes.

fun intersections(a: Segment2D, b: Segment2D, vertexThreshold: Double = 1.0E-5): List<SegmentIntersection>

Calculates a List of all points where two Segment2Ds intersect.

fun intersections(a: ShapeContour, b: ShapeContour, vertexThreshold: Double = 1.0E-5): List<ContourIntersection>

Calculates a List of all points of where paths intersect between two ShapeContours.

intersections

fun Segment2D.intersections(other: Segment2D): List<SegmentIntersection>

Calculates a List of all points where two Segment2Ds intersect.

fun Segment2D.intersections(other: Shape): List<ContourIntersection>

Calculates a List of all points of where a Segment2D and a Shape intersect.

fun Segment2D.intersections(other: ShapeContour): List<ContourIntersection>

Calculates a List of all points of where a Segment2D and a ShapeContour intersect.

fun Shape.intersections(other: Segment2D): List<ContourIntersection>

Calculates a List of all points where the Shape and a Segment2D intersect.

fun Shape.intersections(other: Shape): List<ContourIntersection>

Calculates a List of all points where two Shapes intersect.

fun Shape.intersections(other: ShapeContour): List<ContourIntersection>

Calculates a List of all points where the Shape and a ShapeContour intersect.

fun ShapeContour.intersections(other: Segment2D): List<ContourIntersection>

Calculates a List of all intersections between the ShapeContour and a Segment2D.

fun ShapeContour.intersections(other: Shape): List<ContourIntersection>

Calculates a List of all intersections between the ShapeContour and a Shape.

fun ShapeContour.intersections(other: ShapeContour): List<ContourIntersection>

Calculates a List of all intersections between the ShapeContour and another ShapeContour.

IntRectangle

fun IntRectangle(x: Int, y: Int, width: Int, height: Int): IntRectangle

LineSegment

fun LineSegment(x0: Double, y0: Double, x1: Double, y1: Double): LineSegment

map

fun List<Vector2>.map(sourceRectangle: Rectangle, targetRectangle: Rectangle, clamp: Boolean = false): List<Vector2>

Maps all elements in a List<Vector2> from sourceRectangle to targetRectangle. If clamp is true all elements are clamped within the bounds of targetRectangle.

fun Vector2.map(sourceRectangle: Rectangle, targetRectangle: Rectangle, clamp: Boolean = false): Vector2

Remaps Vector2 from a position on the sourceRectangle to a proportionally equivalent position on the targetRectangle.

merge

fun List<Double>.merge(f: (Double, Double) -> Boolean): List<Double>

path3D

fun path3D(f: Path3DBuilder.() -> Unit): Path3D

proportionalize

@JvmName(name = "proportionalizeWithoutT")

fun <T : EuclideanVector<T>> proportionalize(input: List<T>): List<Pair<T, Double>>

fun <T : EuclideanVector<T>> proportionalize(input: List<Pair<T, Double>>): List<Pair<T, Double>>

Rectangle

fun Rectangle(x: Double, y: Double, width: Double, height: Double = width): Rectangle

removeLoops

fun ShapeContour.removeLoops(attempts: Int = 0): ShapeContour

resample

@JvmName(name = "resampleList")

fun <T : LinearType<T>> resample(input: List<Pair<T, Double>>, ts: List<Double>): List<Pair<T, Double>>

fun <T1 : LinearType<T1>, T2 : LinearType<T2>> resample(input1: List<Pair<T1, Double>>, input2: List<Pair<T2, Double>>): List<Triple<T1, T2, Double>>

fun <T1 : LinearType<T1>, T2 : LinearType<T2>, T3 : LinearType<T3>> resample(input1: List<Pair<T1, Double>>, input2: List<Pair<T2, Double>>, input3: List<Pair<T3, Double>>): List<Quadruple<T1, T2, T3, Double>>

sampleEquidistant

fun <T : LinearType<T>, EuclideanVector<T>> sampleEquidistant(segments: List<T>, count: Int): List<T>

Returns specified amount of points of equal distance from each other.

sampleEquidistantWithT

fun <T : LinearType<T>, EuclideanVector<T>> sampleEquidistantWithT(segments: List<Pair<T, Double>>, count: Int): List<Pair<T, Double>>

Returns specified amount of points of equal distance from each other.

Segment1D

fun Segment1D(start: Double, end: Double): Segment1D

fun Segment1D(start: Double, c0: Double, end: Double): Segment1D

fun Segment1D(start: Double, c0: Double, c1: Double, end: Double): Segment1D

Segment2D

fun Segment2D(start: Vector2, end: Vector2, corner: Boolean = true): Segment2D

Linear segment constructor.

fun Segment2D(start: Vector2, c0: Vector2, end: Vector2, corner: Boolean = true): Segment2D

Quadratic Bézier segment constructor.

fun Segment2D(start: Vector2, c0: Vector2, c1: Vector2, end: Vector2, corner: Boolean = true): Segment2D

Cubic Bézier segment constructor.

Segment3D

fun Segment3D(start: Vector3, end: Vector3): Segment3D

Creates a 3D segment defined by a start and an end point in 3D space.

fun Segment3D(start: Vector3, c0: Vector3, end: Vector3): Segment3D

Quadratic bezier segment constructor

fun Segment3D(start: Vector3, c0: Vector3, c1: Vector3, end: Vector3): Segment3D

Cubic bezier segment constructor

fun Segment3D(x0: Double, y0: Double, z0: Double, x1: Double, y1: Double, z1: Double): Segment3D

shape

fun shape(f: ShapeBuilder.() -> Unit): Shape

Build a shape

split

fun split(shape: Shape, cutter: LineSegment): Pair<Shape, Shape>

Splits a Shape into two separate Shapes from given LineSegment.

fun split(from: ShapeContour, cutters: List<ShapeContour>): List<ShapeContour>

Splits a ShapeContour with all other ShapeContour in a List.

fun split(from: ShapeContour, cutter: ShapeContour): List<ShapeContour>

Splits a ShapeContour with another ShapeContour.

split

fun ShapeContour.split(cutters: List<ShapeContour>): List<ShapeContour>

Splits a ShapeContour with a List of ShapeContours.

fun ShapeContour.split(cutter: ShapeContour): List<ShapeContour>

Splits a ShapeContour with another ShapeContour.

triangulate

@JvmName(name = "triangulateV2")

fun triangulate(shape: List<List<Vector2>>, fillRule: FillRule = FillRule.NONZERO_WINDING): List<Int>

@JvmName(name = "triangulateV3")

fun triangulate(shape: List<List<Vector3>>, fillRule: FillRule = FillRule.NONZERO_WINDING): List<Int>

Triangulate shape into a List of indexed triangles

fun triangulate(shape: Shape, distanceTolerance: Double = 0.5, fillRule: FillRule = FillRule.NONZERO_WINDING): List<Vector2>

Triangulates a Shape into a List of triangle corner positions.

union

@JvmName(name = "unionIterative")

fun union(from: List<Shape>, add: List<List<Shape>>): List<Shape>

Applies a boolean org.openrndr.shape.union operation iteratively between a List of Shapes and a two-dimensional List of Shapes.

fun union(from: List<Shape>, add: List<Shape>): List<Shape>

Applies a boolean org.openrndr.shape.union operation between two Lists of Shapes.

fun union(from: List<Shape>, add: Shape): List<Shape>

Applies a boolean org.openrndr.shape.union operation between a List of Shapes and a Shape.

fun union(from: List<Shape>, add: ShapeContour): List<Shape>

Applies a boolean org.openrndr.shape.union operation between a List of Shapes and a ShapeContour.

fun union(from: Shape, add: Shape): Shape

Applies a boolean org.openrndr.shape.union operation between two Shapes.

fun union(from: Shape, add: ShapeContour): Shape

Applies a boolean org.openrndr.shape.union operation between a Shape and a ShapeContour.

fun union(from: ShapeContour, add: ShapeContour): Shape

Applies a boolean org.openrndr.shape.union operation between two ShapeContours.

union

fun Shape.union(other: Shape): Shape

Applies a boolean org.openrndr.shape.union operation between two Shapes.

fun ShapeContour.union(other: Shape): Shape

Applies a boolean org.openrndr.shape.union operation between the ShapeContour and a Shape.