-
Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy patheditComposition.html
More file actions
189 lines (164 loc) · 14.7 KB
/
Copy patheditComposition.html
File metadata and controls
189 lines (164 loc) · 14.7 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
<!DOCTYPE html>
<html class="writer-html5" lang="en" data-content_root="../">
<head>
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Edit a Composition — Autograph 2026.1.0 documentation</title>
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=03e43079" />
<link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=19f00094" />
<link rel="stylesheet" type="text/css" href="../_static/dark_mode_css/general.css?v=c0a7eb24" />
<link rel="stylesheet" type="text/css" href="../_static/dark_mode_css/dark.css?v=70edf1c7" />
<!--[if lt IE 9]>
<script src="../_static/js/html5shiv.min.js"></script>
<![endif]-->
<script src="../_static/jquery.js?v=5d32c60e"></script>
<script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="../_static/documentation_options.js?v=b916904f"></script>
<script src="../_static/doctools.js?v=9a2dae69"></script>
<script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="../_static/dark_mode_js/default_dark.js?v=fd565c74"></script>
<script src="../_static/dark_mode_js/theme_switcher.js?v=358d3910"></script>
<script src="../_static/js/theme.js"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="Edit Params" href="editParams.html" />
<link rel="prev" title="Manage a Project" href="importItems.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="../index.html" class="icon icon-home">
Autograph
</a>
<div class="version">
2026.1
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal" href="index.html">Developer Guide</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="startupscripts.html">Start-up scripts</a></li>
<li class="toctree-l2"><a class="reference internal" href="architecture.html">Architecture Overview</a></li>
<li class="toctree-l2"><a class="reference internal" href="importItems.html">Manage a Project</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">Edit a Composition</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#accessing-a-composition">Accessing a Composition</a></li>
<li class="toctree-l3"><a class="reference internal" href="#change-composition-parameters">Change Composition parameters</a></li>
<li class="toctree-l3"><a class="reference internal" href="#manage-layers">Manage layers</a></li>
<li class="toctree-l3"><a class="reference internal" href="#setting-the-layer-transform">Setting the layer transform</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="editParams.html">Edit Params</a></li>
<li class="toctree-l2"><a class="reference internal" href="rendering.html">Creating Renders</a></li>
<li class="toctree-l2"><a class="reference internal" href="customPanels.html">Creating custom Panels</a></li>
<li class="toctree-l2"><a class="reference internal" href="2DPaths.html">Using 2D Paths</a></li>
<li class="toctree-l2"><a class="reference internal" href="timelinePanel.html">Interacting with the Timeline</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../reference.html">API Reference</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="../index.html">Autograph</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="../index.html" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item"><a href="index.html">Developer Guide</a></li>
<li class="breadcrumb-item active">Edit a Composition</li>
<li class="wy-breadcrumbs-aside">
<a href="../_sources/Guide/editComposition.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<section id="edit-a-composition">
<h1>Edit a Composition<a class="headerlink" href="#edit-a-composition" title="Link to this heading"></a></h1>
<section id="accessing-a-composition">
<h2>Accessing a Composition<a class="headerlink" href="#accessing-a-composition" title="Link to this heading"></a></h2>
<p>A <a class="reference internal" href="../reference.html#Autograph.Composition" title="Autograph.Composition"><code class="xref py py-class docutils literal notranslate"><span class="pre">Composition</span></code></a> can be retrieved from a <a class="reference internal" href="../reference.html#Autograph.ProjectItem" title="Autograph.ProjectItem"><code class="xref py py-class docutils literal notranslate"><span class="pre">ProjectItem</span></code></a> with <a class="reference internal" href="../reference.html#Autograph.ProjectItem.getMainEffectInstance" title="Autograph.ProjectItem.getMainEffectInstance"><code class="xref py py-meth docutils literal notranslate"><span class="pre">ProjectItem.getMainEffectInstance()</span></code></a></p>
</section>
<section id="change-composition-parameters">
<h2>Change Composition parameters<a class="headerlink" href="#change-composition-parameters" title="Link to this heading"></a></h2>
<p>Since the <a class="reference internal" href="../reference.html#Autograph.Composition" title="Autograph.Composition"><code class="xref py py-class docutils literal notranslate"><span class="pre">Composition</span></code></a> class inherits <a class="reference internal" href="../reference.html#Autograph.Effect" title="Autograph.Effect"><code class="xref py py-class docutils literal notranslate"><span class="pre">Effect</span></code></a> , all its <a class="reference internal" href="../reference.html#Autograph.Param" title="Autograph.Param"><code class="xref py py-class docutils literal notranslate"><span class="pre">Param</span></code></a> can be accessed with <code class="xref py py-meth docutils literal notranslate"><span class="pre">Autograph.Effect.param(uniqueName)()</span></code> or <a class="reference internal" href="../reference.html#Autograph.Effect.getParams" title="Autograph.Effect.getParams"><code class="xref py py-meth docutils literal notranslate"><span class="pre">Autograph.Effect.getParams()</span></code></a> .
However, some commonly used Params have a dedicated API to make it easier:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">comp</span><span class="o">.</span><span class="n">setFormat</span><span class="p">(</span><span class="n">width</span><span class="p">,</span> <span class="n">height</span><span class="p">,</span> <span class="n">pixelAspectRatio</span><span class="p">)</span>
<span class="n">comp</span><span class="o">.</span><span class="n">framerate</span> <span class="o">=</span> <span class="mf">60.0</span>
<span class="c1"># 300 frames at 60fps is 5 seconds</span>
<span class="n">comp</span><span class="o">.</span><span class="n">duration</span> <span class="o">=</span> <span class="mi">300</span>
</pre></div>
</div>
</section>
<section id="manage-layers">
<h2>Manage layers<a class="headerlink" href="#manage-layers" title="Link to this heading"></a></h2>
<p><a class="reference internal" href="../reference.html#Autograph.Composition" title="Autograph.Composition"><code class="xref py py-class docutils literal notranslate"><span class="pre">Composition</span></code></a> contains is a list-like API for managing layers:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">comp</span><span class="o">.</span><span class="n">addLayer</span><span class="p">(</span><span class="n">Autograph</span><span class="o">.</span><span class="n">Layer2D</span><span class="p">())</span>
<span class="n">allLayers</span> <span class="o">=</span> <span class="n">comp</span><span class="o">.</span><span class="n">getLayers</span><span class="p">()</span>
<span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="nb">len</span><span class="p">(</span><span class="n">allLayers</span><span class="p">)):</span>
<span class="nb">print</span><span class="p">(</span><span class="s2">"Layer </span><span class="si">%i</span><span class="s2"> is </span><span class="si">%r</span><span class="s2">"</span> <span class="o">%</span> <span class="p">(</span><span class="n">i</span><span class="p">,</span> <span class="n">allLayers</span><span class="p">[</span><span class="n">i</span><span class="p">]))</span>
</pre></div>
</div>
<p>To create a layer with a project item as source, use the dedicated constructor:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">project</span><span class="o">=</span><span class="n">Autograph</span><span class="o">.</span><span class="n">app</span><span class="o">.</span><span class="n">getActiveProject</span><span class="p">()</span>
<span class="n">myFootage</span><span class="o">=</span><span class="n">project</span><span class="o">.</span><span class="n">importFootage</span><span class="p">(</span><span class="s1">'/media/myfiles/video.mov'</span><span class="p">)</span>
<span class="o">...</span>
<span class="n">comp</span><span class="o">.</span><span class="n">addLayer</span><span class="p">(</span><span class="n">Autograph</span><span class="o">.</span><span class="n">Layer2D</span><span class="p">(</span><span class="n">myFootage</span><span class="p">))</span>
</pre></div>
</div>
<p>Under the hood, this constructor assigns an <a class="reference internal" href="../reference.html#Autograph.Effect" title="Autograph.Effect"><code class="xref py py-class docutils literal notranslate"><span class="pre">Effect</span></code></a> returned from <a class="reference internal" href="../reference.html#Autograph.ProjectItem.createEffectSharedInstance" title="Autograph.ProjectItem.createEffectSharedInstance"><code class="xref py py-meth docutils literal notranslate"><span class="pre">Autograph.ProjectItem.createEffectSharedInstance()</span></code></a> to the generator slot of the source param of the layer. Here is the equivalent:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">project</span><span class="o">=</span><span class="n">Autograph</span><span class="o">.</span><span class="n">app</span><span class="o">.</span><span class="n">getActiveProject</span><span class="p">()</span>
<span class="n">myFootage</span><span class="o">=</span><span class="n">project</span><span class="o">.</span><span class="n">importFootage</span><span class="p">(</span><span class="s1">'/media/myfiles/video.mov'</span><span class="p">)</span>
<span class="n">layer</span><span class="o">=</span><span class="n">Autograph</span><span class="o">.</span><span class="n">Layer2D</span><span class="p">()</span>
<span class="c1"># Note that we create a shared copy of the effect so that the user can unshare parameters if needed</span>
<span class="n">layer</span><span class="o">.</span><span class="n">source</span><span class="o">.</span><span class="n">setGeneratorEffect</span><span class="p">(</span><span class="n">myFootage</span><span class="o">.</span><span class="n">createEffectSharedInstance</span><span class="p">())</span>
<span class="n">comp</span><span class="o">.</span><span class="n">addLayer</span><span class="p">(</span><span class="n">layer</span><span class="p">)</span>
</pre></div>
</div>
</section>
<section id="setting-the-layer-transform">
<h2>Setting the layer transform<a class="headerlink" href="#setting-the-layer-transform" title="Link to this heading"></a></h2>
<p>The layer transform parameters can be accessed with the <a class="reference internal" href="../reference.html#Autograph.Layer2D.transform" title="Autograph.Layer2D.transform"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Layer2D.transform</span></code></a> attribute or with the generic <a class="reference internal" href="../reference.html#Autograph.Effect.param" title="Autograph.Effect.param"><code class="xref py py-meth docutils literal notranslate"><span class="pre">Effect.param()</span></code></a> accessor.</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">layer</span><span class="o">.</span><span class="n">transform</span><span class="o">.</span><span class="n">position</span><span class="o">.</span><span class="n">setValues</span><span class="p">([</span><span class="mf">300.</span><span class="p">,</span><span class="mf">0.</span><span class="p">])</span>
</pre></div>
</div>
</section>
</section>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="importItems.html" class="btn btn-neutral float-left" title="Manage a Project" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="editParams.html" class="btn btn-neutral float-right" title="Edit Params" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<hr/>
<div role="contentinfo">
<p>© Copyright 2026 Maxon Computer GmbH.</p>
</div>
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>