openrndr-shape/org.openrndr.shape/Path3D

Path3D

@Serializable

class Path3D(val segments: List<Segment3D>, val closed: Boolean) : Path<Vector3> (source)

Represents a 3D path composed of multiple segments. The class supports operations on the path, such as transformations, sampling, sub-path extraction, and various geometric calculations. It also provides methods for creating paths from points or segments and combines functionality for both open and closed paths.

Constructors

Path3D

constructor(segments: List<Segment3D>, closed: Boolean)

Types

Companion

object Companion

Properties

bounds

val bounds: Box

A computed property that calculates and returns the bounding box of the Path3D. The bounding box is determined by mapping and aggregating the individual bounding boxes of all segments in the path.

closed

open override val closed: Boolean

Indicates whether the path is closed (i.e., the last point connects to the first point).

empty

open override val empty: Boolean

exploded

val exploded: List<Path3D>

A computed property that provides a list of individual Path3D instances, each wrapping a single segment from the segments property of the current Path3D. Each of these paths is not closed.

infinity

open override val infinity: Vector3

length

@Transient

open val length: Double

reversed

val reversed: Path3D

Retrieves a new Path3D instance where the order of the segments is reversed and each segment is individually reversed. The closed property of the path is preserved.

segments

open override val segments: List<Segment3D>

A list of the segments forming the path.

Functions

adaptivePositions

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

Recursively subdivides linear Segment2Ds to approximate Bézier curves.

adaptivePositionsWithT

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

curvature

open fun curvature(ut: Double): Double

direction

open fun direction(ut: Double): Vector3

equals

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

equidistantPositions

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

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

equidistantPositionsWithT

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

hashCode

open override fun hashCode(): Int

map

fun map(closed: Boolean = this.closed, mapper: (Segment3D) -> Segment3D): Path3D

Transforms the segments of the current Path3D by applying a given mapping function, and optionally adjusts the connections between the segments to maintain continuity.