Skip to content

Commit

Permalink
add some docs
Browse files Browse the repository at this point in the history
  • Loading branch information
spearwolf committed May 24, 2024
1 parent e7cdfbf commit 6121f77
Show file tree
Hide file tree
Showing 3 changed files with 62 additions and 0 deletions.
49 changes: 49 additions & 0 deletions packages/shadow-ents/src/view/ShadowEnv.drawio
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
<mxfile host="app.diagrams.net" modified="2024-05-24T08:24:55.766Z" agent="Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/125.0.0.0 Safari/537.36" etag="7uJQEzliJTH2lT3GdOx3" version="24.4.7" type="device">
<diagram name="Seite-1" id="qJ4vABtUxzLaA0-g0SjJ">
<mxGraphModel dx="1434" dy="819" grid="1" gridSize="10" guides="1" tooltips="1" connect="1" arrows="1" fold="1" page="1" pageScale="1" pageWidth="827" pageHeight="1169" math="0" shadow="0">
<root>
<mxCell id="0" />
<mxCell id="1" parent="0" />
<mxCell id="L0xOBzSdBNHgVUkidRTV-2" value="ShadowEnv" style="rounded=0;whiteSpace=wrap;html=1;fontStyle=1;fontSize=18;" vertex="1" parent="1">
<mxGeometry x="120" y="100" width="600" height="60" as="geometry" />
</mxCell>
<mxCell id="L0xOBzSdBNHgVUkidRTV-17" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;entryX=0.5;entryY=1;entryDx=0;entryDy=0;endArrow=none;endFill=0;" edge="1" parent="1" source="L0xOBzSdBNHgVUkidRTV-5" target="L0xOBzSdBNHgVUkidRTV-2">
<mxGeometry relative="1" as="geometry" />
</mxCell>
<mxCell id="L0xOBzSdBNHgVUkidRTV-5" value="&lt;i&gt;view&lt;/i&gt;" style="swimlane;whiteSpace=wrap;html=1;" vertex="1" parent="1">
<mxGeometry x="120" y="200" width="280" height="230" as="geometry" />
</mxCell>
<mxCell id="L0xOBzSdBNHgVUkidRTV-7" value="ComponentContext" style="rounded=0;whiteSpace=wrap;html=1;" vertex="1" parent="L0xOBzSdBNHgVUkidRTV-5">
<mxGeometry x="80" y="40" width="120" height="60" as="geometry" />
</mxCell>
<mxCell id="L0xOBzSdBNHgVUkidRTV-10" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;entryX=0.5;entryY=1;entryDx=0;entryDy=0;" edge="1" parent="L0xOBzSdBNHgVUkidRTV-5" source="L0xOBzSdBNHgVUkidRTV-8" target="L0xOBzSdBNHgVUkidRTV-7">
<mxGeometry relative="1" as="geometry" />
</mxCell>
<mxCell id="L0xOBzSdBNHgVUkidRTV-8" value="ViewComponents" style="rounded=0;whiteSpace=wrap;html=1;" vertex="1" parent="L0xOBzSdBNHgVUkidRTV-5">
<mxGeometry x="80" y="140" width="120" height="60" as="geometry" />
</mxCell>
<mxCell id="L0xOBzSdBNHgVUkidRTV-18" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;entryX=0.5;entryY=1;entryDx=0;entryDy=0;strokeColor=default;endArrow=none;endFill=0;" edge="1" parent="1" source="L0xOBzSdBNHgVUkidRTV-6" target="L0xOBzSdBNHgVUkidRTV-2">
<mxGeometry relative="1" as="geometry" />
</mxCell>
<mxCell id="L0xOBzSdBNHgVUkidRTV-6" value="&lt;i&gt;worker enviroment&lt;/i&gt;" style="swimlane;whiteSpace=wrap;html=1;" vertex="1" parent="1">
<mxGeometry x="440" y="200" width="280" height="290" as="geometry" />
</mxCell>
<mxCell id="L0xOBzSdBNHgVUkidRTV-11" value="MessageRouter" style="rounded=0;whiteSpace=wrap;html=1;" vertex="1" parent="L0xOBzSdBNHgVUkidRTV-6">
<mxGeometry x="20" y="40" width="240" height="60" as="geometry" />
</mxCell>
<mxCell id="L0xOBzSdBNHgVUkidRTV-12" value="Kernel" style="rounded=0;whiteSpace=wrap;html=1;" vertex="1" parent="L0xOBzSdBNHgVUkidRTV-6">
<mxGeometry x="20" y="100" width="120" height="60" as="geometry" />
</mxCell>
<mxCell id="L0xOBzSdBNHgVUkidRTV-13" value="Registry" style="rounded=0;whiteSpace=wrap;html=1;" vertex="1" parent="L0xOBzSdBNHgVUkidRTV-6">
<mxGeometry x="140" y="100" width="120" height="60" as="geometry" />
</mxCell>
<mxCell id="L0xOBzSdBNHgVUkidRTV-16" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;entryX=0.5;entryY=1;entryDx=0;entryDy=0;" edge="1" parent="L0xOBzSdBNHgVUkidRTV-6" source="L0xOBzSdBNHgVUkidRTV-14" target="L0xOBzSdBNHgVUkidRTV-12">
<mxGeometry relative="1" as="geometry" />
</mxCell>
<mxCell id="L0xOBzSdBNHgVUkidRTV-14" value="shadow objects" style="rounded=0;whiteSpace=wrap;html=1;fontStyle=2" vertex="1" parent="L0xOBzSdBNHgVUkidRTV-6">
<mxGeometry x="20" y="200" width="120" height="60" as="geometry" />
</mxCell>
</root>
</mxGraphModel>
</diagram>
</mxfile>
4 changes: 4 additions & 0 deletions packages/shadow-ents/src/view/ShadowEnv.drawio.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
9 changes: 9 additions & 0 deletions packages/shadow-ents/src/view/ShadowEnv.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# ShadowEnv Documentation

![ShadowEnv](./ShadowEnv.drawio.svg)

The _ShadowEnv_ class creates an environment that references the _view_ and provides a connection to the _shadow worker environment_.

The _view_ consists of the _ComponentContext_ and the _ViewComponents_ contained within it.

The _worker environment_ is the runtime environment for all _shadow objects_ and consists of the _MessageRouter_, the _Kernel_, and the _Registry_.

0 comments on commit 6121f77

Please sign in to comment.