188 lines
11 KiB
HTML
188 lines
11 KiB
HTML
<!-- Documentation produced by the Html generator of Bouml (http://bouml.free.fr) -->
|
|
<?xml version="1.0" encoding="UTF-8"?>
|
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
|
|
|
<head>
|
|
<title>cin3
|
|
Documentation</title>
|
|
<link rel="stylesheet" href="style.css" type="text/css" />
|
|
</head>
|
|
|
|
<body bgcolor="#ffffff">
|
|
|
|
<div class = "title">cin3<br />Documentation</div>
|
|
<p></p>
|
|
|
|
<!-- ============================================================= -->
|
|
|
|
<a name="ref1"></a>
|
|
<a name="ref2"></a>
|
|
<h1 class ="package">1 Package design</h1>
|
|
<p>All things concering the big picture.<br />Not a real code package, rather a container for design drafts, specifications, decisions.<br /></p><div class="sub">
|
|
<a name="ref3"></a>
|
|
<h2 class ="view">1.1 Component View Architecture</h2>
|
|
<p>The various Components comprising the Cinelerra3 Video editing Application<br /></p>
|
|
<div class="sub">
|
|
<a name="ref4"></a>
|
|
<p align="center"><img src="fig1.png" alt="" /></p>
|
|
<p align="center"><b>Overview</b></p><p><br /></p><p><br /></p>
|
|
<p>This drawing shows the top level compoents and relations<br /></p><a name="ref5"></a>
|
|
<table><tr><td><div class="element">Component <b>Builder</b></div></td></tr></table>
|
|
<a name="ref6"></a>
|
|
<table><tr><td><div class="element">Component <b>Session</b></div></td></tr></table>
|
|
<div class="sub">
|
|
<a name="ref7"></a>
|
|
<table><tr><td><div class="element">Component <b>EDL</b></div></td></tr></table>
|
|
<p>nested in <a href="index.html#ref6"><b>Session</b></a></p>
|
|
<a name="ref8"></a>
|
|
<table><tr><td><div class="element">Component <b>Fixture</b></div></td></tr></table>
|
|
<p>nested in <a href="index.html#ref6"><b>Session</b></a></p>
|
|
</div>
|
|
<a name="ref9"></a>
|
|
<table><tr><td><div class="element">Component <b>Controller</b></div></td></tr></table>
|
|
<p>Depends on <a href="index.html#ref5"><b>Builder</b></a></p><div class="sub">
|
|
</div>
|
|
<a name="ref10"></a>
|
|
<table><tr><td><div class="element">Component <b>AssetManagement</b></div></td></tr></table>
|
|
<a name="ref11"></a>
|
|
<table><tr><td><div class="element">Component <b>Dispatcher</b></div></td></tr></table>
|
|
<a name="ref12"></a>
|
|
<table><tr><td><div class="element">Component <b>Engine</b></div></td></tr></table>
|
|
<p>Depends on <a href="index.html#ref13"><b>Stream Provider</b></a></p><div class="sub">
|
|
</div>
|
|
<a name="ref13"></a>
|
|
<table><tr><td><div class="element">Component <b>Stream Provider</b></div></td></tr></table>
|
|
<p>Depends on <a href="index.html#ref14"><b>Cache</b></a></p><div class="sub">
|
|
</div>
|
|
<a name="ref14"></a>
|
|
<table><tr><td><div class="element">Component <b>Cache</b></div></td></tr></table>
|
|
<a name="ref15"></a>
|
|
<table><tr><td><div class="element">Component <b>RenderPathManager</b></div></td></tr></table>
|
|
</div>
|
|
</div>
|
|
<a name="ref16"></a>
|
|
<h1 class ="package">2 Package AssetManager</h1>
|
|
<a name="ref17"></a>
|
|
<h1 class ="package">3 Package MObject</h1>
|
|
<div class="sub">
|
|
<a name="ref18"></a>
|
|
<h2 class ="view">3.1 Class View Session</h2>
|
|
<div class="sub">
|
|
<a name="ref19"></a>
|
|
<p align="center"><img src="fig2.png" alt="" /></p>
|
|
<p align="center"><b>Session structure</b></p><p><br /></p><p><br /></p>
|
|
<table><tr><td><div class="element">Class <b><a href="class20.html#ref20"><b>Session</b></a></b></div></td></tr></table>
|
|
<table><tr><td><div class="element">Class <b><a href="class23.html#ref23"><b>EDL</b></a></b></div></td></tr></table>
|
|
<table><tr><td><div class="element">Class <b><a href="class26.html#ref26"><b>Fixture</b></a></b></div></td></tr></table>
|
|
<table><tr><td><div class="element">Class <b><a href="class31.html#ref31"><b>Track</b></a></b></div></td></tr></table>
|
|
<table><tr><td><div class="element">Class <b><a href="class32.html#ref32"><b>MObject</b></a></b></div></td></tr></table>
|
|
<table><tr><td><div class="element">Class <b><a href="class34.html#ref34"><b>Placement</b></a></b></div></td></tr></table>
|
|
<table><tr><td><div class="element">Class <b><a href="class37.html#ref37"><b>AbstractMO</b></a></b></div></td></tr></table>
|
|
<table><tr><td><div class="element">Class <b><a href="class38.html#ref38"><b>Clip</b></a></b></div></td></tr></table>
|
|
<table><tr><td><div class="element">Class <b><a href="class39.html#ref39"><b>Effect</b></a></b></div></td></tr></table>
|
|
<table><tr><td><div class="element">Class <b><a href="class40.html#ref40"><b>Meta</b></a></b></div></td></tr></table>
|
|
<table><tr><td><div class="element">Class <b><a href="class41.html#ref41"><b>DirectPlacement</b></a></b></div></td></tr></table>
|
|
<table><tr><td><div class="element">Class <b><a href="class42.html#ref42"><b>RelativePlacement</b></a></b></div></td></tr></table>
|
|
<table><tr><td><div class="element">Class <b><a href="class45.html#ref45"><b>Allocation</b></a></b></div></td></tr></table>
|
|
<table><tr><td><div class="element">Class <b><a href="class46.html#ref46"><b>Label</b></a></b></div></td></tr></table>
|
|
<table><tr><td><div class="element">Class <b><a href="class47.html#ref47"><b>ExplicitePlacement</b></a></b></div></td></tr></table>
|
|
<table><tr><td><div class="element">Class <b><a href="class51.html#ref51"><b>Auto</b></a></b></div></td></tr></table>
|
|
<table><tr><td><div class="element">Class <b><a href="class52.html#ref52"><b>Wish</b></a></b></div></td></tr></table>
|
|
<table><tr><td><div class="element">Class <b><a href="class53.html#ref53"><b>Constraint</b></a></b></div></td></tr></table>
|
|
</div>
|
|
<a name="ref54"></a>
|
|
<h2 class ="package">3.2 Package Builder</h2>
|
|
<div class="sub">
|
|
<a name="ref55"></a>
|
|
<h3 class ="view">3.2.1 Class View Builder Workings</h3>
|
|
<div class="sub">
|
|
<a name="ref56"></a>
|
|
<p align="center"><img src="fig3.png" alt="" /></p>
|
|
<p align="center"><b>build process</b></p><p><br /></p><p><br /></p>
|
|
<p>This figure shows the process of building and starting a RenderEngine<br /></p><table><tr><td><div class="element">Class <b><a href="class57.html#ref57"><b>BuilderFacade</b></a></b></div></td></tr></table>
|
|
<table><tr><td><div class="element">Class <b><a href="class59.html#ref59"><b>ToolFactory</b></a></b></div></td></tr></table>
|
|
<table><tr><td><div class="element">Class <b><a href="class61.html#ref61"><b>ConManager</b></a></b></div></td></tr></table>
|
|
<table><tr><td><div class="element">Class <b><a href="class63.html#ref63"><b>Assembler</b></a></b></div></td></tr></table>
|
|
<table><tr><td><div class="element">Class <b><a href="class65.html#ref65"><b>StateProxy</b></a></b></div></td></tr></table>
|
|
</div>
|
|
</div>
|
|
<a name="ref67"></a>
|
|
<h2 class ="package">3.3 Package Controller</h2>
|
|
<div class="sub">
|
|
<a name="ref68"></a>
|
|
<h3 class ="view">3.3.1 Class View Controller Workings</h3>
|
|
<div class="sub">
|
|
<a name="ref69"></a>
|
|
<p align="center"><img src="fig4.png" alt="" /></p>
|
|
<p align="center"><b>Controller Entities</b></p><p><br /></p><p><br /></p>
|
|
<table><tr><td><div class="element">Class <b><a href="class70.html#ref70"><b>ControllerFacade</b></a></b></div></td></tr></table>
|
|
<table><tr><td><div class="element">Class <b><a href="class71.html#ref71"><b>PathManager</b></a></b></div></td></tr></table>
|
|
<table><tr><td><div class="element">Class <b><a href="class73.html#ref73"><b>RenderState</b></a></b></div></td></tr></table>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<a name="ref75"></a>
|
|
<h1 class ="package">4 Package RenderEngine</h1>
|
|
<div class="sub">
|
|
<a name="ref76"></a>
|
|
<h2 class ="view">4.1 Deployment View Engine Parts</h2>
|
|
<div class="sub">
|
|
<a name="ref77"></a>
|
|
<p align="center"><img src="fig5.png" alt="" /></p>
|
|
<p align="center"><b>Overview Render Engine</b></p><p><br /></p><p><br /></p>
|
|
<a name="ref78"></a>
|
|
<table><tr><td><div class="element">Node <b>timeline</b></div></td></tr></table>
|
|
<a name="ref79"></a>
|
|
<table><tr><td><div class="element">Node <b>playlist</b></div></td></tr></table>
|
|
<a name="ref80"></a>
|
|
<table><tr><td><div class="element">Node <b>proc</b></div></td></tr></table>
|
|
<a name="ref81"></a>
|
|
<table><tr><td><div class="element">Node <b>pnode</b></div></td></tr></table>
|
|
<a name="ref82"></a>
|
|
<table><tr><td><div class="element">Node <b>mStream</b></div></td></tr></table>
|
|
<a name="ref83"></a>
|
|
<table><tr><td><div class="element">Node <b>State</b></div></td></tr></table>
|
|
</div>
|
|
<a name="ref84"></a>
|
|
<h2 class ="view">4.2 Class View Engine Workings</h2>
|
|
<div class="sub">
|
|
<a name="ref85"></a>
|
|
<p align="center"><img src="fig6.png" alt="" /></p>
|
|
<p align="center"><b>Render Entities</b></p><p><br /></p><p><br /></p>
|
|
<table><tr><td><div class="element">Class <b><a href="class86.html#ref86"><b>RenderEngine</b></a></b></div></td></tr></table>
|
|
<table><tr><td><div class="element">Class <b><a href="class89.html#ref89"><b>Processor</b></a></b></div></td></tr></table>
|
|
<table><tr><td><div class="element">Class <b><a href="class91.html#ref91"><b>ExitNode</b></a></b></div></td></tr></table>
|
|
<table><tr><td><div class="element">Class <b><a href="class92.html#ref92"><b>ProcNode</b></a></b></div></td></tr></table>
|
|
<table><tr><td><div class="element">Class <b><a href="class93.html#ref93"><b>Trafo</b></a></b></div></td></tr></table>
|
|
<table><tr><td><div class="element">Class <b><a href="class94.html#ref94"><b>Link</b></a></b></div></td></tr></table>
|
|
<table><tr><td><div class="element">Class <b><a href="class95.html#ref95"><b>Hub</b></a></b></div></td></tr></table>
|
|
<table><tr><td><div class="element">Class <b><a href="class96.html#ref96"><b>Projector</b></a></b></div></td></tr></table>
|
|
<table><tr><td><div class="element">Class <b><a href="class97.html#ref97"><b>Mask</b></a></b></div></td></tr></table>
|
|
<table><tr><td><div class="element">Class <b><a href="class98.html#ref98"><b>PluginAdapter</b></a></b></div></td></tr></table>
|
|
<table><tr><td><div class="element">Class <b><a href="class99.html#ref99"><b>OpenGLPipe</b></a></b></div></td></tr></table>
|
|
<table><tr><td><div class="element">Class <b><a href="class100.html#ref100"><b>ARender</b></a></b></div></td></tr></table>
|
|
<table><tr><td><div class="element">Class <b><a href="class101.html#ref101"><b>VRender</b></a></b></div></td></tr></table>
|
|
<table><tr><td><div class="element">Class <b><a href="class102.html#ref102"><b>GLRender</b></a></b></div></td></tr></table>
|
|
<table><tr><td><div class="element">Class <b><a href="class103.html#ref103"><b>Frame</b></a></b></div></td></tr></table>
|
|
<table><tr><td><div class="element">Class <b><a href="class105.html#ref105"><b>AFrame</b></a></b></div></td></tr></table>
|
|
<table><tr><td><div class="element">Class <b><a href="class106.html#ref106"><b>VFrame</b></a></b></div></td></tr></table>
|
|
<table><tr><td><div class="element">Class <b><a href="class107.html#ref107"><b>GLBuf</b></a></b></div></td></tr></table>
|
|
<table><tr><td><div class="element">Class <b><a href="class108.html#ref108"><b>Source</b></a></b></div></td></tr></table>
|
|
</div>
|
|
</div>
|
|
<a name="ref109"></a>
|
|
<h1 class ="package">5 Package CommonLib</h1>
|
|
<a name="ref110"></a>
|
|
<h1 class ="package">6 Package Vault</h1>
|
|
<p>This package is used here just to hold entities thought to belong to the backend layer. The Backend is not in Focus for this Design draft.<br /></p><div class="sub">
|
|
<a name="ref111"></a>
|
|
<h2 class ="view">6.1 Class View Backend Components</h2>
|
|
<div class="sub">
|
|
<table><tr><td><div class="element">Class <b><a href="class112.html#ref112"><b>StreamProvider</b></a></b></div></td></tr></table>
|
|
</div>
|
|
</div>
|
|
<a name="ref115"></a>
|
|
<h1 class ="package">7 Package GUI</h1>
|
|
<p>GUI is here just a container to hold any entities considered to be User Interface related, which is not in focus for this Design draft<br /></p></body>
|
|
</html>
|