openrndr-shape/org.openrndr.shape/Shape

Shape

@Serializable

class Shape(val contours: List<ShapeContour>) : ShapeProvider, GeometricPrimitive2D(source)

A simple interface for managing a List of ShapeContour.

Constructors

constructor(contours: List<ShapeContour>)

Types

object Companion

Properties

val area: Double

Calculates approximate area for this shape (through triangulation).

val bounds: Rectangle

@Transient

val closedContours: List<ShapeContour>

Lists all ShapeContours with a closed topology.

val compound: Boolean

Checks whether the Shape is org.openrndr.shape.compound or not.

val contours: List<ShapeContour>

val empty: Boolean

Returns true if Shape contains no ShapeContours.

val linear: Boolean

Returns true if Shape consists solely of ShapeContours, where each Segment2D is a line segment.

@Transient

val openContours: List<ShapeContour>

Lists all ShapeContours with an open topology.

val outline: ShapeContour

The outline of the shape.

open override val shape: Shape

the provided shape

@Transient

val topology: ShapeTopology

Indicates the Shape topology.

val triangulation: List<Triangle>

Triangulates Shape into a List of Triangles.

Functions

operator fun Shape.contains(v: Vector2): Boolean

Returns true if given Vector2 is inside the Shape.

fun Shape.difference(other: Shape): Shape

Applies a boolean difference operation between two Shapes.

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

open override fun hashCode(): Int

fun hole(index: Int): ShapeContour

The indexed hole of the shape.

fun Shape.intersection(other: Shape): Shape

Applies a boolean intersection operation between two Shapes.

fun Shape.intersections(other: Segment2D): List<ContourIntersection>

Calculates a List of all points where the Shape and a Segment2D intersect.

fun Shape.intersections(other: Shape): List<ContourIntersection>

Calculates a List of all points where two Shapes intersect.

fun Shape.intersections(other: ShapeContour): List<ContourIntersection>

Calculates a List of all points where the Shape and a ShapeContour intersect.

isSelfIntersecting

fun Shape.isSelfIntersecting(): Boolean

true if this Shape crosses or touches itself anywhere: either one of its ShapeContours is self-intersecting on its own (ShapeContour.isSelfIntersecting), or two distinct contours cross or touch each other.

fun map(mapper: (ShapeContour) -> ShapeContour): Shape

Applies a map to the shape. Maps every contour.

fun nearest(point: Vector2): ContourPoint

Projects a point on the contours of a Shape

persistBitExact

fun Shape.persistBitExact(file: File)

Writes this shape to file such that Shape.Companion.loadBitExact reproduces it exactly, down to the bit pattern of every coordinate.

fun polygon(distanceTolerance: Double = 0.5): Shape

removeSelfIntersections

fun Shape.removeSelfIntersections(fillRule: FillRule = FillRule.NON_ZERO): Shape

fun resetCache()

fun splitCompounds(winding: Winding = Winding.CLOCKWISE): List<Shape>

Splits an org.openrndr.shape.compound shape into separate shapes.

open override fun toString(): String

fun transform(transform: Matrix44): Shape

Applies a linear transformation to the Shape.

fun Shape.union(other: Shape): Shape

Applies a boolean org.openrndr.shape.union operation between two Shapes.