Merge pull request #7 from tomasf/dev

Merge for 0.3.1

Author: tomasf

.gitignore

@@ -5,3 +5,4 @@
 xcuserdata/
 /.swiftpm
 
+/.claude/settings.local.json

Sources/Cadova/Abstract Layer/2D/Circle/Arc.swift

@@ -9,7 +9,10 @@ import Foundation
 /// let arcWithDiameter = Arc(range: 0°..<90°, diameter: 10)
 /// ```
 public struct Arc: Shape2D {
+    /// The angular range of the arc.
     public let range: Range<Angle>
+
+    /// The radius of the arc.
     public let radius: Double
 
     /// Creates a new `Arc` instance with the specified range of angles and radius.
@@ -30,7 +33,7 @@ public struct Arc: Shape2D {
     }
 
     public var body: any Geometry2D {
-        @Environment(\.segmentation) var segmentation
+        @Environment(\.scaledSegmentation) var segmentation
         Polygon([.zero] + arcPoints(segmentation: segmentation))
     }
 
@@ -45,6 +48,9 @@ public struct Arc: Shape2D {
 }
 
 extension Arc: Area {
+    /// The angular span of the arc.
     public var angularDistance: Angle { range.length }
+
+    /// The area of the circular sector.
     public var area: Double { radius * radius * .pi * (angularDistance / 360°) }
 }

Sources/Cadova/Abstract Layer/2D/Circle/Circle.swift

@@ -12,6 +12,7 @@ public struct Circle {
     /// The diameter of the circle.
     public let diameter: Double
 
+    /// The radius of the circle (half of the diameter).
     public var radius: Double { diameter / 2 }
 
     /// Creates a new `Circle` instance with the specified diameter.
@@ -50,7 +51,7 @@ public struct Circle {
 
 extension Circle: Shape2D {
     public var body: any Geometry2D {
-        @Environment(\.segmentation) var segmentation
+        @Environment(\.scaledSegmentation) var segmentation
         NodeBasedGeometry(.shape(.circle(radius: radius, segmentCount: segmentation.segmentCount(circleRadius: radius))))
     }
 }

Sources/Cadova/Abstract Layer/2D/Circle/Ring.swift

@@ -10,7 +10,10 @@ import Foundation
 /// let ring = Ring(outerDiameter: 10, innerDiameter: 4)
 /// ```
 public struct Ring: Shape2D {
+    /// The outer diameter of the ring.
     public let outerDiameter: Double
+
+    /// The inner diameter of the ring (the hole).
     public let innerDiameter: Double
 
     /// Creates a new `Ring` instance with the specified outer and inner diameters.
@@ -84,6 +87,7 @@ public struct Ring: Shape2D {
 }
 
 extension Ring: Area {
+    /// The area of the ring (outer circle minus inner circle).
     public var area: Double {
         Circle(diameter: outerDiameter).area - Circle(diameter: innerDiameter).area
     }

Sources/Cadova/Abstract Layer/2D/Metrics2D.swift

@@ -1,14 +1,33 @@
 import Foundation
 
+/// A type that has a measurable area.
+///
+/// Conforming types provide an `area` property representing the enclosed surface area.
+/// Many 2D shapes in Cadova conform to this protocol, including ``Circle``, ``Rectangle``,
+/// ``RegularPolygon``, and others.
+///
 public protocol Area {
+    /// The enclosed area of the shape.
     var area: Double { get }
 }
 
+/// A type that has a measurable perimeter.
+///
+/// Conforming types provide a `perimeter` property representing the total length of
+/// the shape's boundary. Many 2D shapes in Cadova conform to this protocol, including
+/// ``Circle`` (where it represents circumference), ``Rectangle``, ``RegularPolygon``, and others.
+///
 public protocol Perimeter {
+    /// The total length of the shape's boundary.
     var perimeter: Double { get }
 }
 
 public extension Area {
+    /// Calculates the volume of a pyramid with this shape as the base.
+    ///
+    /// - Parameter height: The height of the pyramid from base to apex.
+    /// - Returns: The volume of the pyramid.
+    ///
     func pyramidVolume(height: Double) -> Double {
         return (area * height) / 3.0
     }

Sources/Cadova/Abstract Layer/2D/Polygon/PolygonPoints.swift

@@ -10,7 +10,7 @@ internal indirect enum PolygonPoints: Sendable, Hashable, Codable {
     func points(in environment: EnvironmentValues) -> [Vector2D] {
         switch self {
         case .literal (let array): array
-        case .curve (let curve): curve.curve.points(segmentation: environment.segmentation)
+        case .curve (let curve): curve.curve.points(segmentation: environment.scaledSegmentation)
         case .transformed (let polygonPoints, let transform):
             polygonPoints.points(in: environment)
                 .map { transform.apply(to: $0) }

Sources/Cadova/Abstract Layer/2D/RegularPolygon.swift

@@ -66,10 +66,12 @@ public extension RegularPolygon {
 }
 
 extension RegularPolygon: Area, Perimeter {
+    /// The area of the polygon.
     public var area: Double {
         Double(sideCount) / 2.0 * pow(circumradius, 2) * sin(360° / Double(sideCount))
     }
 
+    /// The perimeter of the polygon.
     public var perimeter: Double {
         Double(sideCount) * sideLength
     }

Sources/Cadova/Abstract Layer/2D/Stadium.swift

@@ -54,11 +54,13 @@ public struct Stadium: Shape2D {
 }
 
 extension Stadium: Area, Perimeter {
+    /// The area of the stadium.
     public var area: Double {
         let diameter = min(size.x, size.y)
         return Double.pi * (diameter / 2) * (diameter / 2) + (max(size.x, size.y) - diameter) * diameter
     }
 
+    /// The perimeter of the stadium.
     public var perimeter: Double {
         let diameter = min(size.x, size.y)
         return Double.pi * diameter + 2.0 * (max(size.x, size.y) - diameter)

Sources/Cadova/Abstract Layer/2D/Text/GlyphRenderer.swift

@@ -77,7 +77,7 @@ internal class GlyphRenderer {
             FT_Outline_Decompose(&mutableOutline, &funcs, mutablePointer)
         }
         guard composeResult == 0 else { return nil }
-        return SimplePolygonList(paths.map { SimplePolygon($0.points(segmentation: environment.segmentation)) })
+        return SimplePolygonList(paths.map { SimplePolygon($0.points(segmentation: environment.scaledSegmentation)) })
     }
 }
 

Sources/Cadova/Abstract Layer/2D/Text/Text.swift

@@ -32,7 +32,7 @@ public struct Text: Shape2D {
     public var body: any Geometry2D {
         @Environment var environment
         @Environment(\.textAttributes) var textAttributes
-        @Environment(\.segmentation) var segmentation
+        @Environment(\.scaledSegmentation) var segmentation
         let attributes = textAttributes.applyingDefaults()
 
         CachedNode(name: "text", parameters: content, attributes, segmentation) { environment, context in