summaryrefslogtreecommitdiff
path: root/notes.md
diff options
context:
space:
mode:
Diffstat (limited to 'notes.md')
-rw-r--r--notes.md62
1 files changed, 46 insertions, 16 deletions
diff --git a/notes.md b/notes.md
index 2a869db..d0d02c6 100644
--- a/notes.md
+++ b/notes.md
@@ -69,25 +69,55 @@ and those kinds of nodes should be on their own layers, so that the user can vie
ignore relevant data at any time.
-nodes
------
+points
+------
+
+Points are objects with the following properties **only**:
+
+ - x: the x-coordinate in meters
+ - y: the y-coordinate in meters
+
+
+shapes
+------
+
+A shape is an object containing the following properties **only**:
+
+ - type: a string, either 'point', 'path', or 'polygon'
+ - points: an array of `points`, or, if type is 'point', a single point object.
+ - boundingBox: AABB that contains every point in `points`
-node types:
- - point
- - path
- - polygon
-all nodes can be selected to view properties in the right pane. They can then be edited by clicking a button on the pane.
+mapObject
+---------
+
+mapObjects are objects with the following properties:
+
+ - core: a point
+ - shapes: an array of `shape` objects
+ - mapObjects: an array of child mapObjects
+ - boundingBox: AABB that contains the bounding boxes of every shape in shapes
+ - minZoom: a number from 0 to 6 (see maxZoom)
+ - maxZoom: a number from 0 to 7:
+ 0. global
+ 1. regional
+ 2. national
+ 3. provincial
+ 4. city
+ 5. neighborhood
+ 6. building
+
+
+tiles
+-----
+
+A tile is an object with the following properties:
-All nodes can be moved when editing. Path and polygon nodes can have their constituent points moved and can insert new nodes.
+ - region: an AABB bounding the tile area
+ - mapObjects: an array of references to the mapObjects that intersect this square
-Nodes have an associated "relevance level"
+worlds
+------
- - building (smallest)
- - neighborhood
- - city
- - province
- - nation
- - global (largest)
+a world is an object with the following properties:
-depending on a map's scale, some of these may not be relevant (i.e. a map only showing a city would not use higher relevance levels).