Shape

@Serializable

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

A simple interface for managing a List of ShapeContour.

Constructors

Shape

constructor(contours: List<ShapeContour>)

Types

Companion

object Companion

Functions

contains

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

Returns true if given Vector2 is inside the Shape.

difference

fun Shape.difference(other: Shape): Shape

Applies a boolean difference operation between two Shapes.

equals

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

hashCode

open override fun hashCode(): Int

hole

fun hole(index: Int): ShapeContour

The indexed hole of the shape.

intersection

fun Shape.intersection(other: Shape): Shape

Applies a boolean intersection operation between two Shapes.

intersections

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.

map

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

Applies a map to the shape. Maps every contour.

nearest

fun nearest(point: Vector2): ContourPoint

Projects a point on the contours of a Shape

polygon

fun polygon(distanceTolerance: Double = 0.5): Shape

randomPoints

fun randomPoints(pointCount: Int, random: Random = Random.Default): List<Vector2>

Generates specified amount of random points that lie inside the Shape.

resetCache

fun resetCache()

splitCompounds

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

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

toString

open override fun toString(): String

transform

fun transform(transform: Matrix44): Shape

Applies a linear transformation to the Shape.

union

fun Shape.union(other: Shape): Shape

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

Properties

area

val area: Double

Calculates approximate area for this shape (through triangulation).

bounds

val bounds: Rectangle

closedContours

@Transient

val closedContours: List<ShapeContour>

Lists all ShapeContours with a closed topology.

compound

val compound: Boolean

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

contours

val contours: List<ShapeContour>

empty

val empty: Boolean

Returns true if Shape contains no ShapeContours.

linear

val linear: Boolean

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

openContours

@Transient

val openContours: List<ShapeContour>

Lists all ShapeContours with an open topology.

outline

val outline: ShapeContour

The outline of the shape.

shape

open override val shape: Shape

the provided shape

topology

@Transient

val topology: ShapeTopology

Indicates the Shape topology.

triangulation

val triangulation: List<Triangle>

Triangulates Shape into a List of Triangles.