foocad-core/uk.co.nickthecoder.foocad.core/Path2d

Path2d

class Path2d(val points: List<Vector2>, val closed: Boolean)

A set of points most commonly used by Shape2d. When a Shape2d is rendered, the path is assumed to be closed, despite the closed boolean. Therefore, the closed property is only used for such things as extruding a profile along a path.

Paths may self intersect, but such paths should NOT be used to form a Polygon.

Within FooCAD, the direction of the points matters. By convention, holes are ordered clockwise, and non-holes anticlockwise. This is only important when paths are used to create a Polygon. OpenSCAD has no such restriction.

Constructors

Path2d

constructor(vararg points: Vector2)

constructor(points: List<Vector2>, closed: Boolean)

Types

Companion

object Companion

Properties

back

val back: Double

boundingArea

val boundingArea: Double

closed

val closed: Boolean

corner

val corner: Vector2

corners

val corners: List<Vector2>

extent

val extent: Pair<Vector2, Vector2>

front

val front: Double

indices

val indices: IntRange

val left: Double

val middle: Vector2

val pointCount: Int

val points: List<Vector2>

right

val right: Double

size

val size: Vector2

Functions

backTo

fun backTo(y: Double): Path2d

boundingSquare

fun boundingSquare(): Transformation2d

center

fun center(): Path2d

centerX

fun centerX(): Path2d

centerXTo

fun centerXTo(x: Double): Path2d

centerY

fun centerY(): Path2d

centerYTo

fun centerYTo(y: Double): Path2d

contains

fun contains(point: Vector2): Boolean

Determines if point is contained within this path. The path is assumed to be closed.

fun contains(x: Double, y: Double): Boolean

ensureIsHole

fun ensureIsHole(): Path2d

If this path's points are ordered clockwise, then return this path, otherwise return the reverse of this path.

ensureNotHole

fun ensureNotHole(): Path2d

If this path's points are ordered clockwise, then return a reverse of this path. Otherwise, return this path.

flipXY

fun flipXY(): Path2d

frontTo

fun frontTo(y: Double): Path2d

get

operator fun get(i: Int): Vector2

Allows array-like access to the points where the index is rolled around, so that index -1 is the same as size-1 and also index size is the same as index 0 etc.

isClockwise

fun isClockwise(): Boolean

Are the points listed in a clockwise direction. For most paths, they should be clockwise. The only exception is when the path is being used to define a hole.

isHole

fun isHole(): Boolean

As holes should be ordered clockwise, this is synonymous with isClockwise.

leftTo