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

CompositionDrawer

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

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

Constructors

CompositionDrawer

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

Properties

clipMode

var clipMode: ClipMode

composition

val composition: Composition

cursor

var cursor: GroupNode

fill

var fill: ColorRGBa?

fillOpacity

var fillOpacity: Double

lineCap

var lineCap: LineCap

lineJoin

var lineJoin: LineJoin

mask

var mask: Shape?

miterlimit

var miterlimit: Double

var model: Matrix44

var opacity: Double

val root: GroupNode

var stroke: ColorRGBa?

strokeOpacity

var strokeOpacity: Double

strokeWeight

var strokeWeight: Double

transformMode

var transformMode: TransformMode

visibility

var visibility: Visibility

Functions

circle

fun circle(circle: Circle, closed: Boolean = true, insert: Boolean = true): ShapeNode?

fun circle(position: Vector2, radius: Double, closed: Boolean = true, insert: Boolean = true): ShapeNode?

fun circle(x: Double, y: Double, radius: Double, closed: Boolean = true, insert: Boolean = true): ShapeNode?

circles

fun circles(circles: List<Circle>, insert: Boolean = true): List<ShapeNode?>

fun circles(positions: List<Vector2>, radius: Double, insert: Boolean = true): List<ShapeNode?>

fun circles(positions: List<Vector2>, radii: List<Double>, insert: Boolean = true): List<ShapeNode?>

composition

fun composition(composition: Composition): CompositionNode

contour

fun contour(contour: ShapeContour, insert: Boolean = true): ShapeNode?

contours

fun contours(contours: List<ShapeContour>, insert: Boolean = true): List<ShapeNode?>

difference

fun difference(shape: Shape, searchFrom: CompositionNode = composition.root as GroupNode): Shape

distances

fun CompositionNode.distances(point: Vector2): List<ShapeNodeNearestContour>

fun distances(point: Vector2, searchFrom: CompositionNode = composition.root as GroupNode): List<ShapeNodeNearestContour>

Find distances to each contour in the composition tree (or starting node)

duplicate

fun CompositionNode.duplicate(insert: Boolean = true): CompositionNode

Returns a deep copy of a CompositionNode. If insert is true the copy is inserted at cursor.

group

fun group(insert: Boolean = true, id: String? = null, builder: CompositionDrawer.() -> Unit): GroupNode

Create a group node and run builder inside its context

image

fun image(image: ColorBuffer, x: Double = 0.0, y: Double = 0.0, insert: Boolean = true): ImageNode

Adds an image to the composition tree

intersections

fun CompositionNode.intersections(shape: Shape, mergeThreshold: Double = 0.5): List<ShapeNodeIntersection>

fun CompositionNode.intersections(contour: ShapeContour, mergeThreshold: Double = 0.5): List<ShapeNodeIntersection>

fun intersections(shape: Shape, searchFrom: CompositionNode = composition.root as GroupNode, mergeThreshold: Double = 0.5): List<ShapeNodeIntersection>

Test a given shape against org.openrndr.shape.contours in the composition tree

fun intersections(contour: ShapeContour, searchFrom: CompositionNode = composition.root as GroupNode, mergeThreshold: Double = 0.5): List<ShapeNodeIntersection>

Test a given contour against org.openrndr.shape.contours in the composition tree

isolated

fun isolated(draw: CompositionDrawer.() -> Unit)

lineLoop

fun lineLoop(points: List<Vector2>, insert: Boolean = true): ShapeNode?

lineSegment

fun lineSegment(lineSegment: LineSegment, insert: Boolean = true): ShapeNode?

fun lineSegment(start: Vector2, end: Vector2, insert: Boolean = true): ShapeNode?

fun lineSegment(startX: Double, startY: Double, endX: Double, endY: Double, insert: Boolean = true): ShapeNode?

lineSegments

fun lineSegments(lineSegments: List<LineSegment>, insert: Boolean = true): List<ShapeNode?>

lineStrip

fun lineStrip(points: List<Vector2>, insert: Boolean = true): ShapeNode?

nearest

fun CompositionNode.nearest(point: Vector2): ShapeNodeNearestContour?

fun nearest(point: Vector2, searchFrom: CompositionNode = composition.root as GroupNode): ShapeNodeNearestContour?

Search for a point on a contour in the composition tree that's nearest to point

fun popModel()

fun popStyle()

fun pushModel()

fun pushStyle()

fun rectangle(rectangle: Rectangle, closed: Boolean = true, insert: Boolean = true): ShapeNode?

fun rectangle(x: Double, y: Double, width: Double, height: Double, closed: Boolean = true, insert: Boolean = true): ShapeNode?

rectangles

fun rectangles(rectangles: List<Rectangle>, insert: Boolean = true): List<ShapeNode?>

fun rectangles(positions: List<Vector2>, dimensions: List<Vector2>, insert: Boolean): List<ShapeNode?>

fun rectangles(positions: List<Vector2>, width: Double, height: Double, insert: Boolean = true): List<ShapeNode?>

rotate

fun rotate(rotationInDegrees: Double)

fun CompositionNode.rotate(angleInDegrees: Double, pivot: Vector2 = Vector2.ZERO)

scale

fun scale(s: Double)

fun scale(x: Double, y: Double)

fun CompositionNode.scale(scale: Double, pivot: Vector2 = Vector2.ZERO)

segment

fun segment(segment: Segment2D, insert: Boolean = true): ShapeNode?

fun segment(start: Vector2, end: Vector2, insert: Boolean = true): ShapeNode?

fun segment(start: Vector2, c0: Vector2, end: Vector2, insert: Boolean = true): ShapeNode?

fun segment(start: Vector2, c0: Vector2, c1: Vector2, end: Vector2, insert: Boolean = true): ShapeNode?

segments

fun segments(segments: List<Segment2D>, insert: Boolean = true): List<ShapeNode?>

shape

fun shape(shape: Shape, insert: Boolean = true): ShapeNode?

shapes

fun shapes(shapes: List<Shape>, insert: Boolean = true): List<ShapeNode?>

text

fun text(text: String, position: Vector2, insert: Boolean = true): TextNode

textOnContour

fun textOnContour(text: String, contour: ShapeContour, insert: Boolean = true): TextNode

texts

fun texts(text: List<String>, positions: List<Vector2>): List<TextNode>

transform

fun CompositionNode.transform(builder: TransformBuilder.() -> Unit)

translate

fun translate(t: Vector2)

fun translate(x: Double, y: Double)

fun CompositionNode.translate(x: Double, y: Double, z: Double = 0.0)

with

fun GroupNode.with(builder: CompositionDrawer.() -> Unit): GroupNode