openrndr-shape/org.openrndr.shape/ShapeContour

ShapeContour

data class ShapeContour @JvmOverloads constructor( val segments: List<Segment>, val closed: Boolean, val polarity: YPolarity = YPolarity.CW_NEGATIVE_Y) : ShapeContourProvider

A List for managing a collection of Segments.

Constructors

ShapeContour

@JvmOverloads

fun ShapeContour( segments: List<Segment>, closed: Boolean, polarity: YPolarity = YPolarity.CW_NEGATIVE_Y)

Types

Companion

object Companion

Functions

adaptivePositions

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

Recursively subdivides linear Segments to approximate Bézier curves.

adaptivePositionsAndCorners

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

Recursively subdivides linear Segments to approximate Bézier curves.

adaptivePositionsWithT

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

fun close(): ShapeContour

Closes the path of the ShapeContour.

equidistantPositions

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

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

equidistantPositionsWithT

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

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

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

fun position(ut: Double): Vector2

Returns a point on the path of the ShapeContour.

resetCache

fun resetCache()

sampleEquidistant

fun sampleEquidistant(pointCount: Int): ShapeContour

Samples the ShapeContour into equidistant linear Segments.

sampleLinear

fun sampleLinear(distanceTolerance: Double = 0.5): ShapeContour

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

segment

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

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

sub

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

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

tForLength

fun tForLength(length: Double): Double

Estimates the t value for a given length.

transform

fun transform(transform: Matrix44): ShapeContour

Applies linear transformation to ShapeContour.

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

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

val empty: Boolean

Returns true if ShapeContour doesn't contain any Segments.

exploded

val exploded: List<ShapeContour>

Converts to a List of single Segments.

length

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 Segments and their order.

segments

val segments: List<Segment>

shape

val shape: Shape

Returns Shape representation.

winding

val winding: Winding

Determines the winding order of the ShapeContour.

Extensions

contains

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

Returns true if given point lies inside the ShapeContour.

difference

fun ShapeContour.difference(other: Shape): Shape

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

intersection

fun ShapeContour.intersection(other: Shape): Shape

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

intersections

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

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

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

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

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

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

offset

fun ShapeContour.offset(distance: Double, joinType: SegmentJoin = SegmentJoin.ROUND): ShapeContour

Offsets a ShapeContour's Segments by given distance.

removeLoops

fun ShapeContour.removeLoops(attempts: Int = 0, reverseOrder: Boolean = false): ShapeContour

split

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

Splits a ShapeContour with another ShapeContour.

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

Splits a ShapeContour with a List of ShapeContours.

union

fun ShapeContour.union(other: Shape): Shape

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

Sources

common source