Add missing String method

Author: tomas-novotny

image.go

@@ -4,19 +4,19 @@ import (
 	"image"
 )
 
-// PtFromImage converts a Point from an image.Point.
-func PtFromImage[T Number](p image.Point) Point[T] {
+// PointFromImage converts a Point from an image.Point.
+func PointFromImage[T Number](p image.Point) Point[T] {
 	return Point[T]{T(p.X), T(p.Y)}
 }
 
-// SzFromImage converts a Size from an image.Rectangle.
-func SzFromImage[T Number](r image.Rectangle) Size[T] {
+// SizeFromImage converts a Size from an image.Rectangle.
+func SizeFromImage[T Number](r image.Rectangle) Size[T] {
 	return Size[T]{T(r.Dx()), T(r.Dy())}
 }
 
 // RectFromImage converts a Rectangle from an image.Rectangle.
 func RectFromImage[T Number](r image.Rectangle) Rectangle[T] {
-	return RectFromMin(PtFromImage[T](r.Min), SzFromImage[T](r))
+	return RectFromMin(PointFromImage[T](r.Min), SizeFromImage[T](r))
 }
 
 // Point converts a Point to an image.Point.

padding.go

@@ -1,25 +1,20 @@
 package geom
 
+import "fmt"
+
 // Padding represents a 2D padding.
 type Padding[T Number] struct {
-	Top, Right, Bottom, Left T
+	Top    T `json:"t"`
+	Right  T `json:"r"`
+	Bottom T `json:"b"`
+	Left   T `json:"l"`
 }
 
 // Pad is shorthand for Padding{top, right, bottom, left}.
 func Pad[T Number](top, right, bottom, left T) Padding[T] {
 	return Padding[T]{top, right, bottom, left}
 }
 
-// PadU is shorthand for Padding{padding, padding, padding, padding}.
-func PadU[T Number](padding T) Padding[T] {
-	return Padding[T]{padding, padding, padding, padding}
-}
-
-// PadXY is shorthand for Padding{topBottom, leftRight, topBottom, leftRight}.
-func PadXY[T Number](topBottom, leftRight T) Padding[T] {
-	return Padding[T]{topBottom, leftRight, topBottom, leftRight}
-}
-
 // Width returns the width of the padding.
 func (p Padding[T]) Width() T {
 	return p.Left + p.Right
@@ -49,3 +44,18 @@ func (p Padding[T]) Int() Padding[int] {
 func (p Padding[T]) Float() Padding[float64] {
 	return Padding[float64]{float64(p.Top), float64(p.Right), float64(p.Bottom), float64(p.Left)}
 }
+
+// String returns a string representation of the Padding.
+func (p Padding[T]) String() string {
+	return fmt.Sprintf("Pad(%s;%s;%s;%s)", String(p.Top), String(p.Right), String(p.Bottom), String(p.Left))
+}
+
+// PadU is shorthand for Padding{padding, padding, padding, padding}.
+func PadU[T Number](padding T) Padding[T] {
+	return Padding[T]{padding, padding, padding, padding}
+}
+
+// PadXY is shorthand for Padding{topBottom, leftRight, topBottom, leftRight}.
+func PadXY[T Number](topBottom, leftRight T) Padding[T] {
+	return Padding[T]{topBottom, leftRight, topBottom, leftRight}
+}

polygon.go

@@ -1,6 +1,9 @@
 package geom
 
 import (
+	"fmt"
+	"strings"
+
 	"github.com/gravitton/x/slices"
 )
 
@@ -60,10 +63,15 @@ func (p Polygon[T]) Empty() bool {
 
 // Int converts the polygon to a [int] polygon.
 func (p Polygon[T]) Int() Polygon[int] {
-	return Polygon[int]{slices.Map(p.Vertices, (Point[T]).Int)}
+	return Polygon[int]{slices.Map(p.Vertices, Point[T].Int)}
 }
 
 // Float converts the polygon to a [float64] polygon.
 func (p Polygon[T]) Float() Polygon[float64] {
-	return Polygon[float64]{slices.Map(p.Vertices, (Point[T]).Float)}
+	return Polygon[float64]{slices.Map(p.Vertices, Point[T].Float)}
+}
+
+// String returns a string representation of the Polygon.
+func (p Polygon[T]) String() string {
+	return fmt.Sprintf("Pol(%s)", strings.Join(slices.Map(p.Vertices, Point[T].String), ", "))
 }

rectangle.go

@@ -6,8 +6,8 @@ import (
 
 // Rectangle is a 2D axis-aligned rectangle represented by its center and size.
 type Rectangle[T Number] struct {
-	Center Point[T]
-	Size   Size[T]
+	Center Point[T] `json:",inline"`
+	Size   Size[T]  `json:",inline"`
 }
 
 // Rect is shorthand for Rectangle{center, size}.

regular_polygon.go

@@ -1,6 +1,7 @@
 package geom
 
 import (
+	"fmt"
 	"math"
 )
 
@@ -51,7 +52,7 @@ func (rp RegularPolygon[T]) Vertices() []Point[T] {
 	vertices := make([]Point[T], rp.N)
 	for i := 0; i < rp.N; i++ {
 		// TODO: Vec(1,0).Rotate(angle)
-		vertices[i] = rp.Center.Add(VecFromAngle[T](initAngle+float64(i)*angleStep, 1).MultiplyXY(float64(rp.Size.Width), float64(rp.Size.Height)))
+		vertices[i] = rp.Center.Add(VectorFromAngle[T](initAngle+float64(i)*angleStep, 1).MultiplyXY(float64(rp.Size.Width), float64(rp.Size.Height)))
 	}
 
 	return vertices
@@ -94,6 +95,11 @@ func (rp RegularPolygon[T]) Float() RegularPolygon[float64] {
 	return RegularPolygon[float64]{rp.Center.Float(), rp.Size.Float(), rp.N, rp.Angle}
 }
 
+// String returns a string representation of the RegularPolygon.
+func (rp RegularPolygon[T]) String() string {
+	return fmt.Sprintf("RegPol(%s;%s;%s;%s)", rp.Center.String(), rp.Size.String(), String(rp.N), String(rp.Angle))
+}
+
 type Orientation int
 
 const (

size.go

@@ -15,11 +15,6 @@ func Sz[T Number](width, height T) Size[T] {
 	return Size[T]{width, height}
 }
 
-// SzU is shorthand for Size{size, size}.
-func SzU[T Number](size T) Size[T] {
-	return Size[T]{size, size}
-}
-
 // Scale creates a new Size scaled by the given factor in both dimensions.
 func (s Size[T]) Scale(factor float64) Size[T] {
 	return Size[T]{Multiple(s.Width, factor), Multiple(s.Height, factor)}
@@ -99,3 +94,8 @@ func (s Size[T]) Float() Size[float64] {
 func (s Size[T]) String() string {
 	return fmt.Sprintf("%sx%s", String(s.Width), String(s.Height))
 }
+
+// SzU is shorthand for Size{size, size}.
+func SzU[T Number](size T) Size[T] {
+	return Size[T]{size, size}
+}

vector.go

@@ -182,13 +182,20 @@ func (v Vector[T]) String() string {
 	return fmt.Sprintf("⟨%s,%s⟩", String(v.X), String(v.Y))
 }
 
+// VectorFromAngle is shorthand for Vec(1,0).Rotate(angle)
+func VectorFromAngle[T Number](angle float64, length T) Vector[T] {
+	sin, cos := math.Sincos(angle)
+
+	return Vector[T]{Cast[T](float64(length) * cos), Cast[T](float64(length) * sin)}
+}
+
 // ZeroVector creates a new Vector with zero values (0,0).
 func ZeroVector[T Number]() Vector[T] {
 	return Vector[T]{}
 }
 
-// IdentityVector creates a new Vector with identity values (+1,+1).
-func IdentityVector[T Number]() Vector[T] {
+// OneVector creates a new Vector with identity values (+1,+1).
+func OneVector[T Number]() Vector[T] {
 	return Vector[T]{1, 1}
 }
 
@@ -231,10 +238,3 @@ func DownLeftVector() Vector[float64] {
 func DownRightVector() Vector[float64] {
 	return Vector[float64]{OneOverSqrt2, OneOverSqrt2}
 }
-
-// VecFromAngle is shorthand for Vec(1,0).Rotate(angle)
-func VecFromAngle[T Number](angle float64, length T) Vector[T] {
-	sin, cos := math.Sincos(angle)
-
-	return Vector[T]{Cast[T](float64(length) * cos), Cast[T](float64(length) * sin)}
-}

vector_test.go

@@ -13,7 +13,7 @@ func TestVector_New(t *testing.T) {
 	testVector(t, Vec[float64](0.16, 204), 0.16, 204.0)
 
 	testVector(t, ZeroVector[int](), 0, 0)
-	testVector(t, IdentityVector[float64](), 1, 1)
+	testVector(t, OneVector[float64](), 1, 1)
 	testVector(t, UpVector[float64](), 0, -1)
 	testVector(t, DownVector[float64](), 0, 1)
 	testVector(t, RightVector[float64](), 1, 0)