jess
/
Graphite
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update architecture diagram content and formatting

This commit is contained in:
Keavon Chambers 2021-04-07 22:33:58 -07:00
parent 09c4a1b796
commit e34672556d
1 changed files with 34 additions and 32 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

66
docs/codebase/architecture-overview.nomnoml
View File

@ -37,8 +37,7 @@
One of many possible frontend implementations, One of many possible frontend implementations,
such as the native or web client. such as the native or web client.
] ]
[Frontend Implementation] Response <-> Event [Dispatcher] [Frontend Implementation] Send Rendered Viewport to Client <-- [<renderer> (Backchannel) From: Final Render Assembler]
[Frontend Implementation] <-- Rendered Viewport [<renderer> From: Final Render Assembler]
[<client> CLI Implementation| [<client> CLI Implementation|
A possible text-based CLI program that A possible text-based CLI program that
@ -49,7 +48,6 @@
pass a .gdd document and request a pass a .gdd document and request a
render. Caches are saved to disk. render. Caches are saved to disk.
] ]
[CLI Implementation] -> [Design Document Maintainer]
// Editor // Editor
@ -60,32 +58,35 @@
file. Operations and document-specific Actions file. Operations and document-specific Actions
include the document ID in the call. include the document ID in the call.
] ]
[Dispatcher] <-> Action [Editor State Store] [Dispatcher] --> Set New Bounds [<renderer> (Backchannel) To: Scheduler]
[Dispatcher] <-> Action [Open Documents State Store] [Dispatcher] -> Operations [Design Document Maintainer]
[Dispatcher] -> Update Bounds [Scheduler]
[Dispatcher] -> Operation [Design Document Maintainer]
[<editor> Open Documents State Store| [CLI Implementation] -> CLI Arguments [Design Document Maintainer]
For each open document:|
[<state> Pan and zoom canvas bounds]|
[<state> Selected layers]
]
[Tool State Machine] <- [Open Documents State Store]
[<editor> Editor State Store| [<editor> State Stores|
[<state> Panel Layout]| [<editor> Open Documents State Store|
[<state> Working Colors]| For each open document:|
[<state> Active Tool]| [<state> Pan and zoom canvas bounds]|
[<state> Tool Options]| [<state> Selected layers]
[<state> Modifier Key Input]| ]
[<state> Currently Hovered Panel]
[<editor> Editor State Store|
[<state> Panel Layout]|
[<state> Working Colors]|
[<state> Active Tool]|
[<state> Tool Options]|
[<state> Modifier Key Input]|
[<state> Currently Hovered Panel]
]
] ]
[Editor State Store] -> [Tool State Machine]
[<editor> Tool State Machine| [<editor> Tool State Machine|
List the possible operations in current context List the possible operations in current context
] ]
[Tool State Machine] -> [Dispatcher] [Tool State Machine] <:- [State Stores]
[Tool State Machine] -> Send Responses & Operations [Dispatcher]
[Frontend Implementation] Send Responses <-> Send Events [Dispatcher]
[Dispatcher] <:-> Send Actions [State Stores]
// Document // Document
@ -95,8 +96,8 @@
the previous operation if it's the same as this one and append partial the previous operation if it's the same as this one and append partial
updates to operations from in-progress interactive tools. updates to operations from in-progress interactive tools.
] ]
[Design Document Maintainer] -> Design Document Diff [Render Graph Maintainer] [Design Document Maintainer] -> Send Design Document Diff [Render Graph Maintainer]
[Design Document Maintainer] <-> Design Document [Open Documents File Store] [Design Document Maintainer] <:-> Write Updated GDD [Open Documents File Store]
[<document> Render Graph Maintainer| [<document> Render Graph Maintainer|
Bake operations into a complete graph including history references. Bake operations into a complete graph including history references.
@ -106,8 +107,8 @@
between the live graph and each additional history reference so between the live graph and each additional history reference so
changed nodes in history are "ghost variants" living in the live graph. changed nodes in history are "ghost variants" living in the live graph.
] ]
[Render Graph Maintainer] -> Render Graph [Scheduler] [Render Graph Maintainer] <:-> Write Updated GRD [Open Documents File Store]
[Render Graph Maintainer] <-> Render Graph [Open Documents File Store] [Render Graph Maintainer] -> Send Render Graph [Scheduler]
[<document>Open Documents File Store| [<document>Open Documents File Store|
Kept in-memory or written to disk.| Kept in-memory or written to disk.|
@ -129,9 +130,10 @@
onscreen latency. Also notifies the Final Render Assembler when the cache onscreen latency. Also notifies the Final Render Assembler when the cache
tiles for the root document visible in bounds have finished being updated. tiles for the root document visible in bounds have finished being updated.
] ]
[Scheduler] -> [Node Rasterizer] [Scheduler] Set New Bounds <-- [<editor> (Backchannel) From: Dispatcher]
[Scheduler] <-> [Node Cache Manager] [Scheduler] -> Rasterize Tiles [Node Rasterizer]
[Scheduler] -> [Final Render Assembler] [Scheduler] <:-> Write Dirty Status [Node Cache Manager]
[Scheduler] -> Invoke [Final Render Assembler]
[<renderer> Node Cache Manager| [<renderer> Node Cache Manager|
Purges old or less useful cached data Purges old or less useful cached data
@ -147,14 +149,14 @@
Reuse when panning. Reuse when panning.
] ]
] ]
[Node Cache Manager] -> [Final Render Assembler] [Node Cache Manager] -:> [Final Render Assembler]
[<renderer> Node Rasterizer| [<renderer> Node Rasterizer|
Rasterize and update the cache for a specified node Rasterize and update the cache for a specified node
given a preferred bounds (but it can give a different given a preferred bounds (but it can give a different
sized output), resolution, and quality level. sized output), resolution, and quality level.
] ]
[Node Rasterizer] <-> [Node Cache Manager] [Node Rasterizer] <:-> Write Tiles [Node Cache Manager]
[<renderer> Final Render Assembler| [<renderer> Final Render Assembler|
Look up the rasterized cached tiles from Look up the rasterized cached tiles from
@ -163,5 +165,5 @@
Operates when woken up by the scheduler Operates when woken up by the scheduler
when root tiles or render bounds are updated. when root tiles or render bounds are updated.
] ]
[Final Render Assembler] --> Rendered Viewport [<client> To: Frontend Implementation] [Final Render Assembler] --> Send Rendered Viewport to Client [<client> (Backchannel) To: Frontend Implementation]
] ]