Kotlin Computational Geometry/io.github.cponfick.kompgeom.euclidean.threed/Polygon3

Polygon3

class Polygon3(vertices: List<Vec3>, val precision: DoubleEquivalence = DEFAULT_DOUBLE_EQUIVALENCE) : Polygon<Vec3> (source)

Represents a planar polygon in three-dimensional space.

The vertices are copied on construction and must include at least one non-collinear triple. The polygon may begin with collinear vertices; the plane is inferred from any valid triple and all vertices must lie in that plane.

Constructors

Polygon3

constructor(vertices: List<Vec3>, precision: DoubleEquivalence = DEFAULT_DOUBLE_EQUIVALENCE)

Properties

edges

val edges: List<Seg3>

normal

val normal: Vec3

The normal vector of the polygon's plane.

precision

val precision: DoubleEquivalence

The precision used for geometric computations.

vertexCount

open val vertexCount: Int

Returns the number of vertices in the polygon.

vertices

open override val vertices: List<Vec3>

An immutable snapshot of the vertices supplied to the constructor.

Functions

area

open override fun area(): Double

Computes the area of the polygon.

boundingBox

fun boundingBox(): Pair<Vec3, Vec3>

Computes the axis-aligned bounding box of the polygon.

centroid

open override fun centroid(): Vec3

Computes the centroid (geometric center) of the polygon.

component1

operator fun component1(): List<Vec3>

component2

operator fun component2(): DoubleEquivalence

contains

open override fun contains(point: Vec3): Boolean

Checks if a point is inside the polygon.

copy

fun copy(vertices: List<Vec3> = this.vertices, precision: DoubleEquivalence = this.precision): Polygon3

Returns a polygon with the supplied vertices and precision.

dimensions

open override fun dimensions(): Int

Returns the number of dimensions of the spatial object.

equals

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

hashCode

open override fun hashCode(): Int

isConvex

open override fun isConvex(): Boolean

Checks if the polygon is convex.

isFinite

open override fun isFinite(): Boolean

Returns true if all values in the spatial are finite.

isInfinite

open override fun isInfinite(): Boolean

Returns true if any value in the spatial is infinite.

isNaN

open override fun isNaN(): Boolean

Returns true if any value in the spatial is NaN (Not a Number).

isSimple

open override fun isSimple(): Boolean

Checks if the polygon is simple (non-self-intersecting).

perimeter

open override fun perimeter(): Double

Computes the perimeter of the polygon.

reverse

open override fun reverse(): Polygon<Vec3>

Reverses the order of vertices, effectively reversing the orientation of the polygon.

scale

open override fun scale(factor: Double, center: Vec3): Polygon<Vec3>

Scales the polygon by a given factor around a center point.

signedArea

open override fun signedArea(): Double

Computes the signed area of the polygon.

toString

open override fun toString(): String

transform

open override fun transform(transformer: Transformer<Vec3>): Polygon<Vec3>

Transforms the polygon by applying a transformation to all vertices.

translate

open override fun translate(offset: Vec3): Polygon<Vec3>

Translates the polygon by a given offset vector.