class CompositionDrawer(documentBounds: CompositionDimensions = defaultCompositionDimensions, composition: Composition? = null, cursor: GroupNode? = composition?.root as? GroupNode)

A Drawer-like interface for the creation of Compositions This should be easier than creating Compositions manually

CompositionNode

sealed class CompositionNode

Describes a node in a composition

Display

sealed interface Display : AttributeOrPropertyValue

DocumentStyle

class DocumentStyle : Styleable

GroupNode

open class GroupNode(val children: MutableList<CompositionNode> = mutableListOf()) : CompositionNode

Represents a group node in a composition hierarchy. A GroupNode itself does not have explicit contents but serves as a container for managing child nodes. It allows grouping of multiple CompositionNode instances and provides functionalities like calculating the bounds for all its child elements and copying itself with overrides.

GroupNodeStop

class GroupNodeStop(children: MutableList<CompositionNode>) : GroupNode

Represents a specialized type of GroupNode in a composition hierarchy, serving as a container for child nodes.

ImageNode

class ImageNode(var image: ColorBuffer, var x: Double, var y: Double, var width: Double, var height: Double) : CompositionNode

a CompositionNode that holds a single image ColorBuffer

Inheritance

enum Inheritance : Enum<Inheritance>

Length

sealed interface Length : AttributeOrPropertyValue

LineCap

sealed interface LineCap : AttributeOrPropertyValue

LineJoin

sealed interface LineJoin : AttributeOrPropertyValue

MeetOrSlice

enum MeetOrSlice : Enum<MeetOrSlice>

Numeric

sealed interface Numeric : AttributeOrPropertyValue

Paint

sealed interface Paint : AttributeOrPropertyValue

Shade

sealed interface Shade : AttributeOrPropertyValue

ShapeNode

class ShapeNode(var shape: Shape) : CompositionNode

a CompositionNode that holds a single Shape

ShapeNodeIntersection

@JvmRecord

data class ShapeNodeIntersection(val node: ShapeNode, val intersection: ContourIntersection)

Data structure containing intersection information.

ShapeNodeNearestContour

@JvmRecord

data class ShapeNodeNearestContour(val node: ShapeNode, val point: ContourPoint, val distanceDirection: Vector2, val distance: Double)

Data structure containing information about a point in a ShapeContour closest to some other 2D point.

Style

class Style : Styleable

Styleable

sealed class Styleable

TextNode

data class TextNode(var text: String, var contour: ShapeContour?) : CompositionNode

a CompositionNode that holds a single text

Transform

sealed interface Transform : AttributeOrPropertyValue

TransformMode

enum TransformMode : Enum<TransformMode>

Specifies if transformations should be kept separate or applied to the clipped object and reset to identity.

UserData

class UserData<T : Any>(val name: String, val initial: T)

org.openrndr.shape.UserData delegate

ViewBox

sealed interface ViewBox : AttributeOrPropertyValue

Visibility

sealed interface Visibility : AttributeOrPropertyValue

Properties

defaultCompositionDimensions

val defaultCompositionDimensions: CompositionDimensions

display

var Style.display: Display

fill

var Style.fill: Paint

fillOpacity

var Style.fillOpacity: Numeric

height

var Style.height: Length

lineCap

var Style.lineCap: LineCap

lineJoin

var Style.lineJoin: LineJoin

miterLimit

var Style.miterLimit: Numeric

opacity

var Style.opacity: Numeric

percent

val Double.percent: Length.Percent

pixels

val Double.pixels: Length.Pixels

preserveAspectRatio

var DocumentStyle.preserveAspectRatio: AspectRatio

shadeStyle

var Style.shadeStyle: Shade

stroke

var Style.stroke: Paint

strokeOpacity

var Style.strokeOpacity: Numeric

strokeWeight

var Style.strokeWeight: Length

transform

var Style.transform: Transform

viewBox

var DocumentStyle.viewBox: ViewBox

visibility

var Style.visibility: Visibility

width

var Style.width: Length

var Style.x: Length

var Style.y: Length

Functions

composition

fun Drawer.composition(composition: Composition)

Renders a vector Composition onto the Drawer. This method applies transformations, styles, and renders the hierarchy of nodes from the given Composition object.

draw

fun Composition.draw(cursor: GroupNode? = this.root as? GroupNode, drawFunction: CompositionDrawer.() -> Unit)

Draws content into an existing composition using the provided drawing function.

drawComposition

fun drawComposition(documentBounds: CompositionDimensions = defaultCompositionDimensions, composition: Composition? = null, cursor: GroupNode? = composition?.root as? GroupNode, drawFunction: CompositionDrawer.() -> Unit): Composition

Draws a vector composition by applying a provided drawing function.

drawComposition

fun Program.drawComposition(documentBounds: CompositionDimensions = CompositionDimensions(0.0.pixels, 0.0.pixels, this.drawer.width.toDouble().pixels, this.drawer.height.toDouble().pixels), composition: Composition? = null, cursor: GroupNode? = composition?.root as? GroupNode, drawFunction: CompositionDrawer.() -> Unit): Composition

Draws a composition within the specified document bounds or an existing composition. This function utilizes a customizable draw function to define the drawing behavior.

fun Program.drawComposition(documentBounds: Rectangle, composition: Composition? = null, cursor: GroupNode? = composition?.root as? GroupNode, drawFunction: CompositionDrawer.() -> Unit): Composition

Draws a composition using the specified document bounds and drawing logic. Optionally, an existing composition and cursor can be passed to update or build upon them.

filter

fun CompositionNode.filter(filter: (CompositionNode) -> Boolean): CompositionNode?

Filters a CompositionNode and its hierarchy based on the provided filter function. The method recursively applies the filter to the node and its children, creating a new hierarchy that contains only the nodes for which the filter returns true. If the filter condition fails for the root node, null is returned.

find

fun CompositionNode.find(predicate: (CompositionNode) -> Boolean): CompositionNode?

Finds first CompositionNode to match the given predicate.

findAll

fun CompositionNode.findAll(filter: (CompositionNode) -> Boolean): List<CompositionNode>

Finds all CompositionNode instances in the current node hierarchy that satisfy the given filter. Traverses the hierarchy recursively, evaluating each node and its children.

findGroups

fun CompositionNode.findGroups(): List<GroupNode>

find all descendant GroupNode nodes, including potentially this node

findImages

fun CompositionNode.findImages(): List<ImageNode>

find all descendant ImageNode nodes, including potentially this node

findShapes

fun CompositionNode.findShapes(): List<ShapeNode>

find all descendant ShapeNode nodes, including potentially this node

findTerminals

fun CompositionNode.findTerminals(filter: (CompositionNode) -> Boolean): List<CompositionNode>

Recursively finds all terminal nodes within the composition tree starting from the current node and applies the provided filter to determine which nodes to include in the result.

map

fun CompositionNode.map(mapper: (CompositionNode) -> CompositionNode): CompositionNode

merge

fun List<ShapeNodeIntersection>.merge(threshold: Double = 0.5): List<ShapeNodeIntersection>

Merges two lists of ShapeNodeIntersection removing duplicates under the given threshold. Used internally by intersections.

remove

fun CompositionNode.remove()

remove node from its parent CompositionNode

setValue

operator fun KMutableProperty0<Shade>.setValue(thisRef: Style, property: KProperty<*>, value: ShadeStyle)

transform

fun transform(node: CompositionNode): Matrix44

visitAll

fun CompositionNode.visitAll(visitor: CompositionNode.() -> Unit)

visit this CompositionNode and all descendant nodes and execute visitor