This repository has no description
📝 Document graphics module
author
Gwenn Le Bihan
committer
GitHub
date
(Feb 27, 2025, 11:18 PM +0100)
commit
ea10223d
ea10223de43ae46d5117a88252c7fc8701f345a1
parent
4506bc2c
4506bc2c02d5892d8da4ae0d9c029595f75b679b
+25
+25
src/graphics/README.md
+25
src/graphics/README.md
···
1
+
# Shapemaker Graphics module
2
+
3
+
Handles objects that can be rendered to SVG
4
+
5
+
Actual implementation of the SVG rendering logic is in `../rendering`, not here.
6
+
7
+
A Shapemaker image is represented by a Canvas, which is comprised of multiple Layers. Those Layers contain multiple Colored Objects.
8
+
9
+
Those Colored Objects are a combination of a Fill, possibly Filters and Transformations, as well as a "plain" Object (which can be a Line, a Polygon, a Point, a BigCircle, etc. (check the enum's different variants))
10
+
11
+
A Fill is made up of a Color alongside the Fill variant: Solid, Hatched, Dotted, Translucent etc.
12
+
13
+
A color is "abstract", meaning its just a named color (red, green, etc). Actual hex values are given when rendering, through a ColorMapping.
14
+
15
+
```mermaid
16
+
graph TD
17
+
Layer --> Canvas
18
+
ColoredObject --> Layer
19
+
Object --> ColoredObject
20
+
Filter --> ColoredObject
21
+
Transformation --> ColoredObject
22
+
Fill --> ColoredObject
23
+
Color --> Fill
24
+
```
25
+