orx-composition/org.openrndr.extra.composition/Composition

Composition

class Composition(val root: CompositionNode, var bounds: CompositionDimensions = defaultCompositionDimensions)(source)

A vector composition.

Parameters

root

the root node of the composition

bounds

the dimensions of the composition

Constructors

constructor(root: CompositionNode, bounds: CompositionDimensions = defaultCompositionDimensions)

constructor(root: CompositionNode, bounds: Rectangle)

Properties

var bounds: CompositionDimensions

var documentStyle: DocumentStyle

The style attributes affecting the whole document, such as the viewBox area and aspect ratio.

val namespaces: MutableMap<String, String>

SVG/XML namespaces

val root: CompositionNode

var style: Style

Functions

calculateViewportTransform

fun calculateViewportTransform(): Matrix44

Calculates effective viewport transformation using viewBox and preserveAspectRatio. As per the SVG 2.0 spec.

fun clear(): Unit?

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

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

fun findGroup(id: String): GroupNode?

fun findGroups(): List<GroupNode>

fun findImage(id: String): ImageNode?

fun findImages(): List<ImageNode>

fun findShape(id: String): ShapeNode?

fun findShapes(): List<ShapeNode>