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

GroupNode

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

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.

Inheritors

GroupNodeStop

Constructors

GroupNode

constructor(children: MutableList<CompositionNode> = mutableListOf())

Properties

attributes

var attributes: MutableMap<String, String?>

Custom attributes to be applied to the Node in addition to the Style attributes.

bounds

open override val bounds: Rectangle

a Rectangle that describes the bounding box of the contents

children

open val children: MutableList<CompositionNode>

A mutable list of child nodes belonging to this group. Defaults to an empty list.

effectiveDisplay

val effectiveDisplay: Boolean

effectiveFill

val effectiveFill: ColorRGBa?

effectiveFillOpacity

val effectiveFillOpacity: Double

effectiveLineCap

val effectiveLineCap: LineCap

effectiveLineJoin

val effectiveLineJoin: LineJoin

effectiveMiterLimit

val effectiveMiterLimit: Double

effectiveOpacity

val effectiveOpacity: Double

effectiveShadeStyle

val effectiveShadeStyle: ShadeStyle

effectiveStroke

val effectiveStroke: ColorRGBa?

effectiveStrokeOpacity

val effectiveStrokeOpacity: Double

effectiveStrokeWeight

val effectiveStrokeWeight: Double

effectiveStyle

val effectiveStyle: Style

This CompositionNode's computed style. Where every style attribute is obtained by overwriting the Style in the following order:

effectiveTransform

val effectiveTransform: Matrix44

Calculates the absolute transformation of the current node.

effectiveVisibility

val effectiveVisibility: Boolean

fill

var fill: ColorRGBa?

fillOpacity

var fillOpacity: Double

var id: String?

lineCap

var lineCap: LineCap

lineJoin

var lineJoin: LineJoin

miterLimit

var miterLimit: Double

opacity

var opacity: Double

parent

var parent: CompositionNode?

shadeStyle

var shadeStyle: ShadeStyle

stroke

var stroke: ColorRGBa?

strokeOpacity

var strokeOpacity: Double

strokeWeight

var strokeWeight: Double

style

var style: Style

This CompositionNode's own style.

transform

var transform: Matrix44

userData

val userData: MutableMap<String, Any>

a map that stores user data

Functions

copy

fun copy(id: String? = this.id, parent: CompositionNode? = null, style: Style = this.style, children: MutableList<CompositionNode> = this.children): GroupNode

equals

open operator override fun equals(other: Any?): Boolean

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.

hashCode

open override fun hashCode(): Int

map

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

remove

fun CompositionNode.remove()

remove node from its parent CompositionNode

visitAll

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

visit this CompositionNode and all descendant nodes and execute visitor