From 26ba4098a4f7391b4108d1ac363546a95ac410f8 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Jo=C3=A3o=20Costa?= <jdpc557@gmail.com>
Date: Sat, 7 Sep 2024 13:54:08 +0100
Subject: [PATCH] Add experimental notices

---
 .../eu/joaocosta/minart/geometry/AxisAlignedBoundingBox.scala   | 2 ++
 .../src/main/scala/eu/joaocosta/minart/geometry/Circle.scala    | 2 ++
 .../main/scala/eu/joaocosta/minart/geometry/ConvexPolygon.scala | 2 ++
 .../src/main/scala/eu/joaocosta/minart/geometry/Shape.scala     | 2 ++
 .../scala/eu/joaocosta/minart/graphics/MutableSurface.scala     | 2 ++
 .../src/main/scala/eu/joaocosta/minart/graphics/Plane.scala     | 2 ++
 6 files changed, 12 insertions(+)

diff --git a/core/shared/src/main/scala/eu/joaocosta/minart/geometry/AxisAlignedBoundingBox.scala b/core/shared/src/main/scala/eu/joaocosta/minart/geometry/AxisAlignedBoundingBox.scala
index bd1b6d36..f3929a42 100644
--- a/core/shared/src/main/scala/eu/joaocosta/minart/geometry/AxisAlignedBoundingBox.scala
+++ b/core/shared/src/main/scala/eu/joaocosta/minart/geometry/AxisAlignedBoundingBox.scala
@@ -4,6 +4,8 @@ package eu.joaocosta.minart.geometry
   *
   * Represents a rectangular region aligned to the (x, y) axis and provides some basic functionality.
   *
+  * This API is *experimental* and might change in the near future.
+  *
   * @param x x position of the top-left coordinate
   * @param y y position of the top-left coordinate
   * @param width box width in pixels
diff --git a/core/shared/src/main/scala/eu/joaocosta/minart/geometry/Circle.scala b/core/shared/src/main/scala/eu/joaocosta/minart/geometry/Circle.scala
index c266f793..7c54b5af 100644
--- a/core/shared/src/main/scala/eu/joaocosta/minart/geometry/Circle.scala
+++ b/core/shared/src/main/scala/eu/joaocosta/minart/geometry/Circle.scala
@@ -4,6 +4,8 @@ package eu.joaocosta.minart.geometry
   *
   * It's considered to be facing the viewer if the radius is positive.
   *
+  * This API is *experimental* and might change in the near future.
+  *
   * @param center center of the circle.
   * @param radius circle radius
   */
diff --git a/core/shared/src/main/scala/eu/joaocosta/minart/geometry/ConvexPolygon.scala b/core/shared/src/main/scala/eu/joaocosta/minart/geometry/ConvexPolygon.scala
index 513423fc..60a18ab1 100644
--- a/core/shared/src/main/scala/eu/joaocosta/minart/geometry/ConvexPolygon.scala
+++ b/core/shared/src/main/scala/eu/joaocosta/minart/geometry/ConvexPolygon.scala
@@ -7,6 +7,8 @@ package eu.joaocosta.minart.geometry
   * There is no check in place to guarantee that the generated polygon is actually convex.
   * If this is not the case, the methods may return wrong results.
   *
+  * This API is *experimental* and might change in the near future.
+  *
   * @param vertices ordered sequence of vertices.
   */
 final case class ConvexPolygon(vertices: Vector[Shape.Point]) extends Shape {
diff --git a/core/shared/src/main/scala/eu/joaocosta/minart/geometry/Shape.scala b/core/shared/src/main/scala/eu/joaocosta/minart/geometry/Shape.scala
index 55399077..12593dc9 100644
--- a/core/shared/src/main/scala/eu/joaocosta/minart/geometry/Shape.scala
+++ b/core/shared/src/main/scala/eu/joaocosta/minart/geometry/Shape.scala
@@ -3,6 +3,8 @@ package eu.joaocosta.minart.geometry
 /** Abstract shape.
   *
   *  Can be combined with other shapes and can check if a point is inside of it.
+  *
+  * This API is *experimental* and might change in the near future.
   */
 trait Shape {
 
diff --git a/core/shared/src/main/scala/eu/joaocosta/minart/graphics/MutableSurface.scala b/core/shared/src/main/scala/eu/joaocosta/minart/graphics/MutableSurface.scala
index a2b57c92..2edaed01 100644
--- a/core/shared/src/main/scala/eu/joaocosta/minart/graphics/MutableSurface.scala
+++ b/core/shared/src/main/scala/eu/joaocosta/minart/graphics/MutableSurface.scala
@@ -110,6 +110,8 @@ trait MutableSurface extends Surface {
   }
 
   /** Draws a shape on top of this surface.
+    *
+    * This API is *experimental* and might change in the near future.
     *
     * @param shape shape to draw
     * @param frontfaceColor color of the front face
diff --git a/core/shared/src/main/scala/eu/joaocosta/minart/graphics/Plane.scala b/core/shared/src/main/scala/eu/joaocosta/minart/graphics/Plane.scala
index 1acce7e3..69985ff7 100644
--- a/core/shared/src/main/scala/eu/joaocosta/minart/graphics/Plane.scala
+++ b/core/shared/src/main/scala/eu/joaocosta/minart/graphics/Plane.scala
@@ -108,6 +108,8 @@ trait Plane extends Function2[Int, Int, Color] { outer =>
     *
     * Similar to MutableSurface#rasterize, but for shapes and planes.
     *
+    * This API is *experimental* and might change in the near future.
+    *
     * @param that shape to overlay
     * @param frontfaceColor color of the front face
     * @param backfaceColor color of the back face