summaryrefslogtreecommitdiffstats
path: root/src/display/README
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--src/display/README26
1 files changed, 26 insertions, 0 deletions
diff --git a/src/display/README b/src/display/README
new file mode 100644
index 0000000..0482a4e
--- /dev/null
+++ b/src/display/README
@@ -0,0 +1,26 @@
+
+
+This directory contains code for: rendering graphics on the canvas,
+"picking" objects on the canvas based on closeness to cursor, directing
+events (mouse button, key press, etc.) to the correct object.
+
+The code can be divided into two types: handling SVG elements
+(DrawingItem and derived classes) and handling controlled items
+(SPCanvasItem and derived structures/classes).
+
+Currently we rely on the "Cairo" graphics library for rendering.
+
+DrawingItem:
+
+ Item belonging to the drawing. These are rendered via the
+ CanvasArena canvas item.
+
+CanvasItem:
+
+ See README in control sub-directory.
+
+To do:
+
+* Split into three directories: drawing, control, common (partially done).
+* Rename control directory to canvas directory.
+* Remove SPCurve.