The branch now loads maps again. Lots of messy code; most of the VectorLayer stuff...
[potlatch2.git] / REFACTOR.txt
1 == Potlatch 2 refactoring ==
2
3 Aims:
4 - to enable multiple Maps to be shown on-screen (e.g. for junction editor)
5 - to bring Connection and VectorLayer code together
6
7 Current status:
8 - it loads a map and lets you edit it!
9 - VectorLayers (of any shape) will not work - lots of them are commented out
10 - Save/OAuth not tested
11
12 == Changes overall ==
13
14 Map.as becomes a collection of MapPaint objects, all with the same lat/long/scale
15 (plus a backdrop sprite and a background imagery sprite)
16 Map.editableLayer returns a reference to the single MapPaint object where isBackground is false
17
18 MapPaint.as gains a reference to a Connection - i.e. the source data for this layer
19
20 == Stuff to look at ==
21
22 There are lots more of these throughout the code, marked with fixmes of the form '>>>> REFACTOR'
23
24 MapPaint.as
25 - wayuis, nodeuis etc. should ideally be private
26 - removeLayer should blank
27
28 VectorLayer.as is completely derelict
29 - move into Connection
30 - references in Loader classes etc. currently commented out
31 - everything derived from VectorLayers (e.g. Traces, Bugs, BikeShopLoader) needs completely refactoring
32
33 Global changes:
34 - remove all back-references to Map except where necessary for lat/long/scale
35 - getParam is messy - stuff sent via flashvars needs somewhere to live: currently in Globals which is ugly
36 - AttentionEvents are derelict and commented out
37 - tileset/setbackground stuff is screwed up again and needs refactoring a little