remove generated UML report. Diagrams and TiddlyWikiy are sufficient
Up to now we commited the Bouml generated HTML report of the UML model While the UML is still valid and will be kept up-to date in future, meanwhile the Bouml generated diagrams (png) will be sufficient, as being linked in and explained within the TiddlyWiki.
This commit is contained in:
parent
0844f05ef2
commit
1081e9fe8c
261 changed files with 0 additions and 9264 deletions
|
|
@ -1,24 +0,0 @@
|
|||
<!-- 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>Activities Index</title>
|
||||
<link rel="stylesheet" href="style.css" type="text/css" />
|
||||
</head>
|
||||
|
||||
<body bgcolor="#ffffff">
|
||||
|
||||
<div class = "title">Activities Index</div>
|
||||
<p></p>
|
||||
|
||||
<!-- ============================================================= -->
|
||||
|
||||
<table>
|
||||
<tr bgcolor=#f0f0f0><td><a href="index.html#refactivity128005" target = "projectFrame"><b>building the Engine</b></a></td><td></td><td></td></tr>
|
||||
<tr bgcolor=#f0f0f0><td><a href="index.html#refactivity128133" target = "projectFrame"><b>configure Render</b></a></td><td></td><td></td></tr>
|
||||
<tr bgcolor=#f0f0f0><td><a href="index.html#refactivity128010" target = "projectFrame"><b>get frame</b></a></td><td></td><td></td></tr>
|
||||
</table>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,23 +0,0 @@
|
|||
<!-- 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>Activity Diagram Index</title>
|
||||
<link rel="stylesheet" href="style.css" type="text/css" />
|
||||
</head>
|
||||
|
||||
<body bgcolor="#ffffff">
|
||||
|
||||
<div class = "title">Activity Diagram Index</div>
|
||||
<p></p>
|
||||
|
||||
<!-- ============================================================= -->
|
||||
|
||||
<table>
|
||||
<tr bgcolor=#f0f0f0><td><a href="index.html#refactivity diagram129413" target = "projectFrame"><b>build flow</b></a></td><td></td><td></td></tr>
|
||||
<tr bgcolor=#f0f0f0><td><a href="index.html#refactivity diagram129541" target = "projectFrame"><b>the render configuration flow</b></a></td><td></td><td></td></tr>
|
||||
</table>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,28 +0,0 @@
|
|||
<!-- 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>Class SessionImpl</title>
|
||||
<link rel="stylesheet" href="style.css" type="text/css" />
|
||||
</head>
|
||||
|
||||
<body bgcolor="#ffffff">
|
||||
|
||||
<div class = "title">Class SessionImpl</div>
|
||||
<p></p>
|
||||
|
||||
<!-- ============================================================= -->
|
||||
|
||||
<a name="refclass128005"></a>
|
||||
<p>Implementation class for the Session interface<br /></p><p>Declaration :</p><ul><li>C++ : class SessionImpl : public <a href="class139653.html#refclass139653"><b>Session</b></a> </li></ul><p>Artifact : <a href="index.html#refartifact128517"><b>sessionimpl</b></a>, Component(s) : <a href="index.html#refcomponent128133"><b>Session</b></a></p><div class="sub">
|
||||
<a name="refrelation128005"></a>
|
||||
<table><tr><td><div class="element">Relation <b>sequences (<directional composition>)</b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : # sequences : <a href="class128133.html#refclass128133"><b>Seq</b></a>, multiplicity : 1..*</li><li>C++ : protected: <<a href="class128133.html#refclass128133"><b>Seq</b></a>> sequences</li></ul><a name="refrelation128261"></a>
|
||||
<table><tr><td><div class="element">Relation <b>theFixture (<unidirectional association>)</b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : # theFixture : <a href="class128261.html#refclass128261"><b>Fixture</b></a>, multiplicity : 1</li><li>C++ : protected: <a href="class128261.html#refclass128261"><b>Fixture</b></a> * theFixture</li></ul><a name="refrelation147717"></a>
|
||||
<table><tr><td><div class="element">Relation <b>pipes (<directional aggregation>)</b></div></td></tr></table><p>the global ports (busses) of the session<br /></p><p>Declaration :</p><ul><li>Uml : # pipes : <a href="class138117.html#refclass138117"><b>Pipe</b></a>, multiplicity : *</li><li>C++ : protected: <a href="class138117.html#refclass138117"><b>Pipe</b></a>* pipes</li></ul><p>Stereotype: vector</p>
|
||||
<a name="refrelation195205"></a>
|
||||
<table><tr><td><div class="element">Relation <b>timelines (<directional composition>)</b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : # timelines : <a href="class145541.html#refclass145541"><b>Timeline</b></a></li><li>C++ : protected: <a href="class145541.html#refclass145541"><b>Timeline</b></a> timelines</li></ul></div>
|
||||
<p>All public operations : <a href="class139653.html#refoperation133637"><b>getFixture</b></a> </p>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,26 +0,0 @@
|
|||
<!-- 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>Class Seq</title>
|
||||
<link rel="stylesheet" href="style.css" type="text/css" />
|
||||
</head>
|
||||
|
||||
<body bgcolor="#ffffff">
|
||||
|
||||
<div class = "title">Class Seq</div>
|
||||
<p></p>
|
||||
|
||||
<!-- ============================================================= -->
|
||||
|
||||
<a name="refclass128133"></a>
|
||||
<p>Declaration :</p><ul><li>C++ : class Seq </li></ul><p>Directly inherited by : <a href="class128261.html#refclass128261"><b>Fixture</b></a> </p>
|
||||
<p>Artifact : <a href="index.html#refartifact128645"><b>edl</b></a>, Component(s) : <a href="index.html#refcomponent128133"><b>Session</b></a></p><div class="sub">
|
||||
<a name="refrelation128901"></a>
|
||||
<table><tr><td><div class="element">Relation <b>clips (<directional aggregation>)</b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : # clips : <a href="class128517.html#refclass128517"><b>MObject</b></a>, multiplicity : *</li><li>C++ : protected: list<<a href="class128517.html#refclass128517"><b>MObject</b></a> *> clips</li></ul><p>Stereotype: list</p>
|
||||
<a name="refrelation147333"></a>
|
||||
<table><tr><td><div class="element">Relation <b>track (<unidirectional association>)</b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : # track : <a href="class128389.html#refclass128389"><b>Track</b></a></li><li>C++ : protected: <a href="class128389.html#refclass128389"><b>Track</b></a>* track</li></ul></div>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,20 +0,0 @@
|
|||
<!-- 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>Class Thread</title>
|
||||
<link rel="stylesheet" href="style.css" type="text/css" />
|
||||
</head>
|
||||
|
||||
<body bgcolor="#ffffff">
|
||||
|
||||
<div class = "title">Class Thread</div>
|
||||
<p></p>
|
||||
|
||||
<!-- ============================================================= -->
|
||||
|
||||
<a name="refclass128138"></a>
|
||||
<p>We can basically reuse the Thread class design from Cinelerra2, Thread becomes a baseclass for all Threads <br /></p><p>Declaration :</p><ul><li>C++ : class Thread </li></ul></body>
|
||||
</html>
|
||||
|
|
@ -1,28 +0,0 @@
|
|||
<!-- 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>Class File</title>
|
||||
<link rel="stylesheet" href="style.css" type="text/css" />
|
||||
</head>
|
||||
|
||||
<body bgcolor="#ffffff">
|
||||
|
||||
<div class = "title">Class File</div>
|
||||
<p></p>
|
||||
|
||||
<!-- ============================================================= -->
|
||||
|
||||
<a name="refclass128181"></a>
|
||||
<p>Declaration :</p><ul><li>C++ : class File </li></ul><div class="sub">
|
||||
<a name="refrelation128437"></a>
|
||||
<table><tr><td><div class="element">Relation <b>descriptor (descriptor)</b></div></td></tr></table><p>type of this frame<br /></p><p>Declaration :</p><ul><li>Uml : # descriptor : <a href="class128693.html#refclass128693"><b>FileHandle</b></a></li><li>C++ : protected: <a href="class128693.html#refclass128693"><b>FileHandle</b></a> * descriptor</li></ul><a name="refoperation128181"></a>
|
||||
<table><tr><td><div class="element">Operation <b>getFrame</b></div></td></tr></table><p>mode = READ, WRITE, ...<br /></p><p>Declaration :</p><ul><li>Uml : + getFrame(in : <a href="class128949.html#refclass128949"><b>FrameDescriptor</b></a>, in frame_address : , in mode : ) : <a href="class128821.html#refclass128821"><b>Frame</b></a></li><li>C++ : public: <a href="class128821.html#refclass128821"><b>Frame</b></a> getFrame()</li></ul><a name="refrelation128225"></a>
|
||||
<table><tr><td><div class="element">Relation <b>handle (<directional aggregation>)</b></div></td></tr></table><p>weak pointer<br /></p><p>Declaration :</p><ul><li>Uml : # handle : <a href="class128693.html#refclass128693"><b>FileHandle</b></a>, multiplicity : 0..1</li><li>C++ : protected: <a href="class128693.html#refclass128693"><b>FileHandle</b></a> * handle</li></ul><a name="refrelation128609"></a>
|
||||
<table><tr><td><div class="element">Relation <b>mappings (<directional aggregation>)</b></div></td></tr></table><p>weak pointers<br /></p><p>Declaration :</p><ul><li>Uml : # mappings : <a href="class128565.html#refclass128565"><b>FileMap</b></a>, multiplicity : *</li><li>C++ : protected: <a href="class128565.html#refclass128565"><b>FileMap</b></a> * mappings</li></ul><a name="refrelation129162"></a>
|
||||
<table><tr><td><div class="element">Relation <b><aggregation></b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : # : <a href="class129333.html#refclass129333"><b>FileProvider</b></a></li><li>C++ : protected: <a href="class129333.html#refclass129333"><b>FileProvider</b></a> * </li></ul></div>
|
||||
<p>All public operations : <a href="class128181.html#refoperation128181"><b>getFrame</b></a> </p>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,23 +0,0 @@
|
|||
<!-- 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>Class FrameReference</title>
|
||||
<link rel="stylesheet" href="style.css" type="text/css" />
|
||||
</head>
|
||||
|
||||
<body bgcolor="#ffffff">
|
||||
|
||||
<div class = "title">Class FrameReference</div>
|
||||
<p></p>
|
||||
|
||||
<!-- ============================================================= -->
|
||||
|
||||
<a name="refclass128225"></a>
|
||||
<p>Declaration :</p><ul><li>C++ : class FrameReference : public <a href="class128906.html#refclass128906"><b>SmartPointer</b></a> </li></ul><div class="sub">
|
||||
<a name="refrelation129761"></a>
|
||||
<table><tr><td><div class="element">Relation <b>frame (<unidirectional association>)</b></div></td></tr></table><p>maybe weak reference<br /></p><p>Declaration :</p><ul><li>Uml : # frame : <a href="class128821.html#refclass128821"><b>Frame</b></a>, multiplicity : 0..1</li><li>C++ : protected: <a href="class128821.html#refclass128821"><b>Frame</b></a> * frame</li></ul></div>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,30 +0,0 @@
|
|||
<!-- 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>Class Fixture</title>
|
||||
<link rel="stylesheet" href="style.css" type="text/css" />
|
||||
</head>
|
||||
|
||||
<body bgcolor="#ffffff">
|
||||
|
||||
<div class = "title">Class Fixture</div>
|
||||
<p></p>
|
||||
|
||||
<!-- ============================================================= -->
|
||||
|
||||
<a name="refclass128261"></a>
|
||||
<p>Declaration :</p><ul><li>C++ : class Fixture : public <a href="class128133.html#refclass128133"><b>Seq</b></a> </li></ul><p>Artifact : <a href="index.html#refartifact128773"><b>fixture</b></a>, Component(s) : <a href="index.html#refcomponent128133"><b>Session</b></a></p><div class="sub">
|
||||
<a name="refrelation131717"></a>
|
||||
<table><tr><td><div class="element">Relation <b>effectiveTimeline (<directional composition>)</b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : # effectiveTimeline : <a href="class129797.html#refclass129797"><b>ExplicitPlacement</b></a>, multiplicity : *</li><li>C++ : protected: <a href="class129797.html#refclass129797"><b>ExplicitPlacement</b></a> effectiveTimeline</li></ul><p>Stereotype: list</p>
|
||||
<a name="refoperation128645"></a>
|
||||
<table><tr><td><div class="element">Operation <b>getPlaylistForRender</b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : + getPlaylistForRender() : list<ExplicitPlacement [ProcessingLayer::MObject]></li><li>C++ : public: list<ExplicitPlacement [ProcessingLayer::MObject]> getPlaylistForRender () </li></ul><a name="refoperation129157"></a>
|
||||
<table><tr><td><div class="element">Operation <b>getAutomation</b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : + getAutomation() : Auto [ProcessingLayer::MObject]*</li><li>C++ : public: Auto [ProcessingLayer::MObject]* getAutomation () </li></ul><a name="refrelation147589"></a>
|
||||
<table><tr><td><div class="element">Relation <b>track (<unidirectional association>)</b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : # track : <a href="class128389.html#refclass128389"><b>Track</b></a></li><li>C++ : protected: <a href="class128389.html#refclass128389"><b>Track</b></a>* track</li></ul><a name="refrelation163333"></a>
|
||||
<table><tr><td><div class="element">Relation <b><association></b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : # : <a href="class147333.html#refclass147333"><b>Segmentation</b></a></li><li>C++ : protected: <a href="class147333.html#refclass147333"><b>Segmentation</b></a>* </li></ul><p>Stereotype: partitioning</p>
|
||||
</div>
|
||||
<p>All public operations : <a href="class128261.html#refoperation129157"><b>getAutomation</b></a> , <a href="class128261.html#refoperation128645"><b>getPlaylistForRender</b></a> </p>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,23 +0,0 @@
|
|||
<!-- 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>Class Condition</title>
|
||||
<link rel="stylesheet" href="style.css" type="text/css" />
|
||||
</head>
|
||||
|
||||
<body bgcolor="#ffffff">
|
||||
|
||||
<div class = "title">Class Condition</div>
|
||||
<p></p>
|
||||
|
||||
<!-- ============================================================= -->
|
||||
|
||||
<a name="refclass128266"></a>
|
||||
<p>I provided a reworked Condition class in my Cinelerra2 repository<br /></p><p>Declaration :</p><ul><li>C++ : class Condition </li></ul><div class="sub">
|
||||
<table><tr><td><div class="element">Class <b><a href="class128522.html#refclass128522"><b>Lock</b></a></b></div></td></tr></table>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,26 +0,0 @@
|
|||
<!-- 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>Class FileHandleCache</title>
|
||||
<link rel="stylesheet" href="style.css" type="text/css" />
|
||||
</head>
|
||||
|
||||
<body bgcolor="#ffffff">
|
||||
|
||||
<div class = "title">Class FileHandleCache</div>
|
||||
<p></p>
|
||||
|
||||
<!-- ============================================================= -->
|
||||
|
||||
<a name="refclass128309"></a>
|
||||
<p>Declaration :</p><ul><li>C++ : class FileHandleCache </li></ul><div class="sub">
|
||||
<a name="refrelation128737"></a>
|
||||
<table><tr><td><div class="element">Relation <b>handles (<directional composition>)</b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : # handles : <a href="class128693.html#refclass128693"><b>FileHandle</b></a>, multiplicity : *</li><li>C++ : protected: list<<a href="class128693.html#refclass128693"><b>FileHandle</b></a>> handles</li></ul><p>Stereotype: list</p>
|
||||
<a name="refattribute128225"></a>
|
||||
<table><tr><td><div class="element">Attribut <b>handles_available</b></div></td></tr></table>
|
||||
<p>initialized to the maximum number of filehandles the backend may use for mapped files. When no handles are available, the handle which is last in the handles list is closed and (re-)used.<br />Else this number is decremented for each new filehandle used and incremented for any one explicitly freed.<br /></p><p>Declaration :</p><ul><li>Uml : - handles_available : int</li><li>C++ : private: int handles_available</li></ul></div>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,25 +0,0 @@
|
|||
<!-- 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>Class Track</title>
|
||||
<link rel="stylesheet" href="style.css" type="text/css" />
|
||||
</head>
|
||||
|
||||
<body bgcolor="#ffffff">
|
||||
|
||||
<div class = "title">Class Track</div>
|
||||
<p></p>
|
||||
|
||||
<!-- ============================================================= -->
|
||||
|
||||
<a name="refclass128389"></a>
|
||||
<p>Declaration :</p><ul><li>C++ : class Track : public <a href="class129157.html#refclass129157"><b>Meta</b></a>, public <a href="class128517.html#refclass128517"><b>MObject</b></a> </li></ul><p>Artifact : <a href="index.html#refartifact128901"><b>track</b></a>, Diagram : <a href="index.html#refclass diagram128133"><b>Session structure</b></a></p><div class="sub">
|
||||
<a name="refrelation147205"></a>
|
||||
<table><tr><td><div class="element">Relation <b>subTracks (<directional composition>)</b></div></td></tr></table><p>Child tracks in a tree structure<br /></p><p>Declaration :</p><ul><li>Uml : + subTracks : <a href="class128389.html#refclass128389"><b>Track</b></a>, multiplicity : *</li><li>C++ : public: <a href="class128389.html#refclass128389"><b>Track</b></a> subTracks</li></ul><p>Stereotype: vector</p>
|
||||
</div>
|
||||
<p>All public operations : <a href="class134021.html#refoperation129669"><b>apply</b></a> , <a href="class140165.html#refoperation134789"><b>apply</b></a> , <a href="class140165.html#refoperation134917"><b>dispatchOp</b></a> </p>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,23 +0,0 @@
|
|||
<!-- 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>Class Mutex</title>
|
||||
<link rel="stylesheet" href="style.css" type="text/css" />
|
||||
</head>
|
||||
|
||||
<body bgcolor="#ffffff">
|
||||
|
||||
<div class = "title">Class Mutex</div>
|
||||
<p></p>
|
||||
|
||||
<!-- ============================================================= -->
|
||||
|
||||
<a name="refclass128394"></a>
|
||||
<p>I provided a reworked Mutex class in my Cinelerra2 repository<br /></p><p>Declaration :</p><ul><li>C++ : class Mutex </li></ul><div class="sub">
|
||||
<table><tr><td><div class="element">Class <b><a href="class128650.html#refclass128650"><b>Lock</b></a></b></div></td></tr></table>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,27 +0,0 @@
|
|||
<!-- 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>Class FileMapCache</title>
|
||||
<link rel="stylesheet" href="style.css" type="text/css" />
|
||||
</head>
|
||||
|
||||
<body bgcolor="#ffffff">
|
||||
|
||||
<div class = "title">Class FileMapCache</div>
|
||||
<p></p>
|
||||
|
||||
<!-- ============================================================= -->
|
||||
|
||||
<a name="refclass128437"></a>
|
||||
<p>Declaration :</p><ul><li>C++ : class FileMapCache </li></ul><div class="sub">
|
||||
<a name="refrelation129505"></a>
|
||||
<table><tr><td><div class="element">Relation <b><association></b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : # : <a href="class128821.html#refclass128821"><b>Frame</b></a></li><li>C++ : protected: <a href="class128821.html#refclass128821"><b>Frame</b></a> * </li></ul><a name="refrelation129633"></a>
|
||||
<table><tr><td><div class="element">Relation <b>checked_in (<directional composition>)</b></div></td></tr></table><p>checked_in objects are subject of cache aging and must be not in use<br /></p><p>Declaration :</p><ul><li>Uml : # checked_in : <a href="class128565.html#refclass128565"><b>FileMap</b></a>, multiplicity : *</li><li>C++ : protected: <a href="class128565.html#refclass128565"><b>FileMap</b></a> checked_in</li></ul><p>Stereotype: list</p>
|
||||
<a name="refrelation129290"></a>
|
||||
<table><tr><td><div class="element">Relation <b>checked_out (<directional composition>)</b></div></td></tr></table><p>this list keeps all mappings which are in use, and thus prevents them from Cache aging<br /></p><p>Declaration :</p><ul><li>Uml : # checked_out : <a href="class128565.html#refclass128565"><b>FileMap</b></a>, multiplicity : *</li><li>C++ : protected: list<<a href="class128565.html#refclass128565"><b>FileMap</b></a>> checked_out</li></ul><p>Stereotype: list</p>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,27 +0,0 @@
|
|||
<!-- 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>Class MObject</title>
|
||||
<link rel="stylesheet" href="style.css" type="text/css" />
|
||||
</head>
|
||||
|
||||
<body bgcolor="#ffffff">
|
||||
|
||||
<div class = "title">Class MObject</div>
|
||||
<p></p>
|
||||
|
||||
<!-- ============================================================= -->
|
||||
|
||||
<a name="refclass128517"></a>
|
||||
<p>Declaration :</p><ul><li>C++ : class MObject : public <a href="class134021.html#refclass134021"><b>Buildable</b></a> </li><li>Java : public interface MObject </li></ul><p>Directly inherited by : <a href="class128773.html#refclass128773"><b>AbstractMO</b></a> <a href="class128901.html#refclass128901"><b>Clip</b></a> <a href="class129029.html#refclass129029"><b>Effect</b></a> <a href="class129669.html#refclass129669"><b>Label</b></a> <a href="class128389.html#refclass128389"><b>Track</b></a> </p>
|
||||
<p>Artifact : <a href="index.html#refartifact128261"><b>mobject</b></a>, Component(s) : <a href="index.html#refcomponent128133"><b>Session</b></a></p><p>Stereotype: interface</p>
|
||||
<div class="sub">
|
||||
<a name="refattribute128517"></a>
|
||||
<table><tr><td><div class="element">Attribut <b>length</b></div></td></tr></table>
|
||||
<p>TODO: how to represent time intervals?<br /></p><p>Declaration :</p><ul><li>Uml : # length : <a href="class134917.html#refclass134917"><b>Time</b></a></li><li>C++ : protected: <a href="class134917.html#refclass134917"><b>Time</b></a> length</li></ul></div>
|
||||
<p>All public operations : <a href="class134021.html#refoperation129669"><b>apply</b></a> , <a href="class140165.html#refoperation134789"><b>apply</b></a> , <a href="class140165.html#refoperation134917"><b>dispatchOp</b></a> </p>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,21 +0,0 @@
|
|||
<!-- 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>Class Lock</title>
|
||||
<link rel="stylesheet" href="style.css" type="text/css" />
|
||||
</head>
|
||||
|
||||
<body bgcolor="#ffffff">
|
||||
|
||||
<div class = "title">Class Lock</div>
|
||||
<p></p>
|
||||
|
||||
<!-- ============================================================= -->
|
||||
|
||||
<a name="refclass128522"></a>
|
||||
<p>Declaration :</p><ul><li>C++ : class Lock </li></ul><p>nested in <a href="class128266.html#refclass128266"><b>Condition</b></a></p>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,23 +0,0 @@
|
|||
<!-- 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>Class FileMap</title>
|
||||
<link rel="stylesheet" href="style.css" type="text/css" />
|
||||
</head>
|
||||
|
||||
<body bgcolor="#ffffff">
|
||||
|
||||
<div class = "title">Class FileMap</div>
|
||||
<p></p>
|
||||
|
||||
<!-- ============================================================= -->
|
||||
|
||||
<a name="refclass128565"></a>
|
||||
<p>Declaration :</p><ul><li>C++ : class FileMap </li></ul><p>Diagram : <a href="index.html#refclass diagram128181"><b>File Mapping</b></a></p><div class="sub">
|
||||
<a name="refrelation128394"></a>
|
||||
<table><tr><td><div class="element">Relation <b>frames (<aggregation>)</b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : - frames : <a href="class128821.html#refclass128821"><b>Frame</b></a>, multiplicity : *</li><li>C++ : private: <a href="class128821.html#refclass128821"><b>Frame</b></a> * frames</li></ul></div>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,31 +0,0 @@
|
|||
<!-- 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>Class Placement</title>
|
||||
<link rel="stylesheet" href="style.css" type="text/css" />
|
||||
</head>
|
||||
|
||||
<body bgcolor="#ffffff">
|
||||
|
||||
<div class = "title">Class Placement</div>
|
||||
<p></p>
|
||||
|
||||
<!-- ============================================================= -->
|
||||
|
||||
<a name="refclass128645"></a>
|
||||
<p>used to specify the position of a MObject in the EDL. This can be done in various ways (absolute, relative). <br />Placement at the same time acts as (refcounting) smart pointer for accessing the MObject.<br /></p><p>Declaration :</p><ul><li>C++ : class Placement </li><li>Java : public interface Placement </li></ul><p>Directly inherited by : <a href="class129797.html#refclass129797"><b>ExplicitPlacement</b></a> </p>
|
||||
<p>Artifact : <a href="index.html#refartifact129029"><b>placement</b></a></p><p>Stereotype: interface</p>
|
||||
<div class="sub">
|
||||
<a name="refoperation128005"></a>
|
||||
<table><tr><td><div class="element">Operation <b>resolve</b></div></td></tr></table><p>create an actual (explicit) placement while trying to satisfy the network of adjacent objects and placements.<br /></p><p>Declaration :</p><ul><li>Uml : + resolve() : ExplicitPlacement [ProcessingLayer::MObject]&</li><li>C++ : public: ExplicitPlacement [ProcessingLayer::MObject]& resolve () </li></ul><a name="refrelation144901"></a>
|
||||
<table><tr><td><div class="element">Relation <b>subject (<unidirectional association>)</b></div></td></tr></table><p>Placement acts as smart pointer<br /></p><p>Declaration :</p><ul><li>Uml : # subject : <a href="class128517.html#refclass128517"><b>MObject</b></a>, multiplicity : 1</li><li>C++ : protected: <a href="class128517.html#refclass128517"><b>MObject</b></a>* subject</li></ul><a name="refoperation134277"></a>
|
||||
<table><tr><td><div class="element">Operation <b>chain</b></div></td></tr></table><p>create and add another Placement for this media object, thus increasingly constraining the (possible) position of this object.<br /></p><p>Declaration :</p><ul><li>Uml : + chain(in style : ) : </li><li>C++ : public: chain (const & style) </li></ul><a name="refrelation145413"></a>
|
||||
<table><tr><td><div class="element">Relation <b>chain (<unidirectional association>)</b></div></td></tr></table><p>Chain of additional Placements further constraining the position of this MObject<br /></p><p>Declaration :</p><ul><li>Uml : # chain : <a href="class139909.html#refclass139909"><b>LocatingPin</b></a>, multiplicity : 1</li><li>C++ : protected: <a href="class139909.html#refclass139909"><b>LocatingPin</b></a>* chain</li></ul><a name="refrelation176773"></a>
|
||||
<table><tr><td><div class="element">Relation <b><unidirectional association></b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : # : <a href="class152581.html#refclass152581"><b>Id</b></a></li><li>C++ : protected: <a href="class152581.html#refclass152581"><b>Id</b></a>* </li></ul><p>Stereotype: has_a</p>
|
||||
</div>
|
||||
<p>All public operations : <a href="class128645.html#refoperation134277"><b>chain</b></a> , <a href="class128645.html#refoperation128005"><b>resolve</b></a> </p>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,21 +0,0 @@
|
|||
<!-- 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>Class Lock</title>
|
||||
<link rel="stylesheet" href="style.css" type="text/css" />
|
||||
</head>
|
||||
|
||||
<body bgcolor="#ffffff">
|
||||
|
||||
<div class = "title">Class Lock</div>
|
||||
<p></p>
|
||||
|
||||
<!-- ============================================================= -->
|
||||
|
||||
<a name="refclass128650"></a>
|
||||
<p>Declaration :</p><ul><li>C++ : class Lock </li></ul><p>nested in <a href="class128394.html#refclass128394"><b>Mutex</b></a></p>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,20 +0,0 @@
|
|||
<!-- 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>Class FileHandle</title>
|
||||
<link rel="stylesheet" href="style.css" type="text/css" />
|
||||
</head>
|
||||
|
||||
<body bgcolor="#ffffff">
|
||||
|
||||
<div class = "title">Class FileHandle</div>
|
||||
<p></p>
|
||||
|
||||
<!-- ============================================================= -->
|
||||
|
||||
<a name="refclass128693"></a>
|
||||
<p>Declaration :</p><ul><li>C++ : class FileHandle </li></ul></body>
|
||||
</html>
|
||||
|
|
@ -1,24 +0,0 @@
|
|||
<!-- 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>Class AbstractMO</title>
|
||||
<link rel="stylesheet" href="style.css" type="text/css" />
|
||||
</head>
|
||||
|
||||
<body bgcolor="#ffffff">
|
||||
|
||||
<div class = "title">Class AbstractMO</div>
|
||||
<p></p>
|
||||
|
||||
<!-- ============================================================= -->
|
||||
|
||||
<a name="refclass128773"></a>
|
||||
<p>Declaration :</p><ul><li>C++ : class AbstractMO : public <a href="class128517.html#refclass128517"><b>MObject</b></a> </li></ul><p>Directly inherited by : <a href="class128901.html#refclass128901"><b>Clip</b></a> <a href="class129029.html#refclass129029"><b>Effect</b></a> <a href="class129157.html#refclass129157"><b>Meta</b></a> </p>
|
||||
<p>Artifact : <a href="index.html#refartifact129285"><b>abstractmo</b></a></p><div class="sub">
|
||||
</div>
|
||||
<p>All public operations : <a href="class134021.html#refoperation129669"><b>apply</b></a> , <a href="class140165.html#refoperation134789"><b>apply</b></a> , <a href="class140165.html#refoperation134917"><b>dispatchOp</b></a> </p>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,23 +0,0 @@
|
|||
<!-- 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>Class FileReference</title>
|
||||
<link rel="stylesheet" href="style.css" type="text/css" />
|
||||
</head>
|
||||
|
||||
<body bgcolor="#ffffff">
|
||||
|
||||
<div class = "title">Class FileReference</div>
|
||||
<p></p>
|
||||
|
||||
<!-- ============================================================= -->
|
||||
|
||||
<a name="refclass128778"></a>
|
||||
<p>Declaration :</p><ul><li>C++ : class FileReference : public <a href="class128906.html#refclass128906"><b>SmartPointer</b></a> </li></ul><div class="sub">
|
||||
<a name="refrelation128138"></a>
|
||||
<table><tr><td><div class="element">Relation <b>file (<unidirectional association>)</b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : # file : <a href="class128181.html#refclass128181"><b>File</b></a>, multiplicity : 0..1</li><li>C++ : protected: <a href="class128181.html#refclass128181"><b>File</b></a> * file</li></ul></div>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,32 +0,0 @@
|
|||
<!-- 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>Class Frame</title>
|
||||
<link rel="stylesheet" href="style.css" type="text/css" />
|
||||
</head>
|
||||
|
||||
<body bgcolor="#ffffff">
|
||||
|
||||
<div class = "title">Class Frame</div>
|
||||
<p></p>
|
||||
|
||||
<!-- ============================================================= -->
|
||||
|
||||
<a name="refclass128821"></a>
|
||||
<p>Frames are just a low level lump of continous memory, most parts are opaque. Frames are memory sensitive, they will be small constant sized structures which can be efficently managed in a pool.<br /></p><p>Declaration :</p><ul><li>C++ : class Frame </li></ul><div class="sub">
|
||||
<a name="refrelation128181"></a>
|
||||
<table><tr><td><div class="element">Relation <b><directional aggregation></b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : # : <a href="class128949.html#refclass128949"><b>FrameDescriptor</b></a>, multiplicity : *</li><li>C++ : protected: <<a href="class128949.html#refclass128949"><b>FrameDescriptor</b></a> *> </li></ul><a name="refrelation128309"></a>
|
||||
<table><tr><td><div class="element">Relation <b><directional aggregation></b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : # : <a href="class128949.html#refclass128949"><b>FrameDescriptor</b></a></li><li>C++ : protected: <a href="class128949.html#refclass128949"><b>FrameDescriptor</b></a> * </li></ul><a name="refrelation128693"></a>
|
||||
<table><tr><td><div class="element">Relation <b><aggregation></b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : # : <a href="class128949.html#refclass128949"><b>FrameDescriptor</b></a></li><li>C++ : protected: <a href="class128949.html#refclass128949"><b>FrameDescriptor</b></a> * </li></ul><a name="refrelation128949"></a>
|
||||
<table><tr><td><div class="element">Relation <b><directional aggregation></b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : # : <a href="class128949.html#refclass128949"><b>FrameDescriptor</b></a></li><li>C++ : protected: <a href="class128949.html#refclass128949"><b>FrameDescriptor</b></a> * </li></ul><a name="refrelation129077"></a>
|
||||
<table><tr><td><div class="element">Relation <b><directional aggregation></b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : # : <a href="class128949.html#refclass128949"><b>FrameDescriptor</b></a></li><li>C++ : protected: <a href="class128949.html#refclass128949"><b>FrameDescriptor</b></a> * </li></ul><a name="refrelation128481"></a>
|
||||
<table><tr><td><div class="element">Relation <b>descriptor (<directional aggregation>)</b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : # descriptor : <a href="class128949.html#refclass128949"><b>FrameDescriptor</b></a></li><li>C++ : protected: <a href="class128949.html#refclass128949"><b>FrameDescriptor</b></a> * descriptor</li></ul><a name="refrelation129377"></a>
|
||||
<table><tr><td><div class="element">Relation <b><association></b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : # : <a href="class128437.html#refclass128437"><b>FileMapCache</b></a></li><li>C++ : protected: <a href="class128437.html#refclass128437"><b>FileMapCache</b></a> * </li></ul><a name="refrelation128522"></a>
|
||||
<table><tr><td><div class="element">Relation <b>mapping (<aggregation>)</b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : - mapping : <a href="class128565.html#refclass128565"><b>FileMap</b></a>, multiplicity : 1</li><li>C++ : private: <a href="class128565.html#refclass128565"><b>FileMap</b></a> * mapping</li></ul><a name="refrelation129674"></a>
|
||||
<table><tr><td><div class="element">Relation <b><aggregation></b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : # : <a href="class129162.html#refclass129162"><b>WriteBuffer</b></a></li><li>C++ : protected: <a href="class129162.html#refclass129162"><b>WriteBuffer</b></a>* </li></ul><a name="refrelation130058"></a>
|
||||
<table><tr><td><div class="element">Relation <b><association></b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : # write_buffer : <a href="class129162.html#refclass129162"><b>WriteBuffer</b></a>, multiplicity : 0..1</li><li>C++ : protected: <a href="class129162.html#refclass129162"><b>WriteBuffer</b></a>* write_buffer</li></ul></div>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,24 +0,0 @@
|
|||
<!-- 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>Class Clip</title>
|
||||
<link rel="stylesheet" href="style.css" type="text/css" />
|
||||
</head>
|
||||
|
||||
<body bgcolor="#ffffff">
|
||||
|
||||
<div class = "title">Class Clip</div>
|
||||
<p></p>
|
||||
|
||||
<!-- ============================================================= -->
|
||||
|
||||
<a name="refclass128901"></a>
|
||||
<p>Declaration :</p><ul><li>C++ : class Clip : public <a href="class128773.html#refclass128773"><b>AbstractMO</b></a>, public <a href="class128517.html#refclass128517"><b>MObject</b></a> </li></ul><p>Artifact : <a href="index.html#refartifact129413"><b>clip</b></a></p><div class="sub">
|
||||
<a name="refrelation142469"></a>
|
||||
<table><tr><td><div class="element">Relation <b>source (<unidirectional association>)</b></div></td></tr></table><p>the media source this clip referes to<br /></p><p>Declaration :</p><ul><li>Uml : # source : <a href="class136709.html#refclass136709"><b>Media</b></a>, multiplicity : 1</li><li>C++ : protected: <a href="class136709.html#refclass136709"><b>Media</b></a>* source</li></ul></div>
|
||||
<p>All public operations : <a href="class134021.html#refoperation129669"><b>apply</b></a> , <a href="class140165.html#refoperation134789"><b>apply</b></a> , <a href="class140165.html#refoperation134917"><b>dispatchOp</b></a> </p>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,22 +0,0 @@
|
|||
<!-- 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>Class SmartPointer</title>
|
||||
<link rel="stylesheet" href="style.css" type="text/css" />
|
||||
</head>
|
||||
|
||||
<body bgcolor="#ffffff">
|
||||
|
||||
<div class = "title">Class SmartPointer</div>
|
||||
<p></p>
|
||||
|
||||
<!-- ============================================================= -->
|
||||
|
||||
<a name="refclass128906"></a>
|
||||
<p>Declaration :</p><ul><li>C++ : class SmartPointer </li><li>Java : package abstract class SmartPointer </li></ul><p>Directly inherited by : <a href="class128778.html#refclass128778"><b>FileReference</b></a> <a href="class128225.html#refclass128225"><b>FrameReference</b></a> </p>
|
||||
<p>Stereotype: auxiliary</p>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,24 +0,0 @@
|
|||
<!-- 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>Class FrameDescriptor</title>
|
||||
<link rel="stylesheet" href="style.css" type="text/css" />
|
||||
</head>
|
||||
|
||||
<body bgcolor="#ffffff">
|
||||
|
||||
<div class = "title">Class FrameDescriptor</div>
|
||||
<p></p>
|
||||
|
||||
<!-- ============================================================= -->
|
||||
|
||||
<a name="refclass128949"></a>
|
||||
<p>A FrameDescriptor implements the higher level interfaces for frames. Further refinements are made by subclassing and policy classes<br /></p><p>Declaration :</p><ul><li>C++ : class FrameDescriptor </li><li>Java : package interface FrameDescriptor </li></ul><p>Stereotype: interface</p>
|
||||
<div class="sub">
|
||||
<a name="refrelation128821"></a>
|
||||
<table><tr><td><div class="element">Relation <b><aggregation></b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : # : <a href="class128821.html#refclass128821"><b>Frame</b></a></li><li>C++ : protected: <a href="class128821.html#refclass128821"><b>Frame</b></a> * </li></ul></div>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,25 +0,0 @@
|
|||
<!-- 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>Class Effect</title>
|
||||
<link rel="stylesheet" href="style.css" type="text/css" />
|
||||
</head>
|
||||
|
||||
<body bgcolor="#ffffff">
|
||||
|
||||
<div class = "title">Class Effect</div>
|
||||
<p></p>
|
||||
|
||||
<!-- ============================================================= -->
|
||||
|
||||
<a name="refclass129029"></a>
|
||||
<p>Declaration :</p><ul><li>C++ : class Effect : public <a href="class128773.html#refclass128773"><b>AbstractMO</b></a>, public <a href="class128517.html#refclass128517"><b>MObject</b></a> </li></ul><p>Artifact : <a href="index.html#refartifact129541"><b>effect</b></a></p><div class="sub">
|
||||
<a name="refattribute128901"></a>
|
||||
<table><tr><td><div class="element">Attribut <b>plugin</b></div></td></tr></table>
|
||||
<p>Identifier of the Plugin to be used<br /></p><p>Declaration :</p><ul><li>Uml : # plugin : string</li><li>C++ : protected: string plugin</li></ul></div>
|
||||
<p>All public operations : <a href="class134021.html#refoperation129669"><b>apply</b></a> , <a href="class140165.html#refoperation134789"><b>apply</b></a> , <a href="class140165.html#refoperation134917"><b>dispatchOp</b></a> </p>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,23 +0,0 @@
|
|||
<!-- 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>Class WriteBufferPool</title>
|
||||
<link rel="stylesheet" href="style.css" type="text/css" />
|
||||
</head>
|
||||
|
||||
<body bgcolor="#ffffff">
|
||||
|
||||
<div class = "title">Class WriteBufferPool</div>
|
||||
<p></p>
|
||||
|
||||
<!-- ============================================================= -->
|
||||
|
||||
<a name="refclass129034"></a>
|
||||
<p>Declaration :</p><ul><li>C++ : class WriteBufferPool </li></ul><div class="sub">
|
||||
<a name="refrelation130186"></a>
|
||||
<table><tr><td><div class="element">Relation <b><association></b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : # : <a href="class129162.html#refclass129162"><b>WriteBuffer</b></a></li><li>C++ : protected: <a href="class129162.html#refclass129162"><b>WriteBuffer</b></a>* </li></ul></div>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,20 +0,0 @@
|
|||
<!-- 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>Class Prefetch</title>
|
||||
<link rel="stylesheet" href="style.css" type="text/css" />
|
||||
</head>
|
||||
|
||||
<body bgcolor="#ffffff">
|
||||
|
||||
<div class = "title">Class Prefetch</div>
|
||||
<p></p>
|
||||
|
||||
<!-- ============================================================= -->
|
||||
|
||||
<a name="refclass129077"></a>
|
||||
<p>Declaration :</p><ul><li>C++ : class Prefetch </li></ul></body>
|
||||
</html>
|
||||
|
|
@ -1,24 +0,0 @@
|
|||
<!-- 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>Class Meta</title>
|
||||
<link rel="stylesheet" href="style.css" type="text/css" />
|
||||
</head>
|
||||
|
||||
<body bgcolor="#ffffff">
|
||||
|
||||
<div class = "title">Class Meta</div>
|
||||
<p></p>
|
||||
|
||||
<!-- ============================================================= -->
|
||||
|
||||
<a name="refclass129157"></a>
|
||||
<p>Declaration :</p><ul><li>C++ : class Meta : public <a href="class128773.html#refclass128773"><b>AbstractMO</b></a> </li></ul><p>Directly inherited by : <a href="class129925.html#refclass129925"><b>Auto</b></a> <a href="class129669.html#refclass129669"><b>Label</b></a> <a href="class160517.html#refclass160517"><b>Root</b></a> <a href="class128389.html#refclass128389"><b>Track</b></a> </p>
|
||||
<p>Artifact : <a href="index.html#refartifact129669"><b>meta</b></a></p><div class="sub">
|
||||
</div>
|
||||
<p>All public operations : <a href="class134021.html#refoperation129669"><b>apply</b></a> , <a href="class140165.html#refoperation134789"><b>apply</b></a> , <a href="class140165.html#refoperation134917"><b>dispatchOp</b></a> </p>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,25 +0,0 @@
|
|||
<!-- 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>Class WriteBuffer</title>
|
||||
<link rel="stylesheet" href="style.css" type="text/css" />
|
||||
</head>
|
||||
|
||||
<body bgcolor="#ffffff">
|
||||
|
||||
<div class = "title">Class WriteBuffer</div>
|
||||
<p></p>
|
||||
|
||||
<!-- ============================================================= -->
|
||||
|
||||
<a name="refclass129162"></a>
|
||||
<p>Declaration :</p><ul><li>C++ : class WriteBuffer </li></ul><div class="sub">
|
||||
<a name="refrelation129802"></a>
|
||||
<table><tr><td><div class="element">Relation <b><aggregation></b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : # : <a href="class128821.html#refclass128821"><b>Frame</b></a></li><li>C++ : protected: <a href="class128821.html#refclass128821"><b>Frame</b></a>* </li></ul><a name="refrelation129930"></a>
|
||||
<table><tr><td><div class="element">Relation <b>frame (<association>)</b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : # frame : <a href="class128821.html#refclass128821"><b>Frame</b></a>, multiplicity : 0..1</li><li>C++ : protected: <a href="class128821.html#refclass128821"><b>Frame</b></a>* frame</li></ul><a name="refrelation130314"></a>
|
||||
<table><tr><td><div class="element">Relation <b><association></b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : # : <a href="class129034.html#refclass129034"><b>WriteBufferPool</b></a></li><li>C++ : protected: <a href="class129034.html#refclass129034"><b>WriteBufferPool</b></a>* </li></ul></div>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,20 +0,0 @@
|
|||
<!-- 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>Class Scheduler</title>
|
||||
<link rel="stylesheet" href="style.css" type="text/css" />
|
||||
</head>
|
||||
|
||||
<body bgcolor="#ffffff">
|
||||
|
||||
<div class = "title">Class Scheduler</div>
|
||||
<p></p>
|
||||
|
||||
<!-- ============================================================= -->
|
||||
|
||||
<a name="refclass129205"></a>
|
||||
<p>Declaration :</p><ul><li>C++ : class Scheduler </li></ul></body>
|
||||
</html>
|
||||
|
|
@ -1,22 +0,0 @@
|
|||
<!-- 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>Class FixedLocation</title>
|
||||
<link rel="stylesheet" href="style.css" type="text/css" />
|
||||
</head>
|
||||
|
||||
<body bgcolor="#ffffff">
|
||||
|
||||
<div class = "title">Class FixedLocation</div>
|
||||
<p></p>
|
||||
|
||||
<!-- ============================================================= -->
|
||||
|
||||
<a name="refclass129285"></a>
|
||||
<p>Declaration :</p><ul><li>C++ : class FixedLocation : public <a href="class139909.html#refclass139909"><b>LocatingPin</b></a> </li></ul><p>Artifact : <a href="index.html#refartifact129797"><b>fixedlocation</b></a></p><div class="sub">
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,26 +0,0 @@
|
|||
<!-- 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>Class FileProvider</title>
|
||||
<link rel="stylesheet" href="style.css" type="text/css" />
|
||||
</head>
|
||||
|
||||
<body bgcolor="#ffffff">
|
||||
|
||||
<div class = "title">Class FileProvider</div>
|
||||
<p></p>
|
||||
|
||||
<!-- ============================================================= -->
|
||||
|
||||
<a name="refclass129333"></a>
|
||||
<p>This is the Factory for Files, whenever something wants to use some file (or temporary storage), This Factory will hand out some smart/shared pointer to a File object which will be used to retrieve Frames.<br /></p><p>Declaration :</p><ul><li>C++ : class FileProvider </li></ul><div class="sub">
|
||||
<a name="refrelation129034"></a>
|
||||
<table><tr><td><div class="element">Relation <b>files (<aggregation>)</b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : # files : <a href="class128181.html#refclass128181"><b>File</b></a>, multiplicity : *</li><li>C++ : protected: <a href="class128181.html#refclass128181"><b>File</b></a> * files</li></ul><a name="refoperation128010"></a>
|
||||
<table><tr><td><div class="element">Operation <b>useFile</b></div></td></tr></table><p>Announces that the application intends to use this file with mode (READ|WRITE|READWRITE)<br /></p><p>Declaration :</p><ul><li>Uml : + useFile(in name : string, in mode : ) : <a href="class128778.html#refclass128778"><b>FileReference</b></a></li><li>C++ : public: <a href="class128778.html#refclass128778"><b>FileReference</b></a> useFile()</li></ul><a name="refoperation128138"></a>
|
||||
<table><tr><td><div class="element">Operation <b>useTemporaryStorage</b></div></td></tr></table><p>Provides a pool for interminate frames<br /></p><p>Declaration :</p><ul><li>Uml : + useTemporaryStorage(in type : <a href="class128949.html#refclass128949"><b>FrameDescriptor</b></a>) : <a href="class128778.html#refclass128778"><b>FileReference</b></a></li><li>C++ : public: <a href="class128778.html#refclass128778"><b>FileReference</b></a> useTemporaryStorage()</li></ul></div>
|
||||
<p>All public operations : <a href="class129333.html#refoperation128010"><b>useFile</b></a> , <a href="class129333.html#refoperation128138"><b>useTemporaryStorage</b></a> </p>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,29 +0,0 @@
|
|||
<!-- 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>Class RelativeLocation</title>
|
||||
<link rel="stylesheet" href="style.css" type="text/css" />
|
||||
</head>
|
||||
|
||||
<body bgcolor="#ffffff">
|
||||
|
||||
<div class = "title">Class RelativeLocation</div>
|
||||
<p></p>
|
||||
|
||||
<!-- ============================================================= -->
|
||||
|
||||
<a name="refclass129413"></a>
|
||||
<p>Declaration :</p><ul><li>C++ : class RelativeLocation : public <a href="class139909.html#refclass139909"><b>LocatingPin</b></a> </li></ul><p>Artifact : <a href="index.html#refartifact129925"><b>relativelocation</b></a></p><div class="sub">
|
||||
<a name="refrelation130565"></a>
|
||||
<table><tr><td><div class="element">Relation <b>anchor (<unidirectional association>)</b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : # anchor : <a href="class128517.html#refclass128517"><b>MObject</b></a>, multiplicity : 1</li><li>C++ : protected: <a href="class128517.html#refclass128517"><b>MObject</b></a>* anchor</li></ul><a name="refattribute128133"></a>
|
||||
<table><tr><td><div class="element">Attribut <b>relType</b></div></td></tr></table>
|
||||
<p>the kind of relation denoted by this Placement<br /></p><p>Declaration :</p><ul><li>Uml : # relType : <a href="class133893.html#refclass133893"><b>RelType</b></a></li><li>C++ : protected: <a href="class133893.html#refclass133893"><b>RelType</b></a> relType</li></ul><a name="refattribute129029"></a>
|
||||
<table><tr><td><div class="element">Attribut <b>offset</b></div></td></tr></table>
|
||||
<p>Offset the actual position by this (time) value relative to the anchor point. TODO: Representation?<br /></p><p>Declaration :</p><ul><li>Uml : # offset : <a href="class134917.html#refclass134917"><b>Time</b></a></li><li>C++ : protected: <a href="class134917.html#refclass134917"><b>Time</b></a> offset</li></ul><table><tr><td><div class="element">Class <b><a href="class133893.html#refclass133893"><b>RelType</b></a></b></div></td></tr></table>
|
||||
<a name="refrelation194821"></a>
|
||||
<table><tr><td><div class="element">Relation <b><unidirectional association></b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : # : <a href="class152453.html#refclass152453"><b>PlacementRef</b></a></li><li>C++ : protected: <a href="class152453.html#refclass152453"><b>PlacementRef</b></a>* </li></ul></div>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,27 +0,0 @@
|
|||
<!-- 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>Class Allocation</title>
|
||||
<link rel="stylesheet" href="style.css" type="text/css" />
|
||||
</head>
|
||||
|
||||
<body bgcolor="#ffffff">
|
||||
|
||||
<div class = "title">Class Allocation</div>
|
||||
<p></p>
|
||||
|
||||
<!-- ============================================================= -->
|
||||
|
||||
<a name="refclass129541"></a>
|
||||
<p>a directive to place a MObject in a specific way<br /></p><p>Declaration :</p><ul><li>C++ : class Allocation : public <a href="class139909.html#refclass139909"><b>LocatingPin</b></a> </li></ul><p>Directly inherited by : <a href="class130181.html#refclass130181"><b>Constraint</b></a> <a href="class130053.html#refclass130053"><b>Wish</b></a> </p>
|
||||
<p>Artifact : <a href="index.html#refartifact130053"><b>allocation</b></a></p><div class="sub">
|
||||
<a name="refattribute128773"></a>
|
||||
<table><tr><td><div class="element">Attribut <b>repr</b></div></td></tr></table>
|
||||
<p>human readable representation of the condition characterizing this allocaton, e.g. "t >= 10"<br /></p><p>Declaration :</p><ul><li>Uml : # repr : string</li><li>C++ : protected: string repr</li></ul><a name="refoperation131205"></a>
|
||||
<table><tr><td><div class="element">Operation <b>get_repr</b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : + get_repr() : string</li><li>C++ : public: inline const string getRepr () const </li></ul></div>
|
||||
<p>All public operations : <a href="class129541.html#refoperation131205"><b>get_repr</b></a> </p>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,23 +0,0 @@
|
|||
<!-- 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>Class Label</title>
|
||||
<link rel="stylesheet" href="style.css" type="text/css" />
|
||||
</head>
|
||||
|
||||
<body bgcolor="#ffffff">
|
||||
|
||||
<div class = "title">Class Label</div>
|
||||
<p></p>
|
||||
|
||||
<!-- ============================================================= -->
|
||||
|
||||
<a name="refclass129669"></a>
|
||||
<p>Declaration :</p><ul><li>C++ : class Label : public <a href="class129157.html#refclass129157"><b>Meta</b></a>, public <a href="class128517.html#refclass128517"><b>MObject</b></a> </li></ul><p>Artifact : <a href="index.html#refartifact130181"><b>label</b></a></p><div class="sub">
|
||||
</div>
|
||||
<p>All public operations : <a href="class134021.html#refoperation129669"><b>apply</b></a> , <a href="class140165.html#refoperation134789"><b>apply</b></a> , <a href="class140165.html#refoperation134917"><b>dispatchOp</b></a> </p>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,29 +0,0 @@
|
|||
<!-- 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>Class ExplicitPlacement</title>
|
||||
<link rel="stylesheet" href="style.css" type="text/css" />
|
||||
</head>
|
||||
|
||||
<body bgcolor="#ffffff">
|
||||
|
||||
<div class = "title">Class ExplicitPlacement</div>
|
||||
<p></p>
|
||||
|
||||
<!-- ============================================================= -->
|
||||
|
||||
<a name="refclass129797"></a>
|
||||
<p>Declaration :</p><ul><li>C++ : class ExplicitPlacement : public <a href="class128645.html#refclass128645"><b>Placement</b></a> </li><li>Java : public interface ExplicitPlacement </li></ul><p>Artifact : <a href="index.html#refartifact129157"><b>explicitplacement</b></a></p><p>Stereotype: interface</p>
|
||||
<div class="sub">
|
||||
<a name="refattribute128261"></a>
|
||||
<table><tr><td><div class="element">Attribut <b>time</b></div></td></tr></table>
|
||||
<p>Declaration :</p><ul><li>Uml : # time : <a href="class134917.html#refclass134917"><b>Time</b></a></li><li>C++ : protected: <a href="class134917.html#refclass134917"><b>Time</b></a> time</li></ul><a name="refattribute128389"></a>
|
||||
<table><tr><td><div class="element">Attribut <b>track</b></div></td></tr></table>
|
||||
<p>Declaration :</p><ul><li>Uml : # track : Track [ProcessingLayer::MObject] *</li><li>C++ : protected: Track [ProcessingLayer::MObject] * track</li></ul><a name="refrelation131845"></a>
|
||||
<table><tr><td><div class="element">Relation <b><unidirectional association></b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : # : <a href="class128389.html#refclass128389"><b>Track</b></a></li><li>C++ : protected: <a href="class128389.html#refclass128389"><b>Track</b></a>* </li></ul></div>
|
||||
<p>All public operations : <a href="class128645.html#refoperation134277"><b>chain</b></a> , <a href="class128645.html#refoperation128005"><b>resolve</b></a> </p>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,24 +0,0 @@
|
|||
<!-- 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>Class Auto</title>
|
||||
<link rel="stylesheet" href="style.css" type="text/css" />
|
||||
</head>
|
||||
|
||||
<body bgcolor="#ffffff">
|
||||
|
||||
<div class = "title">Class Auto</div>
|
||||
<p></p>
|
||||
|
||||
<!-- ============================================================= -->
|
||||
|
||||
<a name="refclass129925"></a>
|
||||
<p>Automation data for some parameter (i.e. a time varying function)<br /></p><p>Declaration :</p><ul><li>C++ : template<class VAL> class Auto : public <a href="class129157.html#refclass129157"><b>Meta</b></a>, public <a href="class134661.html#refclass134661"><b>ParamProvider</b></a><VAL> </li></ul><p>Artifact : <a href="index.html#refartifact130309"><b>auto</b></a></p><div class="sub">
|
||||
<a name="refoperation131077"></a>
|
||||
<table><tr><td><div class="element">Operation <b>getValue</b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : + getValue() : VAL</li><li>C++ : public: VAL getValue () const </li></ul></div>
|
||||
<p>All public operations : <a href="class134021.html#refoperation129669"><b>apply</b></a> , <a href="class140165.html#refoperation134789"><b>apply</b></a> , <a href="class140165.html#refoperation134917"><b>dispatchOp</b></a> , <a href="class129925.html#refoperation131077"><b>getValue</b></a> , <a href="class134661.html#refoperation130949"><b>getValue</b></a> </p>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,24 +0,0 @@
|
|||
<!-- 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>Class Wish</title>
|
||||
<link rel="stylesheet" href="style.css" type="text/css" />
|
||||
</head>
|
||||
|
||||
<body bgcolor="#ffffff">
|
||||
|
||||
<div class = "title">Class Wish</div>
|
||||
<p></p>
|
||||
|
||||
<!-- ============================================================= -->
|
||||
|
||||
<a name="refclass130053"></a>
|
||||
<p>Declaration :</p><ul><li>C++ : class Wish : public <a href="class129541.html#refclass129541"><b>Allocation</b></a> </li></ul><p>Directly inherited by : <a href="class140421.html#refclass140421"><b>Plug</b></a> </p>
|
||||
<p>Artifact : <a href="index.html#refartifact139269"><b>wish</b></a></p><div class="sub">
|
||||
</div>
|
||||
<p>All public operations : <a href="class129541.html#refoperation131205"><b>get_repr</b></a> </p>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,23 +0,0 @@
|
|||
<!-- 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>Class Constraint</title>
|
||||
<link rel="stylesheet" href="style.css" type="text/css" />
|
||||
</head>
|
||||
|
||||
<body bgcolor="#ffffff">
|
||||
|
||||
<div class = "title">Class Constraint</div>
|
||||
<p></p>
|
||||
|
||||
<!-- ============================================================= -->
|
||||
|
||||
<a name="refclass130181"></a>
|
||||
<p>Declaration :</p><ul><li>C++ : class Constraint : public <a href="class129541.html#refclass129541"><b>Allocation</b></a> </li></ul><p>Artifact : <a href="index.html#refartifact139397"><b>constraint</b></a></p><div class="sub">
|
||||
</div>
|
||||
<p>All public operations : <a href="class129541.html#refoperation131205"><b>get_repr</b></a> </p>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,21 +0,0 @@
|
|||
<!-- 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>Class ControllerFacade</title>
|
||||
<link rel="stylesheet" href="style.css" type="text/css" />
|
||||
</head>
|
||||
|
||||
<body bgcolor="#ffffff">
|
||||
|
||||
<div class = "title">Class ControllerFacade</div>
|
||||
<p></p>
|
||||
|
||||
<!-- ============================================================= -->
|
||||
|
||||
<a name="refclass130309"></a>
|
||||
<p>Provides unified access to the Proc-Subsystem Controller. Especially, this Facade class provides the functions to get a render engine to carry out actual renderings.<br /></p><p>Declaration :</p><ul><li>C++ : class ControllerFacade </li></ul><p>Artifact : <a href="index.html#refartifact131589"><b>controllerfacade</b></a>, Component(s) : <a href="index.html#refcomponent129541"><b>ControllerFacade</b></a></p><p>Stereotype: boundary</p>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,24 +0,0 @@
|
|||
<!-- 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>Class PathManager</title>
|
||||
<link rel="stylesheet" href="style.css" type="text/css" />
|
||||
</head>
|
||||
|
||||
<body bgcolor="#ffffff">
|
||||
|
||||
<div class = "title">Class PathManager</div>
|
||||
<p></p>
|
||||
|
||||
<!-- ============================================================= -->
|
||||
|
||||
<a name="refclass130437"></a>
|
||||
<p>While building a render engine, this Strategy class decides on the actual render strategy in accordance to the current controller settings (system state)<br /></p><p>Declaration :</p><ul><li>C++ : class PathManager </li></ul><p>Artifact : <a href="index.html#refartifact131717"><b>pathmanager</b></a>, Component(s) : <a href="index.html#refcomponent129285"><b>RenderPathManager</b></a></p><div class="sub">
|
||||
<a name="refoperation128261"></a>
|
||||
<table><tr><td><div class="element">Operation <b>buildProcessor</b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : + buildProcessor() : <a href="class131461.html#refclass131461"><b>RenderGraph</b></a></li><li>C++ : public: <a href="class131461.html#refclass131461"><b>RenderGraph</b></a> buildProcessor () </li></ul></div>
|
||||
<p>All public operations : <a href="class130437.html#refoperation128261"><b>buildProcessor</b></a> </p>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,25 +0,0 @@
|
|||
<!-- 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>Class BuilderFacade</title>
|
||||
<link rel="stylesheet" href="style.css" type="text/css" />
|
||||
</head>
|
||||
|
||||
<body bgcolor="#ffffff">
|
||||
|
||||
<div class = "title">Class BuilderFacade</div>
|
||||
<p></p>
|
||||
|
||||
<!-- ============================================================= -->
|
||||
|
||||
<a name="refclass130565"></a>
|
||||
<p>Provides unified access to the builder functionality. While individual components of the builder subsystem may be called if necessary or suitable, it is usually better to do all extern invocations via the high level methods of this Facade<br /></p><p>Declaration :</p><ul><li>C++ : class BuilderFacade </li></ul><p>Artifact : <a href="index.html#refartifact130437"><b>builderfacade</b></a>, Component(s) : <a href="index.html#refcomponent128261"><b>Controller</b></a></p><p>Stereotype: boundary</p>
|
||||
<div class="sub">
|
||||
<a name="refoperation128517"></a>
|
||||
<table><tr><td><div class="element">Operation <b>buildEngine</b></div></td></tr></table><p>Main Operation of the Builder: create a render engine for a given part of the timeline<br /></p><p>Declaration :</p><ul><li>Uml : + buildEngine() : <a href="class131333.html#refclass131333"><b>RenderEngine</b></a></li><li>C++ : public: <a href="class131333.html#refclass131333"><b>RenderEngine</b></a> buildEngine () </li></ul></div>
|
||||
<p>All public operations : <a href="class130565.html#refoperation128517"><b>buildEngine</b></a> </p>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,24 +0,0 @@
|
|||
<!-- 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>Class ToolFactory</title>
|
||||
<link rel="stylesheet" href="style.css" type="text/css" />
|
||||
</head>
|
||||
|
||||
<body bgcolor="#ffffff">
|
||||
|
||||
<div class = "title">Class ToolFactory</div>
|
||||
<p></p>
|
||||
|
||||
<!-- ============================================================= -->
|
||||
|
||||
<a name="refclass130693"></a>
|
||||
<p>Declaration :</p><ul><li>C++ : class ToolFactory </li></ul><p>Artifact : <a href="index.html#refartifact130565"><b>toolfactory</b></a></p><div class="sub">
|
||||
<a name="refoperation128773"></a>
|
||||
<table><tr><td><div class="element">Operation <b>configure</b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : + configure() : <a href="class134149.html#refclass134149"><b>BuilderTool</b></a></li><li>C++ : public: <a href="class134149.html#refclass134149"><b>BuilderTool</b></a> configure () </li></ul></div>
|
||||
<p>All public operations : <a href="class130693.html#refoperation128773"><b>configure</b></a> </p>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,24 +0,0 @@
|
|||
<!-- 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>Class ConManager</title>
|
||||
<link rel="stylesheet" href="style.css" type="text/css" />
|
||||
</head>
|
||||
|
||||
<body bgcolor="#ffffff">
|
||||
|
||||
<div class = "title">Class ConManager</div>
|
||||
<p></p>
|
||||
|
||||
<!-- ============================================================= -->
|
||||
|
||||
<a name="refclass130821"></a>
|
||||
<p>Connection Manager, used to build the connections between render engine nodes, if these nodes need to cooperate besides the normal "data pull" operation. Esp., the Connection Manager knows how to wire up the effect's parameters with the corresponding ParamProviders (autmation) in the Session<br /></p><p>Declaration :</p><ul><li>C++ : class ConManager </li></ul><p>Artifact : <a href="index.html#refartifact130693"><b>conmanager</b></a></p><div class="sub">
|
||||
<a name="refoperation129029"></a>
|
||||
<table><tr><td><div class="element">Operation <b>getConnection</b></div></td></tr></table><p>TODO<br /></p><p>Declaration :</p><ul><li>Uml : + getConnection() : int</li><li>C++ : public: int getConnection () </li></ul></div>
|
||||
<p>All public operations : <a href="class130821.html#refoperation129029"><b>getConnection</b></a> </p>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,24 +0,0 @@
|
|||
<!-- 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>Class RenderState</title>
|
||||
<link rel="stylesheet" href="style.css" type="text/css" />
|
||||
</head>
|
||||
|
||||
<body bgcolor="#ffffff">
|
||||
|
||||
<div class = "title">Class RenderState</div>
|
||||
<p></p>
|
||||
|
||||
<!-- ============================================================= -->
|
||||
|
||||
<a name="refclass130949"></a>
|
||||
<p>Encapsulates the logic used to get a "current render process" in accordance to the currentyl applicable controller settings. The provided StateProxy serves to hold any mutalbe state used in the render process, so the rest of the render engine can be stateless.<br /></p><p>Declaration :</p><ul><li>C++ : class RenderState </li></ul><p>Artifact : <a href="index.html#refartifact131845"><b>renderstate</b></a></p><div class="sub">
|
||||
<a name="refoperation128389"></a>
|
||||
<table><tr><td><div class="element">Operation <b>getStateProxy</b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : + getStateProxy() : <a href="class132741.html#refclass132741"><b>State</b></a></li><li>C++ : public: <a href="class132741.html#refclass132741"><b>State</b></a> getStateProxy () </li></ul></div>
|
||||
<p>All public operations : <a href="class130949.html#refoperation128389"><b>getStateProxy</b></a> </p>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,24 +0,0 @@
|
|||
<!-- 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>Class Assembler</title>
|
||||
<link rel="stylesheet" href="style.css" type="text/css" />
|
||||
</head>
|
||||
|
||||
<body bgcolor="#ffffff">
|
||||
|
||||
<div class = "title">Class Assembler</div>
|
||||
<p></p>
|
||||
|
||||
<!-- ============================================================= -->
|
||||
|
||||
<a name="refclass131077"></a>
|
||||
<p>This is the actual building facility: provided the correct tools and associations, it serves to build and connect the individual ProcNode objects<br /></p><p>Declaration :</p><ul><li>C++ : class Assembler </li></ul><p>Artifact : <a href="index.html#refartifact130821"><b>assembler</b></a></p><div class="sub">
|
||||
<a name="refoperation128901"></a>
|
||||
<table><tr><td><div class="element">Operation <b>build</b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : + build() : <a href="class131333.html#refclass131333"><b>RenderEngine</b></a></li><li>C++ : public: <a href="class131333.html#refclass131333"><b>RenderEngine</b></a> build () </li></ul></div>
|
||||
<p>All public operations : <a href="class131077.html#refoperation128901"><b>build</b></a> </p>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,26 +0,0 @@
|
|||
<!-- 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>Class RenderEngine</title>
|
||||
<link rel="stylesheet" href="style.css" type="text/css" />
|
||||
</head>
|
||||
|
||||
<body bgcolor="#ffffff">
|
||||
|
||||
<div class = "title">Class RenderEngine</div>
|
||||
<p></p>
|
||||
|
||||
<!-- ============================================================= -->
|
||||
|
||||
<a name="refclass131333"></a>
|
||||
<p>Declaration :</p><ul><li>C++ : class RenderEngine : public <a href="class131461.html#refclass131461"><b>RenderGraph</b></a> </li></ul><p>Artifact : <a href="index.html#refartifact131973"><b>renderengine</b></a></p><div class="sub">
|
||||
<a name="refoperation129413"></a>
|
||||
<table><tr><td><div class="element">Operation <b>play</b></div></td></tr></table><p>TODO: will probably be handled differently (see Cehteh)<br /></p><p>Declaration :</p><ul><li>Uml : + play() : void</li><li>C++ : public: void play () </li></ul><a name="refrelation132485"></a>
|
||||
<table><tr><td><div class="element">Relation <b>renderSegments (<directional composition>)</b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : - renderSegments : <a href="class131461.html#refclass131461"><b>RenderGraph</b></a>, multiplicity : 0..*</li><li>C++ : private: list<<a href="class131461.html#refclass131461"><b>RenderGraph</b></a>> renderSegments</li></ul><p>Stereotype: list</p>
|
||||
</div>
|
||||
<p>All public operations : <a href="class131333.html#refoperation129413"><b>play</b></a> </p>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,29 +0,0 @@
|
|||
<!-- 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>Class RenderGraph</title>
|
||||
<link rel="stylesheet" href="style.css" type="text/css" />
|
||||
</head>
|
||||
|
||||
<body bgcolor="#ffffff">
|
||||
|
||||
<div class = "title">Class RenderGraph</div>
|
||||
<p></p>
|
||||
|
||||
<!-- ============================================================= -->
|
||||
|
||||
<a name="refclass131461"></a>
|
||||
<p>Declaration :</p><ul><li>C++ : class RenderGraph </li></ul><p>Directly inherited by : <a href="class131333.html#refclass131333"><b>RenderEngine</b></a> </p>
|
||||
<p>Artifact : <a href="index.html#refartifact132101"><b>rendergraph</b></a></p><div class="sub">
|
||||
<a name="refrelation132613"></a>
|
||||
<table><tr><td><div class="element">Relation <b>pipes (<unidirectional association>)</b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : # pipes : <a href="class131589.html#refclass131589"><b>ExitNode</b></a>, multiplicity : 1..*</li><li>C++ : protected: <a href="class131589.html#refclass131589"><b>ExitNode</b></a> * pipes</li></ul><p>Stereotype: list</p>
|
||||
<a name="refattribute129413"></a>
|
||||
<table><tr><td><div class="element">Attribut <b>start</b></div></td></tr></table>
|
||||
<p>begin of the timerange covered by this processor<br /></p><p>Declaration :</p><ul><li>Uml : # start : <a href="class134917.html#refclass134917"><b>Time</b></a></li><li>C++ : protected: <a href="class134917.html#refclass134917"><b>Time</b></a> start</li></ul><a name="refattribute129541"></a>
|
||||
<table><tr><td><div class="element">Attribut <b>end</b></div></td></tr></table>
|
||||
<p>end of the timerange (excl)<br /></p><p>Declaration :</p><ul><li>Uml : # end : <a href="class134917.html#refclass134917"><b>Time</b></a></li><li>C++ : protected: <a href="class134917.html#refclass134917"><b>Time</b></a> end</li></ul></div>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,23 +0,0 @@
|
|||
<!-- 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>Class ExitNode</title>
|
||||
<link rel="stylesheet" href="style.css" type="text/css" />
|
||||
</head>
|
||||
|
||||
<body bgcolor="#ffffff">
|
||||
|
||||
<div class = "title">Class ExitNode</div>
|
||||
<p></p>
|
||||
|
||||
<!-- ============================================================= -->
|
||||
|
||||
<a name="refclass131589"></a>
|
||||
<p>The output of the render pipeline. Pulling from such exit nodes actually ivokes the render process<br /></p><p>Declaration :</p><ul><li>C++ : class ExitNode : public <a href="class131717.html#refclass131717"><b>ProcNode</b></a> </li></ul><p>Artifact : <a href="index.html#refartifact132229"><b>exitnode</b></a></p><div class="sub">
|
||||
</div>
|
||||
<p>All public operations : <a href="class131717.html#refoperation136069"><b>process</b></a> , <a href="class131717.html#refoperation135685"><b>pull</b></a> </p>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,33 +0,0 @@
|
|||
<!-- 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>Class ProcNode</title>
|
||||
<link rel="stylesheet" href="style.css" type="text/css" />
|
||||
</head>
|
||||
|
||||
<body bgcolor="#ffffff">
|
||||
|
||||
<div class = "title">Class ProcNode</div>
|
||||
<p></p>
|
||||
|
||||
<!-- ============================================================= -->
|
||||
|
||||
<a name="refclass131717"></a>
|
||||
<p>Key abstraction of the Render Engine: A Data processing Node<br /></p><p>Declaration :</p><ul><li>C++ : class ProcNode </li><li>Java : public interface ProcNode </li></ul><p>Directly inherited by : <a href="class131589.html#refclass131589"><b>ExitNode</b></a> <a href="class131973.html#refclass131973"><b>Link</b></a> <a href="class133765.html#refclass133765"><b>Source</b></a> <a href="class131845.html#refclass131845"><b>Trafo</b></a> </p>
|
||||
<p>Artifact : <a href="index.html#refartifact132357"><b>procnode</b></a></p><p>Stereotype: interface</p>
|
||||
<div class="sub">
|
||||
<a name="refrelation136965"></a>
|
||||
<table><tr><td><div class="element">Relation <b>datasrc (<unidirectional association>)</b></div></td></tr></table><p>The predecessor in a processing pipeline, i.e. a source to get data to be processed<br /></p><p>Declaration :</p><ul><li>Uml : # datasrc : <a href="class131717.html#refclass131717"><b>ProcNode</b></a></li><li>C++ : protected: <a href="class131717.html#refclass131717"><b>ProcNode</b></a> * datasrc</li></ul><a name="refrelation137861"></a>
|
||||
<table><tr><td><div class="element">Relation <b>params (<directional composition>)</b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : # params : <a href="class134533.html#refclass134533"><b>Parameter</b></a>, multiplicity : 1..*</li><li>C++ : protected: vector<<a href="class134533.html#refclass134533"><b>Parameter</b></a>> params</li></ul><p>Stereotype: vector</p>
|
||||
<a name="refrelation152581"></a>
|
||||
<table><tr><td><div class="element">Relation <b>predecessors (<directional composition>)</b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : # predecessors : <a href="class142725.html#refclass142725"><b>WiringDescriptor</b></a>, multiplicity : *</li><li>C++ : protected: <a href="class142725.html#refclass142725"><b>WiringDescriptor</b></a> predecessors</li></ul><p>Stereotype: array</p>
|
||||
<a name="refoperation135685"></a>
|
||||
<table><tr><td><div class="element">Operation <b>pull</b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : + pull() : </li><li>C++ : public: pull () </li></ul><a name="refoperation136069"></a>
|
||||
<table><tr><td><div class="element">Operation <b>process</b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : + process() : </li><li>C++ : public: process () </li></ul><a name="refrelation166789"></a>
|
||||
<table><tr><td><div class="element">Relation <b><unidirectional association></b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : # : <a href="class142725.html#refclass142725"><b>WiringDescriptor</b></a></li><li>C++ : protected: <a href="class142725.html#refclass142725"><b>WiringDescriptor</b></a>* </li></ul></div>
|
||||
<p>All public operations : <a href="class131717.html#refoperation136069"><b>process</b></a> , <a href="class131717.html#refoperation135685"><b>pull</b></a> </p>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,24 +0,0 @@
|
|||
<!-- 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>Class Trafo</title>
|
||||
<link rel="stylesheet" href="style.css" type="text/css" />
|
||||
</head>
|
||||
|
||||
<body bgcolor="#ffffff">
|
||||
|
||||
<div class = "title">Class Trafo</div>
|
||||
<p></p>
|
||||
|
||||
<!-- ============================================================= -->
|
||||
|
||||
<a name="refclass131845"></a>
|
||||
<p>Declaration :</p><ul><li>C++ : class Trafo : public <a href="class131717.html#refclass131717"><b>ProcNode</b></a> </li></ul><p>Directly inherited by : <a href="class135045.html#refclass135045"><b>CodecAdapter</b></a> <a href="class132357.html#refclass132357"><b>Mask</b></a> <a href="class132485.html#refclass132485"><b>PluginAdapter</b></a> <a href="class132229.html#refclass132229"><b>Projector</b></a> </p>
|
||||
<p>Artifact : <a href="index.html#refartifact132485"><b>trafo</b></a></p><div class="sub">
|
||||
</div>
|
||||
<p>All public operations : <a href="class131717.html#refoperation136069"><b>process</b></a> , <a href="class131717.html#refoperation135685"><b>pull</b></a> </p>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,23 +0,0 @@
|
|||
<!-- 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>Class Link</title>
|
||||
<link rel="stylesheet" href="style.css" type="text/css" />
|
||||
</head>
|
||||
|
||||
<body bgcolor="#ffffff">
|
||||
|
||||
<div class = "title">Class Link</div>
|
||||
<p></p>
|
||||
|
||||
<!-- ============================================================= -->
|
||||
|
||||
<a name="refclass131973"></a>
|
||||
<p>Declaration :</p><ul><li>C++ : class Link : public <a href="class131717.html#refclass131717"><b>ProcNode</b></a> </li></ul><p>Artifact : <a href="index.html#refartifact132613"><b>link</b></a></p><div class="sub">
|
||||
</div>
|
||||
<p>All public operations : <a href="class131717.html#refoperation136069"><b>process</b></a> , <a href="class131717.html#refoperation135685"><b>pull</b></a> </p>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,23 +0,0 @@
|
|||
<!-- 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>Class Projector</title>
|
||||
<link rel="stylesheet" href="style.css" type="text/css" />
|
||||
</head>
|
||||
|
||||
<body bgcolor="#ffffff">
|
||||
|
||||
<div class = "title">Class Projector</div>
|
||||
<p></p>
|
||||
|
||||
<!-- ============================================================= -->
|
||||
|
||||
<a name="refclass132229"></a>
|
||||
<p>Special video processing node used to scale and translate image data.<br /></p><p>Declaration :</p><ul><li>C++ : class Projector : public <a href="class131845.html#refclass131845"><b>Trafo</b></a> </li></ul><p>Artifact : <a href="index.html#refartifact132869"><b>projector</b></a></p><div class="sub">
|
||||
</div>
|
||||
<p>All public operations : <a href="class131717.html#refoperation136069"><b>process</b></a> , <a href="class131717.html#refoperation135685"><b>pull</b></a> </p>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,23 +0,0 @@
|
|||
<!-- 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>Class Mask</title>
|
||||
<link rel="stylesheet" href="style.css" type="text/css" />
|
||||
</head>
|
||||
|
||||
<body bgcolor="#ffffff">
|
||||
|
||||
<div class = "title">Class Mask</div>
|
||||
<p></p>
|
||||
|
||||
<!-- ============================================================= -->
|
||||
|
||||
<a name="refclass132357"></a>
|
||||
<p>Declaration :</p><ul><li>C++ : class Mask : public <a href="class131845.html#refclass131845"><b>Trafo</b></a> </li></ul><p>Artifact : <a href="index.html#refartifact132997"><b>mask</b></a></p><div class="sub">
|
||||
</div>
|
||||
<p>All public operations : <a href="class131717.html#refoperation136069"><b>process</b></a> , <a href="class131717.html#refoperation135685"><b>pull</b></a> </p>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,23 +0,0 @@
|
|||
<!-- 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>Class PluginAdapter</title>
|
||||
<link rel="stylesheet" href="style.css" type="text/css" />
|
||||
</head>
|
||||
|
||||
<body bgcolor="#ffffff">
|
||||
|
||||
<div class = "title">Class PluginAdapter</div>
|
||||
<p></p>
|
||||
|
||||
<!-- ============================================================= -->
|
||||
|
||||
<a name="refclass132485"></a>
|
||||
<p>Adapter used to integrage an effects processor in the render pipeline<br /></p><p>Declaration :</p><ul><li>C++ : class PluginAdapter : public <a href="class131845.html#refclass131845"><b>Trafo</b></a> </li></ul><p>Artifact : <a href="index.html#refartifact133125"><b>pluginadapter</b></a></p><div class="sub">
|
||||
</div>
|
||||
<p>All public operations : <a href="class131717.html#refoperation136069"><b>process</b></a> , <a href="class131717.html#refoperation135685"><b>pull</b></a> </p>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,31 +0,0 @@
|
|||
<!-- 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>Class State</title>
|
||||
<link rel="stylesheet" href="style.css" type="text/css" />
|
||||
</head>
|
||||
|
||||
<body bgcolor="#ffffff">
|
||||
|
||||
<div class = "title">Class State</div>
|
||||
<p></p>
|
||||
|
||||
<!-- ============================================================= -->
|
||||
|
||||
<a name="refclass132741"></a>
|
||||
<p>Declaration :</p><ul><li>C++ : class State </li><li>Java : public interface State </li></ul><p>Directly inherited by : <a href="class142597.html#refclass142597"><b>StateAdapter</b></a> <a href="class142469.html#refclass142469"><b>StateProxy</b></a> </p>
|
||||
<p>Artifact : <a href="index.html#refartifact130949"><b>stateproxy</b></a>, Component(s) : <a href="index.html#refcomponent128005"><b>Builder</b></a></p><p>Stereotype: interface</p>
|
||||
<div class="sub">
|
||||
<a name="refrelation135941"></a>
|
||||
<table><tr><td><div class="element">Relation <b>currFrame (<unidirectional association>)</b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : # currFrame : <a href="class133253.html#refclass133253"><b>Frame</b></a></li><li>C++ : protected: <a href="class133253.html#refclass133253"><b>Frame</b></a> * currFrame</li></ul><p>Stereotype: vector</p>
|
||||
<a name="refoperation135813"></a>
|
||||
<table><tr><td><div class="element">Operation <b>fetch</b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : + fetch() : </li><li>C++ : public: fetch () </li></ul><a name="refoperation135941"></a>
|
||||
<table><tr><td><div class="element">Operation <b>allocateBuffer</b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : + allocateBuffer() : </li><li>C++ : public: allocateBuffer () </li></ul><a name="refoperation136197"></a>
|
||||
<table><tr><td><div class="element">Operation <b>releaseBuffer</b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : + releaseBuffer() : </li><li>C++ : public: releaseBuffer () </li></ul><a name="refoperation136325"></a>
|
||||
<table><tr><td><div class="element">Operation <b>isCalculated</b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : + isCalculated() : </li><li>C++ : public: isCalculated () </li></ul></div>
|
||||
<p>All public operations : <a href="class132741.html#refoperation135941"><b>allocateBuffer</b></a> , <a href="class132741.html#refoperation135813"><b>fetch</b></a> , <a href="class132741.html#refoperation136325"><b>isCalculated</b></a> , <a href="class132741.html#refoperation136197"><b>releaseBuffer</b></a> </p>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,22 +0,0 @@
|
|||
<!-- 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>Class Frame</title>
|
||||
<link rel="stylesheet" href="style.css" type="text/css" />
|
||||
</head>
|
||||
|
||||
<body bgcolor="#ffffff">
|
||||
|
||||
<div class = "title">Class Frame</div>
|
||||
<p></p>
|
||||
|
||||
<!-- ============================================================= -->
|
||||
|
||||
<a name="refclass133253"></a>
|
||||
<p>TODO: how to relate to Cehteh's Frame entity in the Backend?<br />The latter is the fundamental Frame entity, wheras this Object rather represents a buffer set containing frame date<br /></p><p>Declaration :</p><ul><li>C++ : class Frame </li><li>Java : public interface Frame </li></ul><p>Directly inherited by : <a href="class133381.html#refclass133381"><b>AFrame</b></a> <a href="class133637.html#refclass133637"><b>GLBuf</b></a> <a href="class133509.html#refclass133509"><b>VFrame</b></a> </p>
|
||||
<p>Artifact : <a href="index.html#refartifact133765"><b>frame</b></a></p><p>Stereotype: interface</p>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,22 +0,0 @@
|
|||
<!-- 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>Class AFrame</title>
|
||||
<link rel="stylesheet" href="style.css" type="text/css" />
|
||||
</head>
|
||||
|
||||
<body bgcolor="#ffffff">
|
||||
|
||||
<div class = "title">Class AFrame</div>
|
||||
<p></p>
|
||||
|
||||
<!-- ============================================================= -->
|
||||
|
||||
<a name="refclass133381"></a>
|
||||
<p>Declaration :</p><ul><li>C++ : class AFrame : public <a href="class133253.html#refclass133253"><b>Frame</b></a> </li></ul><p>Artifact : <a href="index.html#refartifact133893"><b>aframe</b></a></p><div class="sub">
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,22 +0,0 @@
|
|||
<!-- 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>Class VFrame</title>
|
||||
<link rel="stylesheet" href="style.css" type="text/css" />
|
||||
</head>
|
||||
|
||||
<body bgcolor="#ffffff">
|
||||
|
||||
<div class = "title">Class VFrame</div>
|
||||
<p></p>
|
||||
|
||||
<!-- ============================================================= -->
|
||||
|
||||
<a name="refclass133509"></a>
|
||||
<p>Declaration :</p><ul><li>C++ : class VFrame : public <a href="class133253.html#refclass133253"><b>Frame</b></a> </li></ul><p>Artifact : <a href="index.html#refartifact134021"><b>vframe</b></a></p><div class="sub">
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,22 +0,0 @@
|
|||
<!-- 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>Class GLBuf</title>
|
||||
<link rel="stylesheet" href="style.css" type="text/css" />
|
||||
</head>
|
||||
|
||||
<body bgcolor="#ffffff">
|
||||
|
||||
<div class = "title">Class GLBuf</div>
|
||||
<p></p>
|
||||
|
||||
<!-- ============================================================= -->
|
||||
|
||||
<a name="refclass133637"></a>
|
||||
<p>Declaration :</p><ul><li>C++ : class GLBuf : public <a href="class133253.html#refclass133253"><b>Frame</b></a> </li></ul><p>Artifact : <a href="index.html#refartifact134149"><b>glbuf</b></a></p><div class="sub">
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,23 +0,0 @@
|
|||
<!-- 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>Class Source</title>
|
||||
<link rel="stylesheet" href="style.css" type="text/css" />
|
||||
</head>
|
||||
|
||||
<body bgcolor="#ffffff">
|
||||
|
||||
<div class = "title">Class Source</div>
|
||||
<p></p>
|
||||
|
||||
<!-- ============================================================= -->
|
||||
|
||||
<a name="refclass133765"></a>
|
||||
<p>Source Node: represents a media source to pull data from.<br /></p><p>Declaration :</p><ul><li>C++ : class Source : public <a href="class131717.html#refclass131717"><b>ProcNode</b></a> </li></ul><p>Artifact : <a href="index.html#refartifact134277"><b>source</b></a></p><div class="sub">
|
||||
</div>
|
||||
<p>All public operations : <a href="class131717.html#refoperation136069"><b>process</b></a> , <a href="class131717.html#refoperation135685"><b>pull</b></a> </p>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,28 +0,0 @@
|
|||
<!-- 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>Class RelType</title>
|
||||
<link rel="stylesheet" href="style.css" type="text/css" />
|
||||
</head>
|
||||
|
||||
<body bgcolor="#ffffff">
|
||||
|
||||
<div class = "title">Class RelType</div>
|
||||
<p></p>
|
||||
|
||||
<!-- ============================================================= -->
|
||||
|
||||
<a name="refclass133893"></a>
|
||||
<p>the possible kinds of RelativePlacements<br /></p><p>Declaration :</p><ul><li>C++ : enum RelType </li><li>Java : public enum RelType </li></ul><p>nested in <a href="class129413.html#refclass129413"><b>RelativeLocation</b></a></p>
|
||||
<p>Stereotype: enum</p>
|
||||
<div class="sub">
|
||||
<p>Items :</p><ul>
|
||||
<li>SAMETIME</li>
|
||||
<li>ATTACH</li>
|
||||
</ul>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,26 +0,0 @@
|
|||
<!-- 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>Class Buildable</title>
|
||||
<link rel="stylesheet" href="style.css" type="text/css" />
|
||||
</head>
|
||||
|
||||
<body bgcolor="#ffffff">
|
||||
|
||||
<div class = "title">Class Buildable</div>
|
||||
<p></p>
|
||||
|
||||
<!-- ============================================================= -->
|
||||
|
||||
<a name="refclass134021"></a>
|
||||
<p>Declaration :</p><ul><li>C++ : class Buildable : public <a href="class140165.html#refclass140165"><b>Visitable</b></a> </li><li>Java : public interface Buildable </li></ul><p>Directly inherited by : <a href="class128517.html#refclass128517"><b>MObject</b></a> </p>
|
||||
<p>Artifact : <a href="index.html#refartifact131077"><b>buildable</b></a></p><p>Stereotype: interface</p>
|
||||
<div class="sub">
|
||||
<a name="refoperation129669"></a>
|
||||
<table><tr><td><div class="element">Operation <b>apply</b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : abstract, + apply(inout providedTool : <a href="class134149.html#refclass134149"><b>BuilderTool</b></a>) : void</li><li>C++ : public: virtual void apply (<a href="class134149.html#refclass134149"><b>BuilderTool</b></a>& providedTool) = 0 </li></ul></div>
|
||||
<p>All public operations : <a href="class134021.html#refoperation129669"><b>apply</b></a> , <a href="class140165.html#refoperation134789"><b>apply</b></a> , <a href="class140165.html#refoperation134917"><b>dispatchOp</b></a> </p>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,26 +0,0 @@
|
|||
<!-- 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>Class BuilderTool</title>
|
||||
<link rel="stylesheet" href="style.css" type="text/css" />
|
||||
</head>
|
||||
|
||||
<body bgcolor="#ffffff">
|
||||
|
||||
<div class = "title">Class BuilderTool</div>
|
||||
<p></p>
|
||||
|
||||
<!-- ============================================================= -->
|
||||
|
||||
<a name="refclass134149"></a>
|
||||
<p>Used according to the visitor pattern: each Tool contains the concrete implementation for one task to be done to the various MObject classes<br /></p><p>Declaration :</p><ul><li>C++ : class BuilderTool : public <a href="class140037.html#refclass140037"><b>Tool</b></a>, public <a href="class140293.html#refclass140293"><b>Applicable</b></a><> </li><li>Java : public interface BuilderTool </li></ul><p>Directly inherited by : <a href="class134405.html#refclass134405"><b>NodeCreatorTool</b></a> <a href="class134277.html#refclass134277"><b>SegmentationTool</b></a> </p>
|
||||
<p>Artifact : <a href="index.html#refartifact131205"><b>buildertool</b></a></p><p>Stereotype: interface</p>
|
||||
<div class="sub">
|
||||
<a name="refoperation129797"></a>
|
||||
<table><tr><td><div class="element">Operation <b>treat</b></div></td></tr></table><p>This operation is to be overloaded for the specific MObject subclasses to be treated.<br /></p><p>Declaration :</p><ul><li>Uml : abstract, + treat(in mElement : <a href="class134021.html#refclass134021"><b>Buildable</b></a>) : void</li><li>C++ : public: virtual void treat (const <a href="class134021.html#refclass134021"><b>Buildable</b></a>& mElement) = 0 </li></ul></div>
|
||||
<p>All public operations : <a href="class140293.html#refoperation134405"><b>treat</b></a> , <a href="class134149.html#refoperation129797"><b>treat</b></a> </p>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,30 +0,0 @@
|
|||
<!-- 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>Class SegmentationTool</title>
|
||||
<link rel="stylesheet" href="style.css" type="text/css" />
|
||||
</head>
|
||||
|
||||
<body bgcolor="#ffffff">
|
||||
|
||||
<div class = "title">Class SegmentationTool</div>
|
||||
<p></p>
|
||||
|
||||
<!-- ============================================================= -->
|
||||
|
||||
<a name="refclass134277"></a>
|
||||
<p>Tool implementation for deriving a partitioning of the current timeline such, that each segement has a constant configuration. "Constant" means here, that any remaining changes over time can be represented by automation solely, without the need to change the node connections.<br /></p><p>Declaration :</p><ul><li>C++ : class SegmentationTool : public <a href="class134149.html#refclass134149"><b>BuilderTool</b></a>, public <a href="class140293.html#refclass140293"><b>Applicable</b></a><> </li></ul><p>Artifact : <a href="index.html#refartifact131333"><b>segmentationtool</b></a></p><div class="sub">
|
||||
<a name="refoperation129925"></a>
|
||||
<table><tr><td><div class="element">Operation <b>treat</b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : + treat(in something : <a href="class134021.html#refclass134021"><b>Buildable</b></a>) : void</li><li>C++ : public: void treat (const <a href="class134021.html#refclass134021"><b>Buildable</b></a>& something) </li></ul><a name="refoperation130181"></a>
|
||||
<table><tr><td><div class="element">Operation <b>treat</b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : + treat(in clip : <a href="class128901.html#refclass128901"><b>Clip</b></a>) : void</li><li>C++ : public: void treat (const <a href="class128901.html#refclass128901"><b>Clip</b></a>& clip) </li></ul><a name="refoperation130053"></a>
|
||||
<table><tr><td><div class="element">Operation <b>treat</b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : + treat(in effect : <a href="class129029.html#refclass129029"><b>Effect</b></a>) : void</li><li>C++ : public: void treat (const <a href="class129029.html#refclass129029"><b>Effect</b></a>& effect) </li></ul><a name="refrelation139013"></a>
|
||||
<table><tr><td><div class="element">Relation <b>segments (<directional composition>)</b></div></td></tr></table><p>the partitioning of the Timeline to be created by this tool.<br /></p><p>Declaration :</p><ul><li>Uml : # segments : <a href="class135173.html#refclass135173"><b>Segment</b></a>, multiplicity : *</li><li>C++ : protected: list<<a href="class135173.html#refclass135173"><b>Segment</b></a>> segments</li></ul><p>Stereotype: list</p>
|
||||
<a name="refrelation163461"></a>
|
||||
<table><tr><td><div class="element">Relation <b><unidirectional association></b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : # : <a href="class147333.html#refclass147333"><b>Segmentation</b></a></li><li>C++ : protected: <a href="class147333.html#refclass147333"><b>Segmentation</b></a>* </li></ul><p>Stereotype: create</p>
|
||||
</div>
|
||||
<p>All public operations : <a href="class140293.html#refoperation134405"><b>treat</b></a> , <a href="class134149.html#refoperation129797"><b>treat</b></a> , <a href="class134277.html#refoperation130181"><b>treat</b></a> , <a href="class134277.html#refoperation130053"><b>treat</b></a> , <a href="class134277.html#refoperation129925"><b>treat</b></a> </p>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,29 +0,0 @@
|
|||
<!-- 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>Class NodeCreatorTool</title>
|
||||
<link rel="stylesheet" href="style.css" type="text/css" />
|
||||
</head>
|
||||
|
||||
<body bgcolor="#ffffff">
|
||||
|
||||
<div class = "title">Class NodeCreatorTool</div>
|
||||
<p></p>
|
||||
|
||||
<!-- ============================================================= -->
|
||||
|
||||
<a name="refclass134405"></a>
|
||||
<p>This Tool implementation plays the central role in the buld process: given a MObject from Session, it is able to attach ProcNodes to the render engine under construction such as to reflect the properties of the MObject in the actual render.<br /></p><p>Declaration :</p><ul><li>C++ : class NodeCreatorTool : public <a href="class134149.html#refclass134149"><b>BuilderTool</b></a>, public <a href="class140293.html#refclass140293"><b>Applicable</b></a><> </li></ul><p>Artifact : <a href="index.html#refartifact131461"><b>nodecreatertool</b></a></p><div class="sub">
|
||||
<a name="refoperation130309"></a>
|
||||
<table><tr><td><div class="element">Operation <b>treat</b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : + treat(inout something : <a href="class134021.html#refclass134021"><b>Buildable</b></a>) : void</li><li>C++ : public: void treat (<a href="class134021.html#refclass134021"><b>Buildable</b></a>& something) </li></ul><a name="refoperation130437"></a>
|
||||
<table><tr><td><div class="element">Operation <b>treat</b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : + treat(inout clip : <a href="class128901.html#refclass128901"><b>Clip</b></a>) : void</li><li>C++ : public: void treat (<a href="class128901.html#refclass128901"><b>Clip</b></a>& clip) </li></ul><a name="refoperation130565"></a>
|
||||
<table><tr><td><div class="element">Operation <b>treat</b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : + treat(inout effect : <a href="class129029.html#refclass129029"><b>Effect</b></a>) : void</li><li>C++ : public: void treat (<a href="class129029.html#refclass129029"><b>Effect</b></a>& effect) </li></ul><a name="refoperation130693"></a>
|
||||
<table><tr><td><div class="element">Operation <b>treat</b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : + treat(inout auto : <a href="class129925.html#refclass129925"><b>Auto</b></a>) : void</li><li>C++ : public: void treat (<a href="class129925.html#refclass129925"><b>Auto</b></a>& auto) </li></ul><a name="refattribute129797"></a>
|
||||
<table><tr><td><div class="element">Attribut <b>proc</b></div></td></tr></table>
|
||||
<p>holds the Processor (Render Engine Element) to be built by the current build step<br /></p><p>Declaration :</p><ul><li>Uml : # proc : <a href="class131461.html#refclass131461"><b>RenderGraph</b></a></li><li>C++ : protected: <a href="class131461.html#refclass131461"><b>RenderGraph</b></a> proc</li></ul></div>
|
||||
<p>All public operations : <a href="class140293.html#refoperation134405"><b>treat</b></a> , <a href="class134149.html#refoperation129797"><b>treat</b></a> , <a href="class134405.html#refoperation130437"><b>treat</b></a> , <a href="class134405.html#refoperation130565"><b>treat</b></a> , <a href="class134405.html#refoperation130693"><b>treat</b></a> , <a href="class134405.html#refoperation130309"><b>treat</b></a> </p>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,25 +0,0 @@
|
|||
<!-- 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>Class Parameter</title>
|
||||
<link rel="stylesheet" href="style.css" type="text/css" />
|
||||
</head>
|
||||
|
||||
<body bgcolor="#ffffff">
|
||||
|
||||
<div class = "title">Class Parameter</div>
|
||||
<p></p>
|
||||
|
||||
<!-- ============================================================= -->
|
||||
|
||||
<a name="refclass134533"></a>
|
||||
<p>Descriptor and access object for a plugin parameter. Parameters may be provided with values from the session, and this values may be automated.<br /></p><p>Declaration :</p><ul><li>C++ : template<class VAL> class Parameter </li></ul><p>Artifact : <a href="index.html#refartifact134405"><b>parameter</b></a>, Component(s) : <a href="index.html#refcomponent130053"><b>ProcNode</b></a></p><div class="sub">
|
||||
<a name="refoperation130821"></a>
|
||||
<table><tr><td><div class="element">Operation <b>getValue</b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : + getValue() : VAL</li><li>C++ : public: VAL getValue () const </li></ul><a name="refrelation138629"></a>
|
||||
<table><tr><td><div class="element">Relation <b><association></b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : # provider : <a href="class134661.html#refclass134661"><b>ParamProvider</b></a>, multiplicity : 1</li><li>C++ : protected: <a href="class134661.html#refclass134661"><b>ParamProvider</b></a>* provider</li></ul></div>
|
||||
<p>All public operations : <a href="class134533.html#refoperation130821"><b>getValue</b></a> </p>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,28 +0,0 @@
|
|||
<!-- 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>Class ParamProvider</title>
|
||||
<link rel="stylesheet" href="style.css" type="text/css" />
|
||||
</head>
|
||||
|
||||
<body bgcolor="#ffffff">
|
||||
|
||||
<div class = "title">Class ParamProvider</div>
|
||||
<p></p>
|
||||
|
||||
<!-- ============================================================= -->
|
||||
|
||||
<a name="refclass134661"></a>
|
||||
<p>A facility to get the actual value of a plugin/effect parameter<br /></p><p>Declaration :</p><ul><li>C++ : template<class VAL> class ParamProvider </li><li>Java : public interface ParamProvider<VAL> </li></ul><p>Directly inherited by : <a href="class129925.html#refclass129925"><b>Auto</b></a> </p>
|
||||
<p>Artifact : <a href="index.html#refartifact134533"><b>paramprovider</b></a>, Component(s) : <a href="index.html#refcomponent128133"><b>Session</b></a></p><p>Stereotype: interface</p>
|
||||
<div class="sub">
|
||||
<a name="refrelation137989"></a>
|
||||
<table><tr><td><div class="element">Relation <b>param (<association>)</b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : # param : <a href="class134533.html#refclass134533"><b>Parameter</b></a>, multiplicity : 1</li><li>C++ : protected: <a href="class134533.html#refclass134533"><b>Parameter</b></a>* param</li></ul><a name="refrelation138373"></a>
|
||||
<table><tr><td><div class="element">Relation <b>ipo (<unidirectional association>)</b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : # ipo : <a href="class134789.html#refclass134789"><b>Interpolator</b></a>, multiplicity : 0..1</li><li>C++ : protected: <a href="class134789.html#refclass134789"><b>Interpolator</b></a>* ipo</li></ul><a name="refoperation130949"></a>
|
||||
<table><tr><td><div class="element">Operation <b>getValue</b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : + getValue() : VAL</li><li>C++ : public: VAL getValue () const </li></ul></div>
|
||||
<p>All public operations : <a href="class134661.html#refoperation130949"><b>getValue</b></a> </p>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,20 +0,0 @@
|
|||
<!-- 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>Class Interpolator</title>
|
||||
<link rel="stylesheet" href="style.css" type="text/css" />
|
||||
</head>
|
||||
|
||||
<body bgcolor="#ffffff">
|
||||
|
||||
<div class = "title">Class Interpolator</div>
|
||||
<p></p>
|
||||
|
||||
<!-- ============================================================= -->
|
||||
|
||||
<a name="refclass134789"></a>
|
||||
<p>Provides the implementation for getting the acutal value of a time varying or automated effect/plugin parameter<br /></p><p>Declaration :</p><ul><li>C++ : template<class VAL> class Interpolator </li></ul><p>Artifact : <a href="index.html#refartifact134661"><b>interpolator</b></a></p></body>
|
||||
</html>
|
||||
|
|
@ -1,20 +0,0 @@
|
|||
<!-- 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>Class Time</title>
|
||||
<link rel="stylesheet" href="style.css" type="text/css" />
|
||||
</head>
|
||||
|
||||
<body bgcolor="#ffffff">
|
||||
|
||||
<div class = "title">Class Time</div>
|
||||
<p></p>
|
||||
|
||||
<!-- ============================================================= -->
|
||||
|
||||
<a name="refclass134917"></a>
|
||||
<p>denotes a temporal position (time point), based on timeline start.<br /><br />investigate posix.4 realtime timers, wrap these here<br /></p><p>Declaration :</p><ul><li>C++ : class Time </li></ul><p>Artifact : <a href="index.html#refartifact134789"><b>time</b></a>, Component(s) : <a href="index.html#refcomponent129925"><b>CommonLib</b></a></p></body>
|
||||
</html>
|
||||
|
|
@ -1,23 +0,0 @@
|
|||
<!-- 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>Class CodecAdapter</title>
|
||||
<link rel="stylesheet" href="style.css" type="text/css" />
|
||||
</head>
|
||||
|
||||
<body bgcolor="#ffffff">
|
||||
|
||||
<div class = "title">Class CodecAdapter</div>
|
||||
<p></p>
|
||||
|
||||
<!-- ============================================================= -->
|
||||
|
||||
<a name="refclass135045"></a>
|
||||
<p>Declaration :</p><ul><li>C++ : class CodecAdapter : public <a href="class131845.html#refclass131845"><b>Trafo</b></a> </li></ul><p>Artifact : <a href="index.html#refartifact134917"><b>codecadapter</b></a></p><div class="sub">
|
||||
</div>
|
||||
<p>All public operations : <a href="class131717.html#refoperation136069"><b>process</b></a> , <a href="class131717.html#refoperation135685"><b>pull</b></a> </p>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,30 +0,0 @@
|
|||
<!-- 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>Class Segment</title>
|
||||
<link rel="stylesheet" href="style.css" type="text/css" />
|
||||
</head>
|
||||
|
||||
<body bgcolor="#ffffff">
|
||||
|
||||
<div class = "title">Class Segment</div>
|
||||
<p></p>
|
||||
|
||||
<!-- ============================================================= -->
|
||||
|
||||
<a name="refclass135173"></a>
|
||||
<p>Declaration :</p><ul><li>C++ : class Segment </li></ul><p>Artifact : <a href="index.html#refartifact135045"><b>segment</b></a></p><div class="sub">
|
||||
<a name="refattribute129925"></a>
|
||||
<table><tr><td><div class="element">Attribut <b>start</b></div></td></tr></table>
|
||||
<p>Declaration :</p><ul><li>Uml : # start : <a href="class134917.html#refclass134917"><b>Time</b></a></li><li>C++ : protected: <a href="class134917.html#refclass134917"><b>Time</b></a> start</li></ul><a name="refattribute130053"></a>
|
||||
<table><tr><td><div class="element">Attribut <b>length</b></div></td></tr></table>
|
||||
<p>duration (span) of this timeline segment.<br /></p><p>Declaration :</p><ul><li>Uml : # length : <a href="class134917.html#refclass134917"><b>Time</b></a></li><li>C++ : protected: <a href="class134917.html#refclass134917"><b>Time</b></a> length</li></ul><a name="refrelation138885"></a>
|
||||
<table><tr><td><div class="element">Relation <b>elements (<directional aggregation>)</b></div></td></tr></table><p>relevant MObjects comprising this segment. TODO: actually necessary??<br /></p><p>Declaration :</p><ul><li>Uml : # elements : <a href="class129797.html#refclass129797"><b>ExplicitPlacement</b></a>, multiplicity : *</li><li>C++ : protected: list<<a href="class129797.html#refclass129797"><b>ExplicitPlacement</b></a> *> elements</li></ul><p>Stereotype: list</p>
|
||||
<a name="refrelation163589"></a>
|
||||
<table><tr><td><div class="element">Relation <b><unidirectional association></b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : # : <a href="class131461.html#refclass131461"><b>RenderGraph</b></a></li><li>C++ : protected: <a href="class131461.html#refclass131461"><b>RenderGraph</b></a>* </li></ul><p>Stereotype: correspondance</p>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,20 +0,0 @@
|
|||
<!-- 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>Class Factory</title>
|
||||
<link rel="stylesheet" href="style.css" type="text/css" />
|
||||
</head>
|
||||
|
||||
<body bgcolor="#ffffff">
|
||||
|
||||
<div class = "title">Class Factory</div>
|
||||
<p></p>
|
||||
|
||||
<!-- ============================================================= -->
|
||||
|
||||
<a name="refclass135301"></a>
|
||||
<p>a template for generating functor-like Factory objects, used to encapsulate object creation and providing access via smart-pointers only.<br /></p><p>Declaration :</p><ul><li>C++ : template<class T> class Factory </li></ul></body>
|
||||
</html>
|
||||
|
|
@ -1,29 +0,0 @@
|
|||
<!-- 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>Class Appconfig</title>
|
||||
<link rel="stylesheet" href="style.css" type="text/css" />
|
||||
</head>
|
||||
|
||||
<body bgcolor="#ffffff">
|
||||
|
||||
<div class = "title">Class Appconfig</div>
|
||||
<p></p>
|
||||
|
||||
<!-- ============================================================= -->
|
||||
|
||||
<a name="refclass135429"></a>
|
||||
<p>Singleton to hold inevitable global flags and constants and for performing erarly (static) global initialization tasks.<br /></p><p>Declaration :</p><ul><li>C++ : class Appconfig </li></ul><p>Artifact : <a href="index.html#refartifact135173"><b>appconfig</b></a></p><p>Stereotype: singleton</p>
|
||||
<div class="sub">
|
||||
<a name="refattribute130181"></a>
|
||||
<table><tr><td><div class="element">Attribut <b>theApp_</b></div></td></tr></table>
|
||||
<p>holds the single instance and triggers initialization<br /></p><p>Declaration :</p><ul><li>Uml : static, - theApp_ : <a href="class135429.html#refclass135429"><b>Appconfig</b></a></li><li>C++ : private: static <a href="class135429.html#refclass135429"><b>Appconfig</b></a> theApp_</li></ul><a name="refoperation131333"></a>
|
||||
<table><tr><td><div class="element">Operation <b>Appconfig</b></div></td></tr></table><p>perform initialization on first access. <br />A call is placed in static initialization code<br />included in lumiera.h<br /></p><p>Declaration :</p><ul><li>Uml : - Appconfig() : </li><li>C++ : private: Appconfig () </li></ul><a name="refoperation131461"></a>
|
||||
<table><tr><td><div class="element">Operation <b>instance</b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : static, - instance() : Appconfig*</li><li>C++ : private: static Appconfig* instance () </li></ul><a name="refoperation131589"></a>
|
||||
<table><tr><td><div class="element">Operation <b>get</b></div></td></tr></table><p>access the configuation value for a given key.<br />@return empty string for unknown keys, else the corresponding configuration value<br /></p><p>Declaration :</p><ul><li>Uml : static, + get(inout key : string) : string</li><li>C++ : public: static string get (string & key) </li></ul></div>
|
||||
<p>All public operations : <a href="class135429.html#refoperation131589"><b>get</b></a> </p>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,29 +0,0 @@
|
|||
<!-- 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>Class Error</title>
|
||||
<link rel="stylesheet" href="style.css" type="text/css" />
|
||||
</head>
|
||||
|
||||
<body bgcolor="#ffffff">
|
||||
|
||||
<div class = "title">Class Error</div>
|
||||
<p></p>
|
||||
|
||||
<!-- ============================================================= -->
|
||||
|
||||
<a name="refclass135557"></a>
|
||||
<p>Declaration :</p><ul><li>C++ : class Error : public <a href="class136325.html#refclass136325"><b>std::exception</b></a> </li></ul><p>Directly inherited by : <a href="class135813.html#refclass135813"><b>Config</b></a> <a href="class136197.html#refclass136197"><b>External</b></a> <a href="class136069.html#refclass136069"><b>Invalid</b></a> <a href="class135685.html#refclass135685"><b>Logic</b></a> <a href="class135941.html#refclass135941"><b>State</b></a> </p>
|
||||
<p>Artifact : <a href="index.html#refartifact135813"><b>error</b></a>, Component(s) : <a href="index.html#refcomponent129925"><b>CommonLib</b></a></p><div class="sub">
|
||||
<a name="refoperation131845"></a>
|
||||
<table><tr><td><div class="element">Operation <b>what</b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : + what() : const char*</li><li>C++ : public: virtual const char* what () const </li></ul><a name="refoperation131973"></a>
|
||||
<table><tr><td><div class="element">Operation <b>rootCause</b></div></td></tr></table><p>If this exception was caused by a chain of further exceptions,<br />return the first one registered in this throw sequence.<br />This works only, if every exceptions thrown as a consequence<br />of another exception is propperly constructed by passing<br />the original exception to the constructor<br /></p><p>Declaration :</p><ul><li>Uml : + rootCause() : std::exception</li><li>C++ : public: std::exception rootCause () </li></ul><a name="refattribute130309"></a>
|
||||
<table><tr><td><div class="element">Attribut <b>cause</b></div></td></tr></table>
|
||||
<p>a copy of the first exception encountered in this exception chain<br /></p><p>Declaration :</p><ul><li>Uml : - cause : <a href="class136325.html#refclass136325"><b>std::exception</b></a></li><li>C++ : private: <a href="class136325.html#refclass136325"><b>std::exception</b></a> cause</li></ul><p>Stereotype: auto_ptr</p>
|
||||
</div>
|
||||
<p>All public operations : <a href="class135557.html#refoperation131973"><b>rootCause</b></a> , <a href="class135557.html#refoperation131845"><b>what</b></a> , <a href="class136325.html#refoperation131717"><b>what</b></a> </p>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,23 +0,0 @@
|
|||
<!-- 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>Class Logic</title>
|
||||
<link rel="stylesheet" href="style.css" type="text/css" />
|
||||
</head>
|
||||
|
||||
<body bgcolor="#ffffff">
|
||||
|
||||
<div class = "title">Class Logic</div>
|
||||
<p></p>
|
||||
|
||||
<!-- ============================================================= -->
|
||||
|
||||
<a name="refclass135685"></a>
|
||||
<p>Declaration :</p><ul><li>C++ : class Logic : public <a href="class135557.html#refclass135557"><b>Error</b></a> </li></ul><p>Artifact : <a href="index.html#refartifact135813"><b>error</b></a></p><div class="sub">
|
||||
</div>
|
||||
<p>All public operations : <a href="class135557.html#refoperation131973"><b>rootCause</b></a> , <a href="class135557.html#refoperation131845"><b>what</b></a> , <a href="class136325.html#refoperation131717"><b>what</b></a> </p>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,23 +0,0 @@
|
|||
<!-- 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>Class Config</title>
|
||||
<link rel="stylesheet" href="style.css" type="text/css" />
|
||||
</head>
|
||||
|
||||
<body bgcolor="#ffffff">
|
||||
|
||||
<div class = "title">Class Config</div>
|
||||
<p></p>
|
||||
|
||||
<!-- ============================================================= -->
|
||||
|
||||
<a name="refclass135813"></a>
|
||||
<p>Declaration :</p><ul><li>C++ : class Config : public <a href="class135557.html#refclass135557"><b>Error</b></a> </li></ul><p>Artifact : <a href="index.html#refartifact135813"><b>error</b></a></p><div class="sub">
|
||||
</div>
|
||||
<p>All public operations : <a href="class135557.html#refoperation131973"><b>rootCause</b></a> , <a href="class135557.html#refoperation131845"><b>what</b></a> , <a href="class136325.html#refoperation131717"><b>what</b></a> </p>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,23 +0,0 @@
|
|||
<!-- 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>Class State</title>
|
||||
<link rel="stylesheet" href="style.css" type="text/css" />
|
||||
</head>
|
||||
|
||||
<body bgcolor="#ffffff">
|
||||
|
||||
<div class = "title">Class State</div>
|
||||
<p></p>
|
||||
|
||||
<!-- ============================================================= -->
|
||||
|
||||
<a name="refclass135941"></a>
|
||||
<p>Declaration :</p><ul><li>C++ : class State : public <a href="class135557.html#refclass135557"><b>Error</b></a> </li></ul><p>Artifact : <a href="index.html#refartifact135813"><b>error</b></a></p><div class="sub">
|
||||
</div>
|
||||
<p>All public operations : <a href="class135557.html#refoperation131973"><b>rootCause</b></a> , <a href="class135557.html#refoperation131845"><b>what</b></a> , <a href="class136325.html#refoperation131717"><b>what</b></a> </p>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,23 +0,0 @@
|
|||
<!-- 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>Class Invalid</title>
|
||||
<link rel="stylesheet" href="style.css" type="text/css" />
|
||||
</head>
|
||||
|
||||
<body bgcolor="#ffffff">
|
||||
|
||||
<div class = "title">Class Invalid</div>
|
||||
<p></p>
|
||||
|
||||
<!-- ============================================================= -->
|
||||
|
||||
<a name="refclass136069"></a>
|
||||
<p>Declaration :</p><ul><li>C++ : class Invalid : public <a href="class135557.html#refclass135557"><b>Error</b></a> </li></ul><p>Artifact : <a href="index.html#refartifact135813"><b>error</b></a></p><div class="sub">
|
||||
</div>
|
||||
<p>All public operations : <a href="class135557.html#refoperation131973"><b>rootCause</b></a> , <a href="class135557.html#refoperation131845"><b>what</b></a> , <a href="class136325.html#refoperation131717"><b>what</b></a> </p>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,23 +0,0 @@
|
|||
<!-- 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>Class External</title>
|
||||
<link rel="stylesheet" href="style.css" type="text/css" />
|
||||
</head>
|
||||
|
||||
<body bgcolor="#ffffff">
|
||||
|
||||
<div class = "title">Class External</div>
|
||||
<p></p>
|
||||
|
||||
<!-- ============================================================= -->
|
||||
|
||||
<a name="refclass136197"></a>
|
||||
<p>Declaration :</p><ul><li>C++ : class External : public <a href="class135557.html#refclass135557"><b>Error</b></a> </li></ul><p>Artifact : <a href="index.html#refartifact135813"><b>error</b></a></p><div class="sub">
|
||||
</div>
|
||||
<p>All public operations : <a href="class135557.html#refoperation131973"><b>rootCause</b></a> , <a href="class135557.html#refoperation131845"><b>what</b></a> , <a href="class136325.html#refoperation131717"><b>what</b></a> </p>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,26 +0,0 @@
|
|||
<!-- 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>Class std::exception</title>
|
||||
<link rel="stylesheet" href="style.css" type="text/css" />
|
||||
</head>
|
||||
|
||||
<body bgcolor="#ffffff">
|
||||
|
||||
<div class = "title">Class std::exception</div>
|
||||
<p></p>
|
||||
|
||||
<!-- ============================================================= -->
|
||||
|
||||
<a name="refclass136325"></a>
|
||||
<p>Declaration :</p><ul><li>C++ : class std::exception </li></ul><p>Directly inherited by : <a href="class135557.html#refclass135557"><b>Error</b></a> </p>
|
||||
<p>Stereotype: auxiliary</p>
|
||||
<div class="sub">
|
||||
<a name="refoperation131717"></a>
|
||||
<table><tr><td><div class="element">Operation <b>what</b></div></td></tr></table><p>the base class of all exceptions thrown by the standard library<br /></p><p>Declaration :</p><ul><li>Uml : + what() : const char*</li><li>C++ : public: virtual const char* what () const </li></ul></div>
|
||||
<p>All public operations : <a href="class136325.html#refoperation131717"><b>what</b></a> </p>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,44 +0,0 @@
|
|||
<!-- 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>Class Asset</title>
|
||||
<link rel="stylesheet" href="style.css" type="text/css" />
|
||||
</head>
|
||||
|
||||
<body bgcolor="#ffffff">
|
||||
|
||||
<div class = "title">Class Asset</div>
|
||||
<p></p>
|
||||
|
||||
<!-- ============================================================= -->
|
||||
|
||||
<a name="refclass136453"></a>
|
||||
<p>Superinterface describing especially the bookeeping properties of Assets<br /></p><p>Declaration :</p><ul><li>C++ : class Asset </li><li>Java : public interface Asset </li></ul><p>Directly inherited by : <a href="class136709.html#refclass136709"><b>Media</b></a> <a href="class137093.html#refclass137093"><b>Meta</b></a> <a href="class136837.html#refclass136837"><b>Proc</b></a> <a href="class136965.html#refclass136965"><b>Struct</b></a> </p>
|
||||
<p>Artifact : <a href="index.html#refartifact136069"><b>asset</b></a></p><p>Stereotype: interface</p>
|
||||
<div class="sub">
|
||||
<a name="refattribute130437"></a>
|
||||
<table><tr><td><div class="element">Attribut <b>id</b></div></td></tr></table>
|
||||
<p>Asset primary key.<br /></p><p>Declaration :</p><ul><li>Uml : + id : long</li><li>C++ : public: const long id</li></ul><a name="refattribute130565"></a>
|
||||
<table><tr><td><div class="element">Attribut <b>name</b></div></td></tr></table>
|
||||
<p>element ID, comprehensible but sanitized. The tuple (category, name, org) is unique.<br /></p><p>Declaration :</p><ul><li>Uml : + name : string</li><li>C++ : public: const string name</li></ul><a name="refrelation140421"></a>
|
||||
<table><tr><td><div class="element">Relation <b>category (<unidirectional association>)</b></div></td></tr></table><p>primary tree like classification of the asset<br /></p><p>Declaration :</p><ul><li>Uml : + category : <a href="class137221.html#refclass137221"><b>Category</b></a>, multiplicity : 1</li><li>C++ : public: const <a href="class137221.html#refclass137221"><b>Category</b></a>* category</li></ul><a name="refattribute130821"></a>
|
||||
<table><tr><td><div class="element">Attribut <b>org</b></div></td></tr></table>
|
||||
<p>origin or authorship id. Can be a project abbreviation, a package id or just the authors nickname or UID. This allows for the compnent name to be more generic (e.g. "blur"). Default for all assets provided by the core Lumiera codebase is "lumi".<br /></p><p>Declaration :</p><ul><li>Uml : + org : string</li><li>C++ : public: const string org</li></ul><a name="refattribute130949"></a>
|
||||
<table><tr><td><div class="element">Attribut <b>version</b></div></td></tr></table>
|
||||
<p>version number of the thing or concept represented by this asset. Of each unique tuple (name, category, org) there will be only one version in the whole system. Version 0 is reserved for internal purposes. Versions are considered to be ordered, and any higher version is supposed to be fully backwards compatible to all previous versions.<br /></p><p>Declaration :</p><ul><li>Uml : + version : uint</li><li>C++ : public: const unsigned int version</li></ul><a name="refattribute131077"></a>
|
||||
<table><tr><td><div class="element">Attribut <b>groups</b></div></td></tr></table>
|
||||
<p>additional classification, selections or departments this asset belongs to. Groups are optional, non-exclusive and may be overlapping.<br /></p><p>Declaration :</p><ul><li>Uml : # groups : set<string></li><li>C++ : protected: set<string> groups</li></ul><a name="refattribute131205"></a>
|
||||
<table><tr><td><div class="element">Attribut <b>shortDesc</b></div></td></tr></table>
|
||||
<p>user visible Name-ID. To be localized.<br /></p><p>Declaration :</p><ul><li>Uml : # shortDesc : string</li><li>C++ : protected: const string shortDesc</li></ul><a name="refattribute131333"></a>
|
||||
<table><tr><td><div class="element">Attribut <b>longDesc</b></div></td></tr></table>
|
||||
<p>user visible qualification of the thing, unit or concept represented by this asset. perferably "in one line". To be localized.<br /></p><p>Declaration :</p><ul><li>Uml : # longDesc : string</li><li>C++ : protected: const string longDesc</li></ul><a name="refoperation132101"></a>
|
||||
<table><tr><td><div class="element">Operation <b>getParents</b></div></td></tr></table><p>List of entities this asset depends on or requires to be functional. May be empty. The head of this list can be considered the primary prerequisite<br /></p><p>Declaration :</p><ul><li>Uml : + getParents() : vector<PAsset></li><li>C++ : public: vector<PAsset> getParents () </li></ul><a name="refoperation132229"></a>
|
||||
<table><tr><td><div class="element">Operation <b>getDependant</b></div></td></tr></table><p>All the other assets requiring this asset to be functional. For example, all the clips depending on a given media file. May be empty. The dependency relation is transitive.<br /></p><p>Declaration :</p><ul><li>Uml : + getDependant() : vector<PAsset></li><li>C++ : public: vector<PAsset> getDependant () </li></ul><a name="refoperation132869"></a>
|
||||
<table><tr><td><div class="element">Operation <b>isActive</b></div></td></tr></table><p>weather this asset is swithced on and consequently included in the fixture and participates in rendering<br /></p><p>Declaration :</p><ul><li>Uml : + isActive() : bool</li><li>C++ : public: bool isActive () </li></ul><a name="refoperation132997"></a>
|
||||
<table><tr><td><div class="element">Operation <b>enable</b></div></td></tr></table><p>change the enabled status of this asset. Note the corresponding #isActive predicate may depend on the enablement status of parent assets as well<br /></p><p>Declaration :</p><ul><li>Uml : + enable(in bool : ) : void, exceptions : <a href="class135941.html#refclass135941"><b>State</b></a></li><li>C++ : public: void enable () throw (<a href="class135941.html#refclass135941"><b>State</b></a>)</li></ul></div>
|
||||
<p>All public operations : <a href="class136453.html#refoperation132997"><b>enable</b></a> , <a href="class136453.html#refoperation132229"><b>getDependant</b></a> , <a href="class136453.html#refoperation132101"><b>getParents</b></a> , <a href="class136453.html#refoperation132869"><b>isActive</b></a> </p>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,30 +0,0 @@
|
|||
<!-- 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>Class AssetManager</title>
|
||||
<link rel="stylesheet" href="style.css" type="text/css" />
|
||||
</head>
|
||||
|
||||
<body bgcolor="#ffffff">
|
||||
|
||||
<div class = "title">Class AssetManager</div>
|
||||
<p></p>
|
||||
|
||||
<!-- ============================================================= -->
|
||||
|
||||
<a name="refclass136581"></a>
|
||||
<p>Facade for the Asset subsystem<br /></p><p>Declaration :</p><ul><li>C++ : class AssetManager </li></ul><p>Artifact : <a href="index.html#refartifact136197"><b>assetmanager</b></a></p><p>Stereotype: boundary</p>
|
||||
<div class="sub">
|
||||
<a name="refoperation133125"></a>
|
||||
<table><tr><td><div class="element">Operation <b>getID</b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : static, + getID(in idi : <a href="class136453.html#refclass136453"><b>Asset</b></a>) : </li><li>C++ : public: static getID () </li></ul><a name="refoperation132485"></a>
|
||||
<table><tr><td><div class="element">Operation <b>getAsset</b></div></td></tr></table><p>find and return corresponging object<br /></p><p>Declaration :</p><ul><li>Uml : + getAsset(in id : long) : KIND, exceptions : <a href="class136069.html#refclass136069"><b>Invalid</b></a></li><li>C++ : public: template<class KIND> KIND getAsset (long & id) throw (<a href="class136069.html#refclass136069"><b>Invalid</b></a>)</li></ul><a name="refoperation132613"></a>
|
||||
<table><tr><td><div class="element">Operation <b>known</b></div></td></tr></table><p>@return true if the given id is registered in the internal asset DB<br /></p><p>Declaration :</p><ul><li>Uml : + known(in id : long) : bool</li><li>C++ : public: bool known (long id) </li></ul><a name="refoperation132741"></a>
|
||||
<table><tr><td><div class="element">Operation <b>remove</b></div></td></tr></table><p>remove the given asset <i>together with all its dependants</i> from the internal DB<br /></p><p>Declaration :</p><ul><li>Uml : + remove(in id : long) : void, exceptions : <a href="class136069.html#refclass136069"><b>Invalid</b></a>, <a href="class135941.html#refclass135941"><b>State</b></a></li><li>C++ : public: void remove (long id) throw (<a href="class136069.html#refclass136069"><b>Invalid</b></a>, <a href="class135941.html#refclass135941"><b>State</b></a>)</li></ul><a name="refoperation132357"></a>
|
||||
<table><tr><td><div class="element">Operation <b>reg</b></div></td></tr></table><p>registers an asset object in the internal DB, providing its unique key<br /></p><p>Declaration :</p><ul><li>Uml : static, # reg(inout name : string, inout category : string, inout org : string, inout uint : version) : long, exceptions : Invalid</li><li>C++ : protected: static long reg (string & name, string & category, string & org, version& uint) throw (Invalid)</li></ul><a name="refrelation142085"></a>
|
||||
<table><tr><td><div class="element">Relation <b>registry (<unidirectional association>)</b></div></td></tr></table><p>@internal Table or DB holding all registered asset instances.<br /></p><p>Declaration :</p><ul><li>Uml : # registry : <a href="class138373.html#refclass138373"><b>DB</b></a>, multiplicity : 1</li><li>C++ : protected: <a href="class138373.html#refclass138373"><b>DB</b></a>* registry</li></ul></div>
|
||||
<p>All public operations : <a href="class136581.html#refoperation132485"><b>getAsset</b></a> , <a href="class136581.html#refoperation133125"><b>getID</b></a> , <a href="class136581.html#refoperation132613"><b>known</b></a> , <a href="class136581.html#refoperation132741"><b>remove</b></a> </p>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,26 +0,0 @@
|
|||
<!-- 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>Class Media</title>
|
||||
<link rel="stylesheet" href="style.css" type="text/css" />
|
||||
</head>
|
||||
|
||||
<body bgcolor="#ffffff">
|
||||
|
||||
<div class = "title">Class Media</div>
|
||||
<p></p>
|
||||
|
||||
<!-- ============================================================= -->
|
||||
|
||||
<a name="refclass136709"></a>
|
||||
<p>key abstraction: media-like assets<br /></p><p>Declaration :</p><ul><li>C++ : class Media : public <a href="class136453.html#refclass136453"><b>Asset</b></a> </li></ul><p>Directly inherited by : <a href="class138501.html#refclass138501"><b>CompoundMedia</b></a> <a href="class137477.html#refclass137477"><b>Unknown</b></a> </p>
|
||||
<p>Artifact : <a href="index.html#refartifact136453"><b>media</b></a></p><div class="sub">
|
||||
<a name="refoperation133253"></a>
|
||||
<table><tr><td><div class="element">Operation <b>createClip</b></div></td></tr></table><p>create a (possibly compound) Clip refering to this media, ready to be added to the EDL.<br /></p><p>Declaration :</p><ul><li>Uml : + createClip() : <a href="class128901.html#refclass128901"><b>Clip</b></a></li><li>C++ : public: <a href="class128901.html#refclass128901"><b>Clip</b></a> createClip () </li></ul><a name="refoperation133381"></a>
|
||||
<table><tr><td><div class="element">Operation <b>howtoProc</b></div></td></tr></table><p>@return descriptor how to build a render pipeline corresponding to this media<br /></p><p>Declaration :</p><ul><li>Uml : + howtoProc() : <a href="class138757.html#refclass138757"><b>ProcPatt</b></a></li><li>C++ : public: <a href="class138757.html#refclass138757"><b>ProcPatt</b></a> howtoProc () </li></ul></div>
|
||||
<p>All public operations : <a href="class136709.html#refoperation133253"><b>createClip</b></a> , <a href="class136453.html#refoperation132997"><b>enable</b></a> , <a href="class136453.html#refoperation132229"><b>getDependant</b></a> , <a href="class136453.html#refoperation132101"><b>getParents</b></a> , <a href="class136709.html#refoperation133381"><b>howtoProc</b></a> , <a href="class136453.html#refoperation132869"><b>isActive</b></a> </p>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,24 +0,0 @@
|
|||
<!-- 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>Class Proc</title>
|
||||
<link rel="stylesheet" href="style.css" type="text/css" />
|
||||
</head>
|
||||
|
||||
<body bgcolor="#ffffff">
|
||||
|
||||
<div class = "title">Class Proc</div>
|
||||
<p></p>
|
||||
|
||||
<!-- ============================================================= -->
|
||||
|
||||
<a name="refclass136837"></a>
|
||||
<p>key abstraction: data processing asset<br /></p><p>Declaration :</p><ul><li>C++ : class Proc : public <a href="class136453.html#refclass136453"><b>Asset</b></a> </li></ul><p>Directly inherited by : <a href="class137861.html#refclass137861"><b>Codec</b></a> <a href="class137733.html#refclass137733"><b>Effect</b></a> </p>
|
||||
<p>Artifact : <a href="index.html#refartifact136581"><b>proc</b></a></p><div class="sub">
|
||||
</div>
|
||||
<p>All public operations : <a href="class136453.html#refoperation132997"><b>enable</b></a> , <a href="class136453.html#refoperation132229"><b>getDependant</b></a> , <a href="class136453.html#refoperation132101"><b>getParents</b></a> , <a href="class136453.html#refoperation132869"><b>isActive</b></a> </p>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,24 +0,0 @@
|
|||
<!-- 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>Class Struct</title>
|
||||
<link rel="stylesheet" href="style.css" type="text/css" />
|
||||
</head>
|
||||
|
||||
<body bgcolor="#ffffff">
|
||||
|
||||
<div class = "title">Class Struct</div>
|
||||
<p></p>
|
||||
|
||||
<!-- ============================================================= -->
|
||||
|
||||
<a name="refclass136965"></a>
|
||||
<p>key abstraction: structural asset<br /></p><p>Declaration :</p><ul><li>C++ : class Struct : public <a href="class136453.html#refclass136453"><b>Asset</b></a> </li></ul><p>Directly inherited by : <a href="class138117.html#refclass138117"><b>Pipe</b></a> <a href="class138757.html#refclass138757"><b>ProcPatt</b></a> <a href="class152197.html#refclass152197"><b>Sequence</b></a> <a href="class160901.html#refclass160901"><b>Timeline</b></a> </p>
|
||||
<p>Artifact : <a href="index.html#refartifact136709"><b>struct</b></a></p><div class="sub">
|
||||
</div>
|
||||
<p>All public operations : <a href="class136453.html#refoperation132997"><b>enable</b></a> , <a href="class136453.html#refoperation132229"><b>getDependant</b></a> , <a href="class136453.html#refoperation132101"><b>getParents</b></a> , <a href="class136453.html#refoperation132869"><b>isActive</b></a> </p>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,24 +0,0 @@
|
|||
<!-- 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>Class Meta</title>
|
||||
<link rel="stylesheet" href="style.css" type="text/css" />
|
||||
</head>
|
||||
|
||||
<body bgcolor="#ffffff">
|
||||
|
||||
<div class = "title">Class Meta</div>
|
||||
<p></p>
|
||||
|
||||
<!-- ============================================================= -->
|
||||
|
||||
<a name="refclass137093"></a>
|
||||
<p>key abstraction: metadata and organisational asset<br /></p><p>Declaration :</p><ul><li>C++ : class Meta : public <a href="class136453.html#refclass136453"><b>Asset</b></a> </li></ul><p>Directly inherited by : <a href="class138245.html#refclass138245"><b>Dataset</b></a> <a href="class160773.html#refclass160773"><b>Inventory</b></a> </p>
|
||||
<p>Artifact : <a href="index.html#refartifact136837"><b>meta</b></a></p><div class="sub">
|
||||
</div>
|
||||
<p>All public operations : <a href="class136453.html#refoperation132997"><b>enable</b></a> , <a href="class136453.html#refoperation132229"><b>getDependant</b></a> , <a href="class136453.html#refoperation132101"><b>getParents</b></a> , <a href="class136453.html#refoperation132869"><b>isActive</b></a> </p>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,20 +0,0 @@
|
|||
<!-- 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>Class Category</title>
|
||||
<link rel="stylesheet" href="style.css" type="text/css" />
|
||||
</head>
|
||||
|
||||
<body bgcolor="#ffffff">
|
||||
|
||||
<div class = "title">Class Category</div>
|
||||
<p></p>
|
||||
|
||||
<!-- ============================================================= -->
|
||||
|
||||
<a name="refclass137221"></a>
|
||||
<p>tree like classification of Assets<br /></p><p>Declaration :</p><ul><li>C++ : class Category </li></ul><p>Artifact : <a href="index.html#refartifact135941"><b>category</b></a></p></body>
|
||||
</html>
|
||||
|
|
@ -1,24 +0,0 @@
|
|||
<!-- 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>Class Unknown</title>
|
||||
<link rel="stylesheet" href="style.css" type="text/css" />
|
||||
</head>
|
||||
|
||||
<body bgcolor="#ffffff">
|
||||
|
||||
<div class = "title">Class Unknown</div>
|
||||
<p></p>
|
||||
|
||||
<!-- ============================================================= -->
|
||||
|
||||
<a name="refclass137477"></a>
|
||||
<p>placeholder for unknown or unavailable media source<br /></p><p>Declaration :</p><ul><li>C++ : class Unknown : public <a href="class136709.html#refclass136709"><b>Media</b></a> </li></ul><p>Directly inherited by : <a href="class137605.html#refclass137605"><b>Preview</b></a> </p>
|
||||
<p>Artifact : <a href="index.html#refartifact137093"><b>unknown</b></a></p><div class="sub">
|
||||
</div>
|
||||
<p>All public operations : <a href="class136709.html#refoperation133253"><b>createClip</b></a> , <a href="class136453.html#refoperation132997"><b>enable</b></a> , <a href="class136453.html#refoperation132229"><b>getDependant</b></a> , <a href="class136453.html#refoperation132101"><b>getParents</b></a> , <a href="class136709.html#refoperation133381"><b>howtoProc</b></a> , <a href="class136453.html#refoperation132869"><b>isActive</b></a> </p>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,23 +0,0 @@
|
|||
<!-- 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>Class Preview</title>
|
||||
<link rel="stylesheet" href="style.css" type="text/css" />
|
||||
</head>
|
||||
|
||||
<body bgcolor="#ffffff">
|
||||
|
||||
<div class = "title">Class Preview</div>
|
||||
<p></p>
|
||||
|
||||
<!-- ============================================================= -->
|
||||
|
||||
<a name="refclass137605"></a>
|
||||
<p>alternative version of the media data, probably with lower resolution<br /></p><p>Declaration :</p><ul><li>C++ : class Preview : public <a href="class137477.html#refclass137477"><b>Unknown</b></a> </li></ul><p>Artifact : <a href="index.html#refartifact136965"><b>preview</b></a></p><div class="sub">
|
||||
</div>
|
||||
<p>All public operations : <a href="class136709.html#refoperation133253"><b>createClip</b></a> , <a href="class136453.html#refoperation132997"><b>enable</b></a> , <a href="class136453.html#refoperation132229"><b>getDependant</b></a> , <a href="class136453.html#refoperation132101"><b>getParents</b></a> , <a href="class136709.html#refoperation133381"><b>howtoProc</b></a> , <a href="class136453.html#refoperation132869"><b>isActive</b></a> </p>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,23 +0,0 @@
|
|||
<!-- 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>Class Effect</title>
|
||||
<link rel="stylesheet" href="style.css" type="text/css" />
|
||||
</head>
|
||||
|
||||
<body bgcolor="#ffffff">
|
||||
|
||||
<div class = "title">Class Effect</div>
|
||||
<p></p>
|
||||
|
||||
<!-- ============================================================= -->
|
||||
|
||||
<a name="refclass137733"></a>
|
||||
<p>Effect or media processing component<br /></p><p>Declaration :</p><ul><li>C++ : class Effect : public <a href="class136837.html#refclass136837"><b>Proc</b></a> </li></ul><p>Artifact : <a href="index.html#refartifact137221"><b>effect</b></a></p><div class="sub">
|
||||
</div>
|
||||
<p>All public operations : <a href="class136453.html#refoperation132997"><b>enable</b></a> , <a href="class136453.html#refoperation132229"><b>getDependant</b></a> , <a href="class136453.html#refoperation132101"><b>getParents</b></a> , <a href="class136453.html#refoperation132869"><b>isActive</b></a> </p>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,23 +0,0 @@
|
|||
<!-- 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>Class Codec</title>
|
||||
<link rel="stylesheet" href="style.css" type="text/css" />
|
||||
</head>
|
||||
|
||||
<body bgcolor="#ffffff">
|
||||
|
||||
<div class = "title">Class Codec</div>
|
||||
<p></p>
|
||||
|
||||
<!-- ============================================================= -->
|
||||
|
||||
<a name="refclass137861"></a>
|
||||
<p>description of some media data decoder or encoder facility<br /></p><p>Declaration :</p><ul><li>C++ : class Codec : public <a href="class136837.html#refclass136837"><b>Proc</b></a> </li></ul><p>Artifact : <a href="index.html#refartifact137349"><b>codec</b></a></p><div class="sub">
|
||||
</div>
|
||||
<p>All public operations : <a href="class136453.html#refoperation132997"><b>enable</b></a> , <a href="class136453.html#refoperation132229"><b>getDependant</b></a> , <a href="class136453.html#refoperation132101"><b>getParents</b></a> , <a href="class136453.html#refoperation132869"><b>isActive</b></a> </p>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,24 +0,0 @@
|
|||
<!-- 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>Class Pipe</title>
|
||||
<link rel="stylesheet" href="style.css" type="text/css" />
|
||||
</head>
|
||||
|
||||
<body bgcolor="#ffffff">
|
||||
|
||||
<div class = "title">Class Pipe</div>
|
||||
<p></p>
|
||||
|
||||
<!-- ============================================================= -->
|
||||
|
||||
<a name="refclass138117"></a>
|
||||
<p>structural asset representing a basic building block within the high level model: a port for building a processing chain and generating media output<br /></p><p>Declaration :</p><ul><li>C++ : class Pipe : public <a href="class136965.html#refclass136965"><b>Struct</b></a> </li></ul><p>Artifact : <a href="index.html#refartifact137605"><b>pipe</b></a></p><div class="sub">
|
||||
<a name="refrelation148229"></a>
|
||||
<table><tr><td><div class="element">Relation <b>wiringTemplate (<unidirectional association>)</b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : # wiringTemplate : <a href="class138757.html#refclass138757"><b>ProcPatt</b></a>, multiplicity : 0..1</li><li>C++ : protected: <a href="class138757.html#refclass138757"><b>ProcPatt</b></a>* wiringTemplate</li></ul></div>
|
||||
<p>All public operations : <a href="class136453.html#refoperation132997"><b>enable</b></a> , <a href="class136453.html#refoperation132229"><b>getDependant</b></a> , <a href="class136453.html#refoperation132101"><b>getParents</b></a> , <a href="class136453.html#refoperation132869"><b>isActive</b></a> </p>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,23 +0,0 @@
|
|||
<!-- 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>Class Dataset</title>
|
||||
<link rel="stylesheet" href="style.css" type="text/css" />
|
||||
</head>
|
||||
|
||||
<body bgcolor="#ffffff">
|
||||
|
||||
<div class = "title">Class Dataset</div>
|
||||
<p></p>
|
||||
|
||||
<!-- ============================================================= -->
|
||||
|
||||
<a name="refclass138245"></a>
|
||||
<p>meta asset describing a collection of control data<br /></p><p>Declaration :</p><ul><li>C++ : class Dataset : public <a href="class137093.html#refclass137093"><b>Meta</b></a> </li></ul><p>Artifact : <a href="index.html#refartifact137733"><b>dataset</b></a></p><div class="sub">
|
||||
</div>
|
||||
<p>All public operations : <a href="class136453.html#refoperation132997"><b>enable</b></a> , <a href="class136453.html#refoperation132229"><b>getDependant</b></a> , <a href="class136453.html#refoperation132101"><b>getParents</b></a> , <a href="class136453.html#refoperation132869"><b>isActive</b></a> </p>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,20 +0,0 @@
|
|||
<!-- 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>Class DB</title>
|
||||
<link rel="stylesheet" href="style.css" type="text/css" />
|
||||
</head>
|
||||
|
||||
<body bgcolor="#ffffff">
|
||||
|
||||
<div class = "title">Class DB</div>
|
||||
<p></p>
|
||||
|
||||
<!-- ============================================================= -->
|
||||
|
||||
<a name="refclass138373"></a>
|
||||
<p>Implementation of the registry holding all Asset instances known to the Asset Manager subsystem. As of 8/2007 implemented by a hashtable.<br /></p><p>Declaration :</p><ul><li>C++ : class DB </li></ul><p>Artifact : <a href="index.html#refartifact137861"><b>db</b></a></p></body>
|
||||
</html>
|
||||
|
|
@ -1,26 +0,0 @@
|
|||
<!-- 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>Class CompoundMedia</title>
|
||||
<link rel="stylesheet" href="style.css" type="text/css" />
|
||||
</head>
|
||||
|
||||
<body bgcolor="#ffffff">
|
||||
|
||||
<div class = "title">Class CompoundMedia</div>
|
||||
<p></p>
|
||||
|
||||
<!-- ============================================================= -->
|
||||
|
||||
<a name="refclass138501"></a>
|
||||
<p>compound of several elementary media tracks,<br />e.g. the individual media streams found in one media file<br /></p><p>Declaration :</p><ul><li>C++ : class CompoundMedia : public <a href="class136709.html#refclass136709"><b>Media</b></a> </li></ul><p>Directly inherited by : <a href="class160389.html#refclass160389"><b>VirtualMedia</b></a> </p>
|
||||
<p>Artifact : <a href="index.html#refartifact138245"><b>compoundmedia</b></a></p><div class="sub">
|
||||
<a name="refrelation142341"></a>
|
||||
<table><tr><td><div class="element">Relation <b>channels (<directional aggregation>)</b></div></td></tr></table><p>elementary media assets comprising this compound<br /></p><p>Declaration :</p><ul><li>Uml : # channels : <a href="class136709.html#refclass136709"><b>Media</b></a>, multiplicity : 1..*</li><li>C++ : protected: vector<<a href="class136709.html#refclass136709"><b>Media</b></a> *> channels</li></ul><p>Stereotype: vector</p>
|
||||
</div>
|
||||
<p>All public operations : <a href="class136709.html#refoperation133253"><b>createClip</b></a> , <a href="class136453.html#refoperation132997"><b>enable</b></a> , <a href="class136453.html#refoperation132229"><b>getDependant</b></a> , <a href="class136453.html#refoperation132101"><b>getParents</b></a> , <a href="class136709.html#refoperation133381"><b>howtoProc</b></a> , <a href="class136453.html#refoperation132869"><b>isActive</b></a> </p>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,25 +0,0 @@
|
|||
<!-- 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>Class ProcPatt</title>
|
||||
<link rel="stylesheet" href="style.css" type="text/css" />
|
||||
</head>
|
||||
|
||||
<body bgcolor="#ffffff">
|
||||
|
||||
<div class = "title">Class ProcPatt</div>
|
||||
<p></p>
|
||||
|
||||
<!-- ============================================================= -->
|
||||
|
||||
<a name="refclass138757"></a>
|
||||
<p>special type of structural Asset representing information how to build some part of the render engine's processing nodes network.<br /></p><p>Declaration :</p><ul><li>C++ : class ProcPatt : public <a href="class136965.html#refclass136965"><b>Struct</b></a> </li></ul><p>Artifact : <a href="index.html#refartifact137989"><b>procpatt</b></a></p><div class="sub">
|
||||
<a name="refrelation143621"></a>
|
||||
<table><tr><td><div class="element">Relation <b>instructions (<directional composition>)</b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : # instructions : <a href="class139013.html#refclass139013"><b>BuildInstruct</b></a>, multiplicity : 1..*</li><li>C++ : protected: const vector<<a href="class139013.html#refclass139013"><b>BuildInstruct</b></a>> instructions</li></ul><p>Stereotype: vector</p>
|
||||
</div>
|
||||
<p>All public operations : <a href="class136453.html#refoperation132997"><b>enable</b></a> , <a href="class136453.html#refoperation132229"><b>getDependant</b></a> , <a href="class136453.html#refoperation132101"><b>getParents</b></a> , <a href="class136453.html#refoperation132869"><b>isActive</b></a> </p>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,21 +0,0 @@
|
|||
<!-- 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>Class BuildInstruct</title>
|
||||
<link rel="stylesheet" href="style.css" type="text/css" />
|
||||
</head>
|
||||
|
||||
<body bgcolor="#ffffff">
|
||||
|
||||
<div class = "title">Class BuildInstruct</div>
|
||||
<p></p>
|
||||
|
||||
<!-- ============================================================= -->
|
||||
|
||||
<a name="refclass139013"></a>
|
||||
<p>(Interface) building instructions to be executed by the Builder on the render node network under construction.<br /></p><p>Declaration :</p><ul><li>C++ : class BuildInstruct </li></ul><p>Directly inherited by : <a href="class139141.html#refclass139141"><b>DoAttach</b></a> <a href="class139269.html#refclass139269"><b>DoRecurse</b></a> </p>
|
||||
<p>Artifact : <a href="index.html#refartifact138117"><b>buildinstruct</b></a></p></body>
|
||||
</html>
|
||||
|
|
@ -1,26 +0,0 @@
|
|||
<!-- 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>Class DoAttach</title>
|
||||
<link rel="stylesheet" href="style.css" type="text/css" />
|
||||
</head>
|
||||
|
||||
<body bgcolor="#ffffff">
|
||||
|
||||
<div class = "title">Class DoAttach</div>
|
||||
<p></p>
|
||||
|
||||
<!-- ============================================================= -->
|
||||
|
||||
<a name="refclass139141"></a>
|
||||
<p>Declaration :</p><ul><li>C++ : class DoAttach : public <a href="class139013.html#refclass139013"><b>BuildInstruct</b></a> </li></ul><p>Artifact : <a href="index.html#refartifact138117"><b>buildinstruct</b></a></p><div class="sub">
|
||||
<a name="refrelation144133"></a>
|
||||
<table><tr><td><div class="element">Relation <b>nodes (<directional aggregation>)</b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : + nodes : <a href="class136837.html#refclass136837"><b>Proc</b></a>, multiplicity : 1..*</li><li>C++ : public: const <a href="class136837.html#refclass136837"><b>Proc</b></a>* nodes</li></ul><p>Stereotype: vector</p>
|
||||
<a name="refattribute131461"></a>
|
||||
<table><tr><td><div class="element">Attribut <b>point</b></div></td></tr></table>
|
||||
<p>identifying the point where the nodes should be attached<br /></p><p>Declaration :</p><ul><li>Uml : + point : string</li><li>C++ : public: const string point</li></ul></div>
|
||||
</body>
|
||||
</html>
|
||||
Some files were not shown because too many files have changed in this diff Show more
Loading…
Reference in a new issue