Composition

class Composition(root: CompositionNode, bounds: CompositionDimensions)

A vector composition.

Parameters

root

the root node of the composition

bounds

the dimensions of the composition

Constructors

Composition

common

fun Composition(root: CompositionNode, bounds: Rectangle)

Composition

common

fun Composition(root: CompositionNode, bounds: CompositionDimensions = defaultCompositionDimensions)

Functions

calculateViewportTransform

common

fun calculateViewportTransform(): Matrix44

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

clear

common

fun clear(): Unit?

findGroup

common

fun findGroup(id: String): GroupNode?

findGroups

common

fun findGroups(): List<GroupNode>

findImage

common

fun findImage(id: String): ImageNode?

findImages

common

fun findImages(): List<ImageNode>

findShape

common

fun findShape(id: String): ShapeNode?

findShapes

common

fun findShapes(): List<ShapeNode>

Properties

bounds

common

var bounds: CompositionDimensions

documentStyle

common

var documentStyle: DocumentStyle

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

namespaces

common

val namespaces: MutableMap<String, String>

SVG/XML namespaces

root

common

val root: CompositionNode

style

common

var style: Style

Extensions

draw

jvm

fun Composition.draw(drawFunction: CompositionDrawer.() -> Unit)

Draw into an existing Composition.