345 lines
30 KiB
HTML
345 lines
30 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>cinelerra3
|
|
Documentation</title>
|
|
<link rel="stylesheet" href="style.css" type="text/css" />
|
|
</head>
|
|
|
|
<body bgcolor="#ffffff">
|
|
|
|
<div class = "title">cinelerra3<br />Documentation</div>
|
|
<p></p>
|
|
|
|
<!-- ============================================================= -->
|
|
|
|
<a name="refpackage129"></a>
|
|
<a name="refpackage128005"></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="refcomponent view128005"></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="refcomponent diagram128005"></a>
|
|
<p align="center"><img src="fig128005.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="refcomponent128005"></a>
|
|
<table><tr><td><div class="element">Component <b>Builder</b></div></td></tr></table>
|
|
<a name="refcomponent128133"></a>
|
|
<table><tr><td><div class="element">Component <b>Session</b></div></td></tr></table>
|
|
<div class="sub">
|
|
<a name="refcomponent128389"></a>
|
|
<table><tr><td><div class="element">Component <b>EDL</b></div></td></tr></table>
|
|
<p>nested in <a href="index.html#refcomponent128133"><b>Session</b></a></p>
|
|
<a name="refcomponent128517"></a>
|
|
<table><tr><td><div class="element">Component <b>Fixture</b></div></td></tr></table>
|
|
<p>nested in <a href="index.html#refcomponent128133"><b>Session</b></a></p>
|
|
</div>
|
|
<a name="refcomponent128261"></a>
|
|
<table><tr><td><div class="element">Component <b>Controller</b></div></td></tr></table>
|
|
<p>Depends on <a href="index.html#refcomponent128005"><b>Builder</b></a></p><div class="sub">
|
|
</div>
|
|
<a name="refcomponent128645"></a>
|
|
<table><tr><td><div class="element">Component <b>AssetManagement</b></div></td></tr></table>
|
|
<a name="refcomponent128773"></a>
|
|
<table><tr><td><div class="element">Component <b>Dispatcher</b></div></td></tr></table>
|
|
<a name="refcomponent128901"></a>
|
|
<table><tr><td><div class="element">Component <b>Engine</b></div></td></tr></table>
|
|
<p>Depends on <a href="index.html#refcomponent129029"><b>Frame (Stream) Provider</b></a></p><div class="sub">
|
|
</div>
|
|
<a name="refcomponent129029"></a>
|
|
<table><tr><td><div class="element">Component <b>Frame (Stream) Provider</b></div></td></tr></table>
|
|
<p>Depends on <a href="index.html#refcomponent129157"><b>Cache</b></a></p><div class="sub">
|
|
</div>
|
|
<a name="refcomponent129157"></a>
|
|
<table><tr><td><div class="element">Component <b>Cache</b></div></td></tr></table>
|
|
<a name="refcomponent129285"></a>
|
|
<table><tr><td><div class="element">Component <b>RenderPathManager</b></div></td></tr></table>
|
|
</div>
|
|
<a name="refpackage128645"></a>
|
|
<h2 class ="package">1.2 Package codegen</h2>
|
|
<p>This package is used to organize code generation by BOUML. It is considered useless after having generated the initial code skelleton.<br /></p><div class="sub">
|
|
<a name="refdeployment view128133"></a>
|
|
<h3 class ="view">1.2.1 Deployment View Codegen Deployment</h3>
|
|
</div>
|
|
</div>
|
|
<a name="refpackage129157"></a>
|
|
<h1 class ="package">2 Package BackendLayer</h1>
|
|
<div class="sub">
|
|
<a name="refpackage128517"></a>
|
|
<h2 class ="package">2.1 Package CommonLib</h2>
|
|
<div class="sub">
|
|
<a name="refclass view128645"></a>
|
|
<h3 class ="view">2.1.1 Class View Service Components</h3>
|
|
<div class="sub">
|
|
<table><tr><td><div class="element">Class <b><a href="class134917.html#refclass134917"><b>Time</b></a></b></div></td></tr></table>
|
|
</div>
|
|
</div>
|
|
<a name="refclass view128517"></a>
|
|
<h2 class ="view">2.2 Class View Backend Components</h2>
|
|
<div class="sub">
|
|
<table><tr><td><div class="element">Class <b><a href="class131205.html#refclass131205"><b>FrameProvider</b></a></b></div></td></tr></table>
|
|
</div>
|
|
</div>
|
|
<a name="refpackage129285"></a>
|
|
<h1 class ="package">3 Package ProcessingLayer</h1>
|
|
<div class="sub">
|
|
<a name="refpackage128133"></a>
|
|
<h2 class ="package">3.1 Package AssetManager</h2>
|
|
<a name="refpackage128261"></a>
|
|
<h2 class ="package">3.2 Package MObject</h2>
|
|
<div class="sub">
|
|
<a name="refclass view128005"></a>
|
|
<h3 class ="view">3.2.1 Class View Session</h3>
|
|
<div class="sub">
|
|
<a name="refclass diagram128133"></a>
|
|
<p align="center"><img src="fig128133.png" alt="" /></p>
|
|
<p align="center"><b>Session structure</b></p><p><br /></p><p><br /></p>
|
|
<a name="refobject diagram128773"></a>
|
|
<p align="center"><img src="fig128773.png" alt="" /></p>
|
|
<p align="center"><b>EDL Example1</b></p><p><br /></p><p><br /></p>
|
|
<p>A simple example showing how the actual objects are placed in the Fixture (=definitive playlist). It shows a Video and Audio clip placed on two tracks<br /></p><a name="refobject diagram128901"></a>
|
|
<p align="center"><img src="fig128901.png" alt="" /></p>
|
|
<p align="center"><b>EDL Example2</b></p><p><br /></p><p><br /></p>
|
|
<p>More complex example showing the Object graph in the EDL and how it is linked into the Fixture to yield the actual locations. In this example, an HUE Effect is applied on a part of the Clip<br /></p><table><tr><td><div class="element">Class <b><a href="class128005.html#refclass128005"><b>Session</b></a></b></div></td></tr></table>
|
|
<table><tr><td><div class="element">Class <b><a href="class128133.html#refclass128133"><b>EDL</b></a></b></div></td></tr></table>
|
|
<table><tr><td><div class="element">Class <b><a href="class128261.html#refclass128261"><b>Fixture</b></a></b></div></td></tr></table>
|
|
<table><tr><td><div class="element">Class <b><a href="class128389.html#refclass128389"><b>Track</b></a></b></div></td></tr></table>
|
|
<table><tr><td><div class="element">Class <b><a href="class128517.html#refclass128517"><b>MObject</b></a></b></div></td></tr></table>
|
|
<table><tr><td><div class="element">Class <b><a href="class128645.html#refclass128645"><b>Placement</b></a></b></div></td></tr></table>
|
|
<table><tr><td><div class="element">Class <b><a href="class128773.html#refclass128773"><b>AbstractMO</b></a></b></div></td></tr></table>
|
|
<table><tr><td><div class="element">Class <b><a href="class128901.html#refclass128901"><b>Clip</b></a></b></div></td></tr></table>
|
|
<table><tr><td><div class="element">Class <b><a href="class129029.html#refclass129029"><b>Effect</b></a></b></div></td></tr></table>
|
|
<table><tr><td><div class="element">Class <b><a href="class129157.html#refclass129157"><b>Meta</b></a></b></div></td></tr></table>
|
|
<table><tr><td><div class="element">Class <b><a href="class129285.html#refclass129285"><b>DirectPlacement</b></a></b></div></td></tr></table>
|
|
<table><tr><td><div class="element">Class <b><a href="class129413.html#refclass129413"><b>RelativePlacement</b></a></b></div></td></tr></table>
|
|
<table><tr><td><div class="element">Class <b><a href="class129541.html#refclass129541"><b>Allocation</b></a></b></div></td></tr></table>
|
|
<table><tr><td><div class="element">Class <b><a href="class129669.html#refclass129669"><b>Label</b></a></b></div></td></tr></table>
|
|
<table><tr><td><div class="element">Class <b><a href="class129797.html#refclass129797"><b>ExplicitPlacement</b></a></b></div></td></tr></table>
|
|
<table><tr><td><div class="element">Class <b><a href="class129925.html#refclass129925"><b>Auto</b></a></b></div></td></tr></table>
|
|
<table><tr><td><div class="element">Class <b><a href="class130053.html#refclass130053"><b>Wish</b></a></b></div></td></tr></table>
|
|
<table><tr><td><div class="element">Class <b><a href="class130181.html#refclass130181"><b>Constraint</b></a></b></div></td></tr></table>
|
|
</div>
|
|
<a name="refpackage128901"></a>
|
|
<h3 class ="package">3.2.2 Package Builder</h3>
|
|
<div class="sub">
|
|
<a name="refclass view128261"></a>
|
|
<h4 class ="view">3.2.2.1 Class View Builder Workings</h4>
|
|
<div class="sub">
|
|
<a name="refcollaboration diagram128517"></a>
|
|
<p align="center"><img src="fig128517.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><a name="refactivity128005"></a>
|
|
<h4 class ="activity">3.2.2.1.1 Activity building the Engine</h4>
|
|
<p>Pre Condition :</p><ul></ul><p>Post Condition :</p><ul></ul><div class="sub">
|
|
<a name="refactivity diagram129413"></a>
|
|
<p align="center"><img src="fig129413.png" alt="" /></p>
|
|
<p align="center"><b>build flow</b></p><p><br /></p><p><br /></p>
|
|
<a name="refactivity parameter128645"></a>
|
|
<table><tr><td><div class="element">Activity action pin <b>build Request</b></div></td></tr></table>
|
|
<p>Direction : input</p><p>Type : </p><p>Selection :</p><ul></ul><div class="sub">
|
|
<table><tr><td><div class="element">Flow <b><flow></div></td></tr></table><p>From <a href="index.html#refactivity parameter128645"><b>build Request</b></a> To <a href="index.html#refopaque activity action128645"><b>configure Tools</b></a></p><p>Weight :</p><ul></ul><p>Guard :</p><ul></ul><p>Selection :</p><ul></ul><p>Transformation :</p><ul></ul></div>
|
|
<a name="refopaque activity action128645"></a>
|
|
<table><tr><td><div class="element">Opaque activity action <b>configure Tools</b></div></td></tr></table>
|
|
<p>Defined in <a href="index.html#refactivity128005"><b>building the Engine</b></a></p><p>Pre Condition :</p><ul></ul><p>Post Condition :</p><ul></ul><p>Behavior :</p><ul></ul><div class="sub">
|
|
<table><tr><td><div class="element">Flow <b><flow></div></td></tr></table><p>From <a href="index.html#refopaque activity action128645"><b>configure Tools</b></a> To <a href="index.html#reffork activity node129029"><b>fork activity node</b></a></p><p>Weight :</p><ul></ul><p>Guard :</p><ul></ul><p>Selection :</p><ul></ul><p>Transformation :</p><ul></ul></div>
|
|
<a name="refexpansion region128133"></a>
|
|
<h4 class ="expansionregion">3.2.2.1.1.1 Expansion region establish partitioning</h4>
|
|
<div class="sub">
|
|
<a name="refopaque activity action128773"></a>
|
|
<table><tr><td><div class="element">Opaque activity action <b>define segment</b></div></td></tr></table>
|
|
<p>Defined in <a href="index.html#refexpansion region128133"><b>establish partitioning</b></a></p><p>Pre Condition :</p><ul></ul><p>Post Condition :</p><ul></ul><p>Behavior :</p><ul></ul><div class="sub">
|
|
<a name="refactivity action pin128133"></a>
|
|
<table><tr><td><div class="element">Activity action pin <b>inFixture</b></div></td></tr></table>
|
|
<p>Direction : input</p><p>Type : </p><p>Selection :</p><ul></ul><table><tr><td><div class="element">Flow <b><flow></div></td></tr></table><p>From <a href="index.html#refopaque activity action128773"><b>define segment</b></a> To <a href="index.html#refactivity object128133"><b>segments</b></a></p><p>Weight :</p><ul></ul><p>Guard :</p><ul></ul><p>Selection :</p><ul></ul><p>Transformation :</p><ul></ul></div>
|
|
<a name="refactivity object128005"></a>
|
|
<table><tr><td><div class="element">Activity object <b>segment Tool</b></div></td></tr></table>
|
|
<p>Type : </p><p>Selection :</p><ul></ul><p>Is control type</p>
|
|
<div class="sub">
|
|
<table><tr><td><div class="element">Flow <b><flow></div></td></tr></table><p>From <a href="index.html#refactivity object128005"><b>segment Tool</b></a> To <a href="index.html#refopaque activity action128773"><b>define segment</b></a></p><p>Weight :</p><ul></ul><p>Guard :</p><ul></ul><p>Selection :</p><ul></ul><p>Transformation :</p><ul></ul></div>
|
|
<a name="refactivity object128133"></a>
|
|
<table><tr><td><div class="element">Activity object <b>segments</b></div></td></tr></table>
|
|
<p>Type : </p><p>Selection :</p><ul></ul><p>Is control type</p>
|
|
</div>
|
|
<a name="refactivity object128005"></a>
|
|
<table><tr><td><div class="element">Activity object <b>Fixture</b></div></td></tr></table>
|
|
<p>Type : </p><p>Selection :</p><ul></ul><div class="sub">
|
|
<table><tr><td><div class="element">Flow <b><flow></div></td></tr></table><p>From <a href="index.html#refactivity object128005"><b>Fixture</b></a> To <a href="index.html#refactivity action pin128133"><b>inFixture</b></a></p><p>Weight :</p><ul></ul><p>Guard :</p><ul></ul><p>Selection :</p><ul></ul><p>Transformation :</p><ul></ul><table><tr><td><div class="element">Flow <b><flow></div></td></tr></table><p>From <a href="index.html#refactivity object128005"><b>Fixture</b></a> To <a href="index.html#refactivity action pin128133"><b>inFixture</b></a></p><p>Weight :</p><ul></ul><p>Guard :</p><ul></ul><p>Selection :</p><ul></ul><p>Transformation :</p><ul></ul></div>
|
|
<a name="reffork activity node129029"></a>
|
|
<a name="reffork activity node129029"></a>
|
|
<table><tr><td><div class="element">Fork activity node <b></b></div></td></tr></table>
|
|
<p>Defined in <a href="index.html#refactivity128005"><b>building the Engine</b></a></p><div class="sub">
|
|
<table><tr><td><div class="element">Flow <b><flow></div></td></tr></table><p>From <a href="index.html#reffork activity node129029"><b>fork activity node</b></a> To <a href="index.html#refactivity object128005"><b>segment Tool</b></a></p><p>Weight :</p><ul></ul><p>Guard :</p><ul></ul><p>Selection :</p><ul></ul><p>Transformation :</p><ul></ul><table><tr><td><div class="element">Flow <b><flow></div></td></tr></table><p>From <a href="index.html#reffork activity node129029"><b>fork activity node</b></a> To <a href="index.html#refactivity object128261"><b>build Tool</b></a></p><p>Weight :</p><ul></ul><p>Guard :</p><ul></ul><p>Selection :</p><ul></ul><p>Transformation :</p><ul></ul></div>
|
|
<a name="refexpansion region128261"></a>
|
|
<h4 class ="expansionregion">3.2.2.1.1.2 Expansion region build Processors</h4>
|
|
<div class="sub">
|
|
<a name="refactivity object128261"></a>
|
|
<table><tr><td><div class="element">Activity object <b>build Tool</b></div></td></tr></table>
|
|
<p>Type : </p><p>Selection :</p><ul></ul><p>Is control type</p>
|
|
<div class="sub">
|
|
<table><tr><td><div class="element">Flow <b><flow></div></td></tr></table><p>From <a href="index.html#refactivity object128261"><b>build Tool</b></a> To <a href="index.html#refopaque activity action128901"><b>create ProcNode</b></a></p><p>Weight :</p><ul></ul><p>Guard :</p><ul></ul><p>Selection :</p><ul></ul><p>Transformation :</p><ul></ul></div>
|
|
<a name="refactivity object128389"></a>
|
|
<table><tr><td><div class="element">Activity object <b>segments</b></div></td></tr></table>
|
|
<p>Type : </p><p>Selection :</p><ul></ul><p>Is control type</p>
|
|
<div class="sub">
|
|
<table><tr><td><div class="element">Flow <b><flow></div></td></tr></table><p>From <a href="index.html#refactivity object128389"><b>segments</b></a> To <a href="index.html#refopaque activity action128901"><b>create ProcNode</b></a></p><p>Weight :</p><ul></ul><p>Guard :</p><ul></ul><p>Selection :</p><ul></ul><p>Transformation :</p><ul></ul></div>
|
|
<a name="refopaque activity action128901"></a>
|
|
<table><tr><td><div class="element">Opaque activity action <b>create ProcNode</b></div></td></tr></table>
|
|
<p>Defined in <a href="index.html#refexpansion region128261"><b>build Processors</b></a></p><p>Pre Condition :</p><ul></ul><p>Post Condition :</p><ul></ul><p>Behavior :</p><ul></ul><div class="sub">
|
|
<table><tr><td><div class="element">Flow <b><flow></div></td></tr></table><p>From <a href="index.html#refopaque activity action128901"><b>create ProcNode</b></a> To <a href="index.html#refopaque activity action129029"><b>connect</b></a></p><p>Weight :</p><ul></ul><p>Guard :</p><ul></ul><p>Selection :</p><ul></ul><p>Transformation :</p><ul></ul></div>
|
|
<a name="refopaque activity action129029"></a>
|
|
<table><tr><td><div class="element">Opaque activity action <b>connect</b></div></td></tr></table>
|
|
<p>Defined in <a href="index.html#refexpansion region128261"><b>build Processors</b></a></p><p>Pre Condition :</p><ul></ul><p>Post Condition :</p><ul></ul><p>Behavior :</p><ul></ul><div class="sub">
|
|
<table><tr><td><div class="element">Flow <b><flow></div></td></tr></table><p>From <a href="index.html#refopaque activity action129029"><b>connect</b></a> To <a href="index.html#refactivity object128517"><b>complete Render Engine</b></a></p><p>Weight :</p><ul></ul><p>Guard :</p><ul></ul><p>Selection :</p><ul></ul><p>Transformation :</p><ul></ul></div>
|
|
<a name="refactivity object128517"></a>
|
|
<table><tr><td><div class="element">Activity object <b>complete Render Engine</b></div></td></tr></table>
|
|
<p>Type : </p><p>Selection :</p><ul></ul><p>Is control type</p>
|
|
<div class="sub">
|
|
<table><tr><td><div class="element">Flow <b><flow></div></td></tr></table><p>From <a href="index.html#refactivity object128517"><b>complete Render Engine</b></a> To <a href="index.html#refactivity final129157"><b>activity final</b></a></p><p>Weight :</p><ul></ul><p>Guard :</p><ul></ul><p>Selection :</p><ul></ul><p>Transformation :</p><ul></ul></div>
|
|
</div>
|
|
<a name="refactivity final129157"></a>
|
|
<a name="refactivity final129157"></a>
|
|
<table><tr><td><div class="element">Activity final <b></b></div></td></tr></table>
|
|
<p>Defined in <a href="index.html#refactivity128005"><b>building the Engine</b></a></p></div>
|
|
<a name="refclass diagram129285"></a>
|
|
<p align="center"><img src="fig129285.png" alt="" /></p>
|
|
<p align="center"><b>Builder Entities</b></p><p><br /></p><p><br /></p>
|
|
<table><tr><td><div class="element">Class <b><a href="class130565.html#refclass130565"><b>BuilderFacade</b></a></b></div></td></tr></table>
|
|
<table><tr><td><div class="element">Class <b><a href="class130693.html#refclass130693"><b>ToolFactory</b></a></b></div></td></tr></table>
|
|
<table><tr><td><div class="element">Class <b><a href="class130821.html#refclass130821"><b>ConManager</b></a></b></div></td></tr></table>
|
|
<table><tr><td><div class="element">Class <b><a href="class131077.html#refclass131077"><b>Assembler</b></a></b></div></td></tr></table>
|
|
<table><tr><td><div class="element">Class <b><a href="class132741.html#refclass132741"><b>StateProxy</b></a></b></div></td></tr></table>
|
|
<table><tr><td><div class="element">Class <b><a href="class134021.html#refclass134021"><b>Buildable</b></a></b></div></td></tr></table>
|
|
<table><tr><td><div class="element">Class <b><a href="class134149.html#refclass134149"><b>Tool</b></a></b></div></td></tr></table>
|
|
<table><tr><td><div class="element">Class <b><a href="class134277.html#refclass134277"><b>SegmentationTool</b></a></b></div></td></tr></table>
|
|
<table><tr><td><div class="element">Class <b><a href="class134405.html#refclass134405"><b>NodeCreatorTool</b></a></b></div></td></tr></table>
|
|
</div>
|
|
</div>
|
|
<a name="refpackage129029"></a>
|
|
<h3 class ="package">3.2.3 Package Controller</h3>
|
|
<div class="sub">
|
|
<a name="refclass view128389"></a>
|
|
<h4 class ="view">3.2.3.1 Class View Controller Workings</h4>
|
|
<div class="sub">
|
|
<a name="refclass diagram128645"></a>
|
|
<p align="center"><img src="fig128645.png" alt="" /></p>
|
|
<p align="center"><b>Controller Entities</b></p><p><br /></p><p><br /></p>
|
|
<a name="refactivity128133"></a>
|
|
<h4 class ="activity">3.2.3.1.1 Activity configure Render</h4>
|
|
<p>Pre Condition :</p><ul></ul><p>Post Condition :</p><ul></ul><div class="sub">
|
|
<a name="refactivity diagram129541"></a>
|
|
<p align="center"><img src="fig129541.png" alt="" /></p>
|
|
<p align="center"><b>the render configuration flow</b></p><p><br /></p><p><br /></p>
|
|
<a name="refactivity parameter128005"></a>
|
|
<table><tr><td><div class="element">Activity action pin <b>Render Request</b></div></td></tr></table>
|
|
<p>Direction : input</p><p>Type : </p><p>Selection :</p><ul></ul><div class="sub">
|
|
<table><tr><td><div class="element">Flow <b><flow></div></td></tr></table><p>From <a href="index.html#refactivity parameter128005"><b>Render Request</b></a> To <a href="index.html#refopaque activity action128389"><b>determine Render Params</b></a></p><p>Weight :</p><ul></ul><p>Guard :</p><ul></ul><p>Selection :</p><ul></ul><p>Transformation :</p><ul></ul></div>
|
|
<a name="refopaque activity action128133"></a>
|
|
<table><tr><td><div class="element">Opaque activity action <b>setup StateProxy</b></div></td></tr></table>
|
|
<p>Defined in <a href="index.html#refactivity128133"><b>configure Render</b></a></p><p>Pre Condition :</p><ul></ul><p>Post Condition :</p><ul></ul><p>Behavior :</p><ul></ul><div class="sub">
|
|
<table><tr><td><div class="element">Flow <b><flow></div></td></tr></table><p>From <a href="index.html#refopaque activity action128133"><b>setup StateProxy</b></a> To <a href="index.html#refdecision activity node128389"><b>build necessary?</b></a></p><p>Weight :</p><ul></ul><p>Guard :</p><ul></ul><p>Selection :</p><ul></ul><p>Transformation :</p><ul></ul></div>
|
|
<a name="refdecision activity node128389"></a>
|
|
<a name="refdecision activity node128389"></a>
|
|
<table><tr><td><div class="element">Decision activity node <b>build necessary?</b></div></td></tr></table>
|
|
<p>Defined in <a href="index.html#refactivity128133"><b>configure Render</b></a></p><div class="sub">
|
|
<table><tr><td><div class="element">Flow <b><flow></div></td></tr></table><p>From <a href="index.html#refdecision activity node128389"><b>build necessary?</b></a> To <a href="index.html#refopaque activity action128517"><b>build Render Engine</b></a></p><p>Weight :</p><ul></ul><p>Guard :</p><ul><li>OCL : <pre>
|
|
build necessary</pre></li></ul><p>Selection :</p><ul></ul><p>Transformation :</p><ul></ul><table><tr><td><div class="element">Flow <b><flow></div></td></tr></table><p>From <a href="index.html#refdecision activity node128389"><b>build necessary?</b></a> To <a href="index.html#refmerge activity node128773"><b>merge activity node</b></a></p><p>Weight :</p><ul></ul><p>Guard :</p><ul><li>OCL : <pre>
|
|
reuse exiting Engine</pre></li></ul><p>Selection :</p><ul></ul><p>Transformation :</p><ul></ul></div>
|
|
<a name="refopaque activity action128005"></a>
|
|
<table><tr><td><div class="element">Opaque activity action <b>setup Build Params</b></div></td></tr></table>
|
|
<p>Defined in <a href="index.html#refactivity128133"><b>configure Render</b></a></p><p>Pre Condition :</p><ul></ul><p>Post Condition :</p><ul></ul><p>Behavior :</p><ul></ul><a name="refmerge activity node128773"></a>
|
|
<a name="refmerge activity node128773"></a>
|
|
<table><tr><td><div class="element">Merge activity node <b></b></div></td></tr></table>
|
|
<p>Defined in <a href="index.html#refactivity128133"><b>configure Render</b></a></p><div class="sub">
|
|
<table><tr><td><div class="element">Flow <b><flow></div></td></tr></table><p>From <a href="index.html#refmerge activity node128773"><b>merge activity node</b></a> To <a href="index.html#refactivity final128901"><b>activity final</b></a></p><p>Weight :</p><ul></ul><p>Guard :</p><ul></ul><p>Selection :</p><ul></ul><p>Transformation :</p><ul></ul></div>
|
|
<a name="refexpansion region128005"></a>
|
|
<h4 class ="expansionregion">3.2.3.1.1.1 Expansion region determine Render Params</h4>
|
|
<a name="refopaque activity action128389"></a>
|
|
<table><tr><td><div class="element">Opaque activity action <b>determine Render Params</b></div></td></tr></table>
|
|
<p>Diagram : <a href="index.html#refactivity diagram129541"><b>the render configuration flow</b></a></p>
|
|
<p>Defined in <a href="index.html#refactivity128133"><b>configure Render</b></a></p><p>Pre Condition :</p><ul></ul><p>Post Condition :</p><ul></ul><p>Behavior :</p><ul></ul><div class="sub">
|
|
<table><tr><td><div class="element">Flow <b><flow></div></td></tr></table><p>From <a href="index.html#refopaque activity action128389"><b>determine Render Params</b></a> To <a href="index.html#refopaque activity action128133"><b>setup StateProxy</b></a></p><p>Weight :</p><ul></ul><p>Guard :</p><ul></ul><p>Selection :</p><ul></ul><p>Transformation :</p><ul></ul></div>
|
|
<a name="refopaque activity action128517"></a>
|
|
<table><tr><td><div class="element">Opaque activity action <b>build Render Engine</b></div></td></tr></table>
|
|
<p>Defined in <a href="index.html#refactivity128133"><b>configure Render</b></a></p><p>Pre Condition :</p><ul></ul><p>Post Condition :</p><ul></ul><p>Behavior :</p><ul></ul><div class="sub">
|
|
<table><tr><td><div class="element">Flow <b><flow></div></td></tr></table><p>From <a href="index.html#refopaque activity action128517"><b>build Render Engine</b></a> To <a href="index.html#refmerge activity node128773"><b>merge activity node</b></a></p><p>Weight :</p><ul></ul><p>Guard :</p><ul></ul><p>Selection :</p><ul></ul><p>Transformation :</p><ul></ul></div>
|
|
<a name="refactivity final128901"></a>
|
|
<a name="refactivity final128901"></a>
|
|
<table><tr><td><div class="element">Activity final <b></b></div></td></tr></table>
|
|
<p>Defined in <a href="index.html#refactivity128133"><b>configure Render</b></a></p></div>
|
|
<table><tr><td><div class="element">Class <b><a href="class130309.html#refclass130309"><b>ControllerFacade</b></a></b></div></td></tr></table>
|
|
<table><tr><td><div class="element">Class <b><a href="class130437.html#refclass130437"><b>PathManager</b></a></b></div></td></tr></table>
|
|
<table><tr><td><div class="element">Class <b><a href="class130949.html#refclass130949"><b>RenderState</b></a></b></div></td></tr></table>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<a name="refpackage128389"></a>
|
|
<h2 class ="package">3.3 Package RenderEngine</h2>
|
|
<div class="sub">
|
|
<a name="refdeployment view128005"></a>
|
|
<h3 class ="view">3.3.1 Deployment View Engine Parts</h3>
|
|
<div class="sub">
|
|
<a name="refdeployment diagram128261"></a>
|
|
<p align="center"><img src="fig128261.png" alt="" /></p>
|
|
<p align="center"><b>Overview Render Engine</b></p><p><br /></p><p><br /></p>
|
|
<a name="refnode128005"></a>
|
|
<table><tr><td><div class="element">Node <b>timeline</b></div></td></tr></table>
|
|
<a name="refnode128261"></a>
|
|
<table><tr><td><div class="element">Node <b>playlist</b></div></td></tr></table>
|
|
<a name="refnode128389"></a>
|
|
<table><tr><td><div class="element">Node <b>proc</b></div></td></tr></table>
|
|
<a name="refnode128517"></a>
|
|
<table><tr><td><div class="element">Node <b>pnode</b></div></td></tr></table>
|
|
<a name="refnode128645"></a>
|
|
<table><tr><td><div class="element">Node <b>Frame</b></div></td></tr></table>
|
|
<a name="refnode128773"></a>
|
|
<table><tr><td><div class="element">Node <b>State</b></div></td></tr></table>
|
|
</div>
|
|
<a name="refclass view128133"></a>
|
|
<h3 class ="view">3.3.2 Class View Engine Workings</h3>
|
|
<div class="sub">
|
|
<a name="refclass diagram128389"></a>
|
|
<p align="center"><img src="fig128389.png" alt="" /></p>
|
|
<p align="center"><b>Render Entities</b></p><p><br /></p><p><br /></p>
|
|
<a name="refobject diagram129029"></a>
|
|
<p align="center"><img src="fig129029.png" alt="" /></p>
|
|
<p align="center"><b>Engine Example1</b></p><p><br /></p><p><br /></p>
|
|
<p>Example1 (from EDL) continued: here the RenderEngine to be created by the Builder from the Input shown in Example1<br /></p><a name="refobject diagram129157"></a>
|
|
<p align="center"><img src="fig129157.png" alt="" /></p>
|
|
<p align="center"><b>Engine Example2</b></p><p><br /></p><p><br /></p>
|
|
<p>Example2 (from EDL) continued: notably in this RenderEngine the Effect has been partitioned into 2 segments with constant configuration.<br /></p><a name="refclass diagram129669"></a>
|
|
<p align="center"><img src="fig129669.png" alt="" /></p>
|
|
<p align="center"><b>Automation Entities</b></p><p><br /></p><p><br /></p>
|
|
<table><tr><td><div class="element">Class <b><a href="class131333.html#refclass131333"><b>RenderEngine</b></a></b></div></td></tr></table>
|
|
<table><tr><td><div class="element">Class <b><a href="class131461.html#refclass131461"><b>Processor</b></a></b></div></td></tr></table>
|
|
<table><tr><td><div class="element">Class <b><a href="class131589.html#refclass131589"><b>ExitNode</b></a></b></div></td></tr></table>
|
|
<table><tr><td><div class="element">Class <b><a href="class131717.html#refclass131717"><b>ProcNode</b></a></b></div></td></tr></table>
|
|
<table><tr><td><div class="element">Class <b><a href="class131845.html#refclass131845"><b>Trafo</b></a></b></div></td></tr></table>
|
|
<table><tr><td><div class="element">Class <b><a href="class131973.html#refclass131973"><b>Link</b></a></b></div></td></tr></table>
|
|
<table><tr><td><div class="element">Class <b><a href="class132101.html#refclass132101"><b>Hub</b></a></b></div></td></tr></table>
|
|
<table><tr><td><div class="element">Class <b><a href="class132229.html#refclass132229"><b>Projector</b></a></b></div></td></tr></table>
|
|
<table><tr><td><div class="element">Class <b><a href="class132357.html#refclass132357"><b>Mask</b></a></b></div></td></tr></table>
|
|
<table><tr><td><div class="element">Class <b><a href="class132485.html#refclass132485"><b>PluginAdapter</b></a></b></div></td></tr></table>
|
|
<table><tr><td><div class="element">Class <b><a href="class132613.html#refclass132613"><b>OpenGLPipe</b></a></b></div></td></tr></table>
|
|
<table><tr><td><div class="element">Class <b><a href="class132869.html#refclass132869"><b>ARender</b></a></b></div></td></tr></table>
|
|
<table><tr><td><div class="element">Class <b><a href="class132997.html#refclass132997"><b>VRender</b></a></b></div></td></tr></table>
|
|
<table><tr><td><div class="element">Class <b><a href="class133125.html#refclass133125"><b>GLRender</b></a></b></div></td></tr></table>
|
|
<table><tr><td><div class="element">Class <b><a href="class133253.html#refclass133253"><b>Frame</b></a></b></div></td></tr></table>
|
|
<table><tr><td><div class="element">Class <b><a href="class133381.html#refclass133381"><b>AFrame</b></a></b></div></td></tr></table>
|
|
<table><tr><td><div class="element">Class <b><a href="class133509.html#refclass133509"><b>VFrame</b></a></b></div></td></tr></table>
|
|
<table><tr><td><div class="element">Class <b><a href="class133637.html#refclass133637"><b>GLBuf</b></a></b></div></td></tr></table>
|
|
<table><tr><td><div class="element">Class <b><a href="class133765.html#refclass133765"><b>Source</b></a></b></div></td></tr></table>
|
|
<table><tr><td><div class="element">Class <b><a href="class134533.html#refclass134533"><b>Parameter</b></a></b></div></td></tr></table>
|
|
<table><tr><td><div class="element">Class <b><a href="class134661.html#refclass134661"><b>ParamProvider</b></a></b></div></td></tr></table>
|
|
<table><tr><td><div class="element">Class <b><a href="class134789.html#refclass134789"><b>Interpolator</b></a></b></div></td></tr></table>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<a name="refpackage128773"></a>
|
|
<h1 class ="package">4 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>
|