Files
oak-editor/docs/html/voideffect_8h_source.html
T
2019-02-19 03:57:47 -08:00

93 lines
14 KiB
HTML

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.15"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Olive: effects/internal/voideffect.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Olive
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.15 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_63bb297c276a119495816091bcd678e9.html">effects</a></li><li class="navelem"><a class="el" href="dir_6bd69bfe0c8411ea8cfb86495c1153f0.html">internal</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">voideffect.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="voideffect_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="comment">/***</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment"></span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment"> Olive - Non-Linear Video Editor</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment"> Copyright (C) 2019 Olive Team</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="comment"></span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="comment"> This program is free software: you can redistribute it and/or modify</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="comment"> it under the terms of the GNU General Public License as published by</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="comment"> the Free Software Foundation, either version 3 of the License, or</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="comment"> (at your option) any later version.</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="comment"></span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="comment"> This program is distributed in the hope that it will be useful,</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="comment"> but WITHOUT ANY WARRANTY; without even the implied warranty of</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="comment"> MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="comment"> GNU General Public License for more details.</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="comment"></span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="comment"> You should have received a copy of the GNU General Public License</span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="comment"> along with this program. If not, see &lt;http://www.gnu.org/licenses/&gt;.</span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<span class="comment"></span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;<span class="comment">***/</span></div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;</div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;<span class="preprocessor">#ifndef VOIDEFFECT_H</span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;<span class="preprocessor">#define VOIDEFFECT_H</span></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;</div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;<span class="comment">/* VoidEffect is a placeholder used when Olive is unable to find an effect</span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;<span class="comment"> * requested by a loaded project. It displays a missing effect so the user knows</span></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;<span class="comment"> * an effect is missing, and stores the XML project data verbatim so that it</span></div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160;<span class="comment"> * isn&#39;t lost if the user saves over the project.</span></div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;<span class="comment"> */</span></div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160;</div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="effect_8h.html">project/effect.h</a>&quot;</span></div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160;</div><div class="line"><a name="l00032"></a><span class="lineno"><a class="line" href="class_void_effect.html"> 32</a></span>&#160;<span class="keyword">class </span><a class="code" href="class_void_effect.html">VoidEffect</a> : <span class="keyword">public</span> <a class="code" href="class_effect.html">Effect</a> {</div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160; Q_OBJECT</div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160;<span class="keyword">public</span>:</div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160; <a class="code" href="class_void_effect.html#ad06382c456f9f6686dc1b980768a6ae6">VoidEffect</a>(<a class="code" href="cacher_8h.html#a06b2300f462978e17d9b586991a0af3f">ClipPtr</a> c, <span class="keyword">const</span> QString&amp; n);</div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160;</div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160; <span class="keyword">virtual</span> <a class="code" href="effect_8h.html#a76f90640a8579a0d9d52d40f7147f969">EffectPtr</a> <a class="code" href="class_void_effect.html#a9dcb2a9c5150168f2db4a26025ca7191">copy</a>(<a class="code" href="cacher_8h.html#a06b2300f462978e17d9b586991a0af3f">ClipPtr</a> c) <span class="keyword">override</span>;</div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_void_effect.html#a4ecfec8a96b0611671266259c4cda45c">load</a>(QXmlStreamReader &amp;stream) <span class="keyword">override</span>;</div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_void_effect.html#a33022b606b609ce42432dd91d70ce4e1">save</a>(QXmlStreamWriter &amp;stream) <span class="keyword">override</span>;</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160;<span class="keyword">private</span>:</div><div class="line"><a name="l00041"></a><span class="lineno"><a class="line" href="class_void_effect.html#a8316947b3383c3bedc05ce445ec1fc16"> 41</a></span>&#160; QByteArray <a class="code" href="class_void_effect.html#a8316947b3383c3bedc05ce445ec1fc16">bytes</a>;</div><div class="line"><a name="l00042"></a><span class="lineno"><a class="line" href="class_void_effect.html#af648b7aaf5211aa00aed672513ffa382"> 42</a></span>&#160; <a class="code" href="struct_effect_meta.html">EffectMeta</a> <a class="code" href="class_void_effect.html#af648b7aaf5211aa00aed672513ffa382">void_meta</a>;</div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160;};</div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160;</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160;<span class="preprocessor">#endif // VOIDEFFECT_H</span></div><div class="ttc" id="class_void_effect_html_a8316947b3383c3bedc05ce445ec1fc16"><div class="ttname"><a href="class_void_effect.html#a8316947b3383c3bedc05ce445ec1fc16">VoidEffect::bytes</a></div><div class="ttdeci">QByteArray bytes</div><div class="ttdef"><b>Definition:</b> voideffect.h:41</div></div>
<div class="ttc" id="class_effect_html"><div class="ttname"><a href="class_effect.html">Effect</a></div><div class="ttdef"><b>Definition:</b> effect.h:169</div></div>
<div class="ttc" id="effect_8h_html"><div class="ttname"><a href="effect_8h.html">effect.h</a></div></div>
<div class="ttc" id="struct_effect_meta_html"><div class="ttname"><a href="struct_effect_meta.html">EffectMeta</a></div><div class="ttdef"><b>Definition:</b> effect.h:50</div></div>
<div class="ttc" id="class_void_effect_html_a33022b606b609ce42432dd91d70ce4e1"><div class="ttname"><a href="class_void_effect.html#a33022b606b609ce42432dd91d70ce4e1">VoidEffect::save</a></div><div class="ttdeci">virtual void save(QXmlStreamWriter &amp;stream) override</div><div class="ttdef"><b>Definition:</b> voideffect.cpp:77</div></div>
<div class="ttc" id="cacher_8h_html_a06b2300f462978e17d9b586991a0af3f"><div class="ttname"><a href="cacher_8h.html#a06b2300f462978e17d9b586991a0af3f">ClipPtr</a></div><div class="ttdeci">std::shared_ptr&lt; Clip &gt; ClipPtr</div><div class="ttdef"><b>Definition:</b> cacher.h:28</div></div>
<div class="ttc" id="class_void_effect_html_a9dcb2a9c5150168f2db4a26025ca7191"><div class="ttname"><a href="class_void_effect.html#a9dcb2a9c5150168f2db4a26025ca7191">VoidEffect::copy</a></div><div class="ttdeci">virtual EffectPtr copy(ClipPtr c) override</div><div class="ttdef"><b>Definition:</b> voideffect.cpp:46</div></div>
<div class="ttc" id="class_void_effect_html_ad06382c456f9f6686dc1b980768a6ae6"><div class="ttname"><a href="class_void_effect.html#ad06382c456f9f6686dc1b980768a6ae6">VoidEffect::VoidEffect</a></div><div class="ttdeci">VoidEffect(ClipPtr c, const QString &amp;n)</div><div class="ttdef"><b>Definition:</b> voideffect.cpp:30</div></div>
<div class="ttc" id="class_void_effect_html_af648b7aaf5211aa00aed672513ffa382"><div class="ttname"><a href="class_void_effect.html#af648b7aaf5211aa00aed672513ffa382">VoidEffect::void_meta</a></div><div class="ttdeci">EffectMeta void_meta</div><div class="ttdef"><b>Definition:</b> voideffect.h:42</div></div>
<div class="ttc" id="class_void_effect_html"><div class="ttname"><a href="class_void_effect.html">VoidEffect</a></div><div class="ttdef"><b>Definition:</b> voideffect.h:32</div></div>
<div class="ttc" id="effect_8h_html_a76f90640a8579a0d9d52d40f7147f969"><div class="ttname"><a href="effect_8h.html#a76f90640a8579a0d9d52d40f7147f969">EffectPtr</a></div><div class="ttdeci">std::shared_ptr&lt; Effect &gt; EffectPtr</div><div class="ttdef"><b>Definition:</b> effect.h:48</div></div>
<div class="ttc" id="class_void_effect_html_a4ecfec8a96b0611671266259c4cda45c"><div class="ttname"><a href="class_void_effect.html#a4ecfec8a96b0611671266259c4cda45c">VoidEffect::load</a></div><div class="ttdeci">virtual void load(QXmlStreamReader &amp;stream) override</div><div class="ttdef"><b>Definition:</b> voideffect.cpp:53</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.15
</small></address>
</body>
</html>