openrndr-shape/org.openrndr.shape/ShapeContour

ShapeContour

@Serializable

data class ShapeContour(val segments: List<Segment2D>, val closed: Boolean, val polarity: YPolarity = YPolarity.CW_NEGATIVE_Y) : ShapeProvider, ShapeContourProvider, Path<Vector2> (source)

Represents a geometric contour within a 2D shape. A ShapeContour consists of a collection of segments, which define its path. The shape can be open or closed, and additional properties provide detailed information about its geometry.

Constructors

ShapeContour

constructor(segments: List<Segment2D>, closed: Boolean, polarity: YPolarity = YPolarity.CW_NEGATIVE_Y)

Types

Companion

object Companion

Properties

bounds

val bounds: Rectangle

Calculates the bounding box of the contour as Rectangle.

clockwise

val clockwise: ShapeContour

Returns the ShapeContour, but with a clockwise winding.

closed

open override val closed: Boolean

contour

open override val contour: ShapeContour

the provided contour

counterClockwise

val counterClockwise: ShapeContour

Returns the ShapeContour, but with a counterclockwise winding.

empty

open override val empty: Boolean

Returns true if ShapeContour doesn't contain any Segment2Ds.

exploded

val exploded: List<ShapeContour>

Converts to a List of single Segment2Ds.

infinity

open override val infinity: Vector2

length

open override val length: Double

Calculates approximate Euclidean length of the contour.

open

val open: ShapeContour

Opens the path of the ShapeContour.

polarity

val polarity: YPolarity

reversed

val reversed: ShapeContour

Reverses the direction of Segment2Ds and their order.

segments

open override val segments: List<Segment2D>

shape

open override val shape: Shape

Returns Shape representation.

winding

val winding: Winding

Determines the winding order of the ShapeContour.

Functions

adaptivePositions

open fun adaptivePositions(distanceTolerance: Double = 0.5): List<Vector2>

Recursively subdivides linear Segment2Ds to approximate Bézier curves.

adaptivePositionsAndCorners

fun adaptivePositionsAndCorners(distanceTolerance: Double = 0.5): Pair<List<Vector2>, List<Boolean>>

Recursively subdivides linear Segment2Ds to approximate Bézier curves.

adaptivePositionsWithT

open fun adaptivePositionsWithT(distanceTolerance: Double = 0.5): List<Pair<Vector2, Double>>

fun close(): ShapeContour

Closes the path of the ShapeContour.

contains

operator fun ShapeContour.contains(point: Vector2): Boolean

Returns true if given point lies inside the ShapeContour.

curvature

open fun curvature(ut: Double): Double

difference

fun ShapeContour.difference(other: Shape): Shape

Applies a boolean difference operation between the ShapeContour and another Shape.

direction

open fun direction(ut: Double): Vector2

equidistantPositions

open fun equidistantPositions(pointCount: Int, distanceTolerance: Double = 0.5): List<Vector2>

Returns specified amount of points of equal distance from each other.

equidistantPositionsWithT

open fun equidistantPositionsWithT(pointCount: Int, distanceTolerance: Double = 0.5): List<Pair<Vector2, Double>>

intersection

fun ShapeContour.intersection(other: Shape): Shape

Applies a boolean intersection operation between the ShapeContour and a Shape.

intersections

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

Calculates a List of all intersections between the ShapeContour and a Segment2D.

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

Calculates a List of all intersections between the ShapeContour and a Shape.

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

Calculates a List of all intersections between the ShapeContour and another ShapeContour.

nearest

fun nearest(point: Vector2): ContourPoint

Projects a point on the ShapeContour

normal

fun normal(ut: Double): Vector2

Calculates the normal for the given ut.

fun on(point: Vector2, error: Double = 5.0): Double?

Checks if given point lies on the path of the ShapeContour.

plus

operator fun plus(other: ShapeContour): ShapeContour

pointAtLength

open fun pointAtLength(length: Double, distanceTolerance: Double = 0.5): Vector2

Calculates the point at a given distance along this ShapeContour.

pose

fun pose(t: Double): Matrix44

Calculates the pose Matrix44 (i.e. translation and rotation) that describes an orthonormal basis formed by normal and tangent of the contour at t.

position

open fun position(ut: Double): Vector2

Returns a point on the path of the ShapeContour.

removeLoops

fun ShapeContour.removeLoops(attempts: Int = 0): ShapeContour

resetCache

fun resetCache()

sampleEquidistant

fun sampleEquidistant(pointCount: Int): ShapeContour

Samples the ShapeContour into equidistant linear Segment2Ds.

sampleLinear

fun sampleLinear(distanceTolerance: Double = 0.5): ShapeContour

Adaptively samples the contour into a new ShapeContour of linear Segment2Ds while still approximating the original contour.

segment

open fun segment(ut: Double): Pair<Int, Double>

Returns segment number and segment offset in a ShapeContour for the given ut.

split

fun ShapeContour.split(cutters: List<ShapeContour>): List<ShapeContour>

Splits a ShapeContour with a List of ShapeContours.

fun ShapeContour.split(cutter: ShapeContour): List<ShapeContour>

Splits a ShapeContour with another ShapeContour.

sub

open override fun sub(t0: Double, t1: Double): ShapeContour

Samples a new ShapeContour from the current ShapeContour starting at t0 and ending at t1.

tForLength

open fun tForLength(length: Double): Double

Estimates the t value for a given length.

transform

fun transform(transform: Matrix44): ShapeContour

Applies linear transformation to ShapeContour.

union

fun ShapeContour.union(other: Shape): Shape

Applies a boolean org.openrndr.shape.union operation between the ShapeContour and a Shape.