Package-level declarations

Types

Link copied to clipboard
enum Align : Enum<Align>
Link copied to clipboard
data class AspectRatio(val align: Align, val meetOrSlice: MeetOrSlice) : AttributeOrPropertyValue
Link copied to clipboard
Link copied to clipboard

Specifies in which way to combine Shapes to form a Composition

Link copied to clipboard
enum ClipOp : Enum<ClipOp>

Used internally to define ClipModes.

Link copied to clipboard
class Composition(val root: CompositionNode, var bounds: CompositionDimensions = defaultCompositionDimensions)

A vector composition.

Link copied to clipboard
data class CompositionDimensions(val x: Length, val y: Length, val width: Length, val height: Length)
Link copied to clipboard
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

Link copied to clipboard
sealed class CompositionNode

Describes a node in a composition

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
open class GroupNode(val children: MutableList<CompositionNode> = mutableListOf()) : CompositionNode

A CompositionNode that functions as a group node

Link copied to clipboard
Link copied to clipboard
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

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
class ShapeNode(var shape: Shape) : CompositionNode

a CompositionNode that holds a single Shape

Link copied to clipboard
data class ShapeNodeIntersection(val node: ShapeNode, val intersection: ContourIntersection)

Data structure containing intersection information.

Link copied to clipboard
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.

Link copied to clipboard
Link copied to clipboard
sealed class Styleable
Link copied to clipboard
data class TextNode(var text: String, var contour: ShapeContour?) : CompositionNode

a CompositionNode that holds a single text

Link copied to clipboard
Link copied to clipboard

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

Link copied to clipboard
class UserData<T : Any>(val name: String, val initial: T)

org.openrndr.shape.UserData delegate

Link copied to clipboard
Link copied to clipboard

Functions

Link copied to clipboard
fun Composition.draw(drawFunction: CompositionDrawer.() -> Unit)

Draw into an existing Composition.

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

Creates a Composition. The draw operations contained inside the drawFunction do not render graphics to the screen, but populate the Composition instead.

Link copied to clipboard
Link copied to clipboard

Finds first CompositionNode to match the given predicate.

Link copied to clipboard
Link copied to clipboard

find all descendant GroupNode nodes, including potentially this node

Link copied to clipboard

find all descendant ImageNode nodes, including potentially this node

Link copied to clipboard

find all descendant ShapeNode nodes, including potentially this node

Link copied to clipboard
Link copied to clipboard

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

Link copied to clipboard

remove node from its parent CompositionNode

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

visit this CompositionNode and all descendant nodes and execute visitor

Properties

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard