-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathoverview.html
355 lines (340 loc) · 21 KB
/
overview.html
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
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Overview — pdpy documentation</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/css/custom.css" type="text/css" />
<link rel="canonical" href="https://pdpy-org.github.com/doc/overview.html" />
<!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
<script src="_static/doctools.js"></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="Classes" href="classes.html" />
<link rel="prev" title="Usage" href="usage.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" style="background: white" >
<a href="index.html">
<img src="_static/pdpy-logo.png" class="logo" alt="Logo"/>
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="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">
<p class="caption" role="heading"><span class="caption-text">Getting Started</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="usage.html">Usage</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Documentation</span></p>
<ul class="current">
<li class="toctree-l1 current"><a class="current reference internal" href="#">Overview</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#base">Base</a></li>
<li class="toctree-l2"><a class="reference internal" href="#classes">Classes</a></li>
<li class="toctree-l2"><a class="reference internal" href="#data">Data</a></li>
<li class="toctree-l2"><a class="reference internal" href="#encoding-decoding">Encoding/Decoding</a></li>
<li class="toctree-l2"><a class="reference internal" href="#iemgui">IEMgui</a></li>
<li class="toctree-l2"><a class="reference internal" href="#objects">Objects</a></li>
<li class="toctree-l2"><a class="reference internal" href="#patching">Patching</a></li>
<li class="toctree-l2"><a class="reference internal" href="#primitives">Primitives</a></li>
<li class="toctree-l2"><a class="reference internal" href="#utilities">Utilities</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="classes.html">Classes</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Examples</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="examples/holamundo.html">Hola Mundo</a></li>
<li class="toctree-l1"><a class="reference internal" href="examples/simpleaudio.html">Simple Audio</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" style="background: white" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">pdpy</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"></a> »</li>
<li>Overview</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/overview.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="overview">
<h1>Overview<a class="headerlink" href="#overview" title="Permalink to this heading">¶</a></h1>
<section id="base">
<h2>Base<a class="headerlink" href="#base" title="Permalink to this heading">¶</a></h2>
<table class="autosummary longtable docutils align-default">
<colgroup>
<col style="width: 10%" />
<col style="width: 90%" />
</colgroup>
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="classes/base.html#module-pdpy.classes.object" title="pdpy.classes.object"><code class="xref py py-obj docutils literal notranslate"><span class="pre">pdpy.classes.object</span></code></a></p></td>
<td><p>Object Class Definitions</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="classes/base.html#module-pdpy.classes.canvasbase" title="pdpy.classes.canvasbase"><code class="xref py py-obj docutils literal notranslate"><span class="pre">pdpy.classes.canvasbase</span></code></a></p></td>
<td><p>Canvas Base Class Definition</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="classes/base.html#module-pdpy.classes.base" title="pdpy.classes.base"><code class="xref py py-obj docutils literal notranslate"><span class="pre">pdpy.classes.base</span></code></a></p></td>
<td><p>Base Class</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="classes/base.html#module-pdpy.classes.pdpy" title="pdpy.classes.pdpy"><code class="xref py py-obj docutils literal notranslate"><span class="pre">pdpy.classes.pdpy</span></code></a></p></td>
<td><p>PdPy class definition</p></td>
</tr>
</tbody>
</table>
</section>
<section id="classes">
<h2>Classes<a class="headerlink" href="#classes" title="Permalink to this heading">¶</a></h2>
<table class="autosummary longtable docutils align-default">
<colgroup>
<col style="width: 10%" />
<col style="width: 90%" />
</colgroup>
<tbody>
<tr class="row-odd"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">pdpy</span></code></p></td>
<td><p>Class definitions</p></td>
</tr>
</tbody>
</table>
</section>
<section id="data">
<h2>Data<a class="headerlink" href="#data" title="Permalink to this heading">¶</a></h2>
<table class="autosummary longtable docutils align-default">
<colgroup>
<col style="width: 10%" />
<col style="width: 90%" />
</colgroup>
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="classes/data.html#module-pdpy.classes.types" title="pdpy.classes.types"><code class="xref py py-obj docutils literal notranslate"><span class="pre">pdpy.classes.types</span></code></a></p></td>
<td><p>Pd Types Class Definitions</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="classes/data.html#module-pdpy.classes.data" title="pdpy.classes.data"><code class="xref py py-obj docutils literal notranslate"><span class="pre">pdpy.classes.data</span></code></a></p></td>
<td><p>Data Class Definition</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="classes/data.html#module-pdpy.classes.scalar" title="pdpy.classes.scalar"><code class="xref py py-obj docutils literal notranslate"><span class="pre">pdpy.classes.scalar</span></code></a></p></td>
<td><p>Scalar Class Definition</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="classes/data.html#module-pdpy.classes.struct" title="pdpy.classes.struct"><code class="xref py py-obj docutils literal notranslate"><span class="pre">pdpy.classes.struct</span></code></a></p></td>
<td><p>Class Definitions for Pure Data's Data Structures</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="classes/data.html#module-pdpy.classes.array" title="pdpy.classes.array"><code class="xref py py-obj docutils literal notranslate"><span class="pre">pdpy.classes.array</span></code></a></p></td>
<td><p>Array Class Definition</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="classes/data.html#module-pdpy.classes.goparray" title="pdpy.classes.goparray"><code class="xref py py-obj docutils literal notranslate"><span class="pre">pdpy.classes.goparray</span></code></a></p></td>
<td><p>Class Definitions for GOP Array</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="classes/data.html#module-pdpy.classes.graph" title="pdpy.classes.graph"><code class="xref py py-obj docutils literal notranslate"><span class="pre">pdpy.classes.graph</span></code></a></p></td>
<td><p>Class Definitions for the Old Graph Obj</p></td>
</tr>
</tbody>
</table>
</section>
<section id="encoding-decoding">
<h2>Encoding/Decoding<a class="headerlink" href="#encoding-decoding" title="Permalink to this heading">¶</a></h2>
<table class="autosummary longtable docutils align-default">
<colgroup>
<col style="width: 10%" />
<col style="width: 90%" />
</colgroup>
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="classes/encoders.html#module-pdpy.classes.PdPyXMLParser" title="pdpy.classes.PdPyXMLParser"><code class="xref py py-obj docutils literal notranslate"><span class="pre">pdpy.classes.PdPyXMLParser</span></code></a>(parent, xml)</p></td>
<td><p></p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="classes/encoders.html#module-pdpy.classes.pdpyencoder" title="pdpy.classes.pdpyencoder"><code class="xref py py-obj docutils literal notranslate"><span class="pre">pdpy.classes.pdpyencoder</span></code></a></p></td>
<td><p>PdPyEncoder Class Definition</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="classes/encoders.html#module-pdpy.classes.xmlbuilder" title="pdpy.classes.xmlbuilder"><code class="xref py py-obj docutils literal notranslate"><span class="pre">pdpy.classes.xmlbuilder</span></code></a></p></td>
<td><p>XML Converter Class</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="classes/encoders.html#module-pdpy.classes.xmltagconvert" title="pdpy.classes.xmltagconvert"><code class="xref py py-obj docutils literal notranslate"><span class="pre">pdpy.classes.xmltagconvert</span></code></a></p></td>
<td><p></p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="classes/encoders.html#module-pdpy.classes.pdpyparser" title="pdpy.classes.pdpyparser"><code class="xref py py-obj docutils literal notranslate"><span class="pre">pdpy.classes.pdpyparser</span></code></a></p></td>
<td><p>PdPy file to Json-format file</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="classes/encoders.html#module-pdpy.parse.pdpy2json" title="pdpy.parse.pdpy2json"><code class="xref py py-obj docutils literal notranslate"><span class="pre">pdpy.parse.pdpy2json</span></code></a></p></td>
<td><p>PdPy file to Json-format file</p></td>
</tr>
</tbody>
</table>
</section>
<section id="iemgui">
<h2>IEMgui<a class="headerlink" href="#iemgui" title="Permalink to this heading">¶</a></h2>
<table class="autosummary longtable docutils align-default">
<colgroup>
<col style="width: 10%" />
<col style="width: 90%" />
</colgroup>
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="classes/iemgui.html#module-pdpy.classes.toggle" title="pdpy.classes.toggle"><code class="xref py py-obj docutils literal notranslate"><span class="pre">pdpy.classes.toggle</span></code></a></p></td>
<td><p>IEMGUI Toggle Class Definitions</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="classes/iemgui.html#module-pdpy.classes.bng" title="pdpy.classes.bng"><code class="xref py py-obj docutils literal notranslate"><span class="pre">pdpy.classes.bng</span></code></a></p></td>
<td><p>IEMGUI Bang Class Definitions</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="classes/iemgui.html#module-pdpy.classes.nbx" title="pdpy.classes.nbx"><code class="xref py py-obj docutils literal notranslate"><span class="pre">pdpy.classes.nbx</span></code></a></p></td>
<td><p>IEMGUI Number box Class Definitions</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="classes/iemgui.html#module-pdpy.classes.slider" title="pdpy.classes.slider"><code class="xref py py-obj docutils literal notranslate"><span class="pre">pdpy.classes.slider</span></code></a></p></td>
<td><p>IEMGUI Slider Class Definitions</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="classes/iemgui.html#module-pdpy.classes.radio" title="pdpy.classes.radio"><code class="xref py py-obj docutils literal notranslate"><span class="pre">pdpy.classes.radio</span></code></a></p></td>
<td><p>IEMGUI Radio Class Definitions</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="classes/iemgui.html#module-pdpy.classes.vu" title="pdpy.classes.vu"><code class="xref py py-obj docutils literal notranslate"><span class="pre">pdpy.classes.vu</span></code></a></p></td>
<td><p>IEMGUI Vu Meter Class Definitions</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="classes/iemgui.html#module-pdpy.classes.cnv" title="pdpy.classes.cnv"><code class="xref py py-obj docutils literal notranslate"><span class="pre">pdpy.classes.cnv</span></code></a></p></td>
<td><p>IEMGUI Cnv Class Definitions</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="classes/iemgui.html#module-pdpy.classes.iemgui" title="pdpy.classes.iemgui"><code class="xref py py-obj docutils literal notranslate"><span class="pre">pdpy.classes.iemgui</span></code></a></p></td>
<td><p>IEMGUI Class Definitions</p></td>
</tr>
</tbody>
</table>
</section>
<section id="objects">
<h2>Objects<a class="headerlink" href="#objects" title="Permalink to this heading">¶</a></h2>
<table class="autosummary longtable docutils align-default">
<colgroup>
<col style="width: 10%" />
<col style="width: 90%" />
</colgroup>
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="classes/objects.html#module-pdpy.classes.obj" title="pdpy.classes.obj"><code class="xref py py-obj docutils literal notranslate"><span class="pre">pdpy.classes.obj</span></code></a></p></td>
<td><p>Obj Class Definition</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="classes/objects.html#module-pdpy.classes.message" title="pdpy.classes.message"><code class="xref py py-obj docutils literal notranslate"><span class="pre">pdpy.classes.message</span></code></a></p></td>
<td><p>Class Definitions</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="classes/objects.html#module-pdpy.classes.gui" title="pdpy.classes.gui"><code class="xref py py-obj docutils literal notranslate"><span class="pre">pdpy.classes.gui</span></code></a></p></td>
<td><p>Class Definitions</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="classes/objects.html#module-pdpy.classes.comment" title="pdpy.classes.comment"><code class="xref py py-obj docutils literal notranslate"><span class="pre">pdpy.classes.comment</span></code></a></p></td>
<td><p>Pure Data Text Comment Definitions</p></td>
</tr>
</tbody>
</table>
</section>
<section id="patching">
<h2>Patching<a class="headerlink" href="#patching" title="Permalink to this heading">¶</a></h2>
<table class="autosummary longtable docutils align-default">
<colgroup>
<col style="width: 10%" />
<col style="width: 90%" />
</colgroup>
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="classes/patching.html#module-pdpy.classes.canvas" title="pdpy.classes.canvas"><code class="xref py py-obj docutils literal notranslate"><span class="pre">pdpy.classes.canvas</span></code></a></p></td>
<td><p>Canvas Class Definition</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="classes/patching.html#module-pdpy.classes.connections" title="pdpy.classes.connections"><code class="xref py py-obj docutils literal notranslate"><span class="pre">pdpy.classes.connections</span></code></a></p></td>
<td><p>Class Definitions</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="classes/patching.html#module-pdpy.classes.dependencies" title="pdpy.classes.dependencies"><code class="xref py py-obj docutils literal notranslate"><span class="pre">pdpy.classes.dependencies</span></code></a></p></td>
<td><p>Dependencies Class Definition</p></td>
</tr>
</tbody>
</table>
</section>
<section id="primitives">
<h2>Primitives<a class="headerlink" href="#primitives" title="Permalink to this heading">¶</a></h2>
<table class="autosummary longtable docutils align-default">
<colgroup>
<col style="width: 10%" />
<col style="width: 90%" />
</colgroup>
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="classes/primitives.html#module-pdpy.classes.point" title="pdpy.classes.point"><code class="xref py py-obj docutils literal notranslate"><span class="pre">pdpy.classes.point</span></code></a></p></td>
<td><p>Graphical Point Class Definitions</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="classes/primitives.html#module-pdpy.classes.size" title="pdpy.classes.size"><code class="xref py py-obj docutils literal notranslate"><span class="pre">pdpy.classes.size</span></code></a></p></td>
<td><p>Graphical Size Class Definitions</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="classes/primitives.html#module-pdpy.classes.area" title="pdpy.classes.area"><code class="xref py py-obj docutils literal notranslate"><span class="pre">pdpy.classes.area</span></code></a></p></td>
<td><p>Graphical Area Class Definitions</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="classes/primitives.html#module-pdpy.classes.bounds" title="pdpy.classes.bounds"><code class="xref py py-obj docutils literal notranslate"><span class="pre">pdpy.classes.bounds</span></code></a></p></td>
<td><p>Graphical Bounds Class Definitions</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="classes/primitives.html#module-pdpy.classes.coords" title="pdpy.classes.coords"><code class="xref py py-obj docutils literal notranslate"><span class="pre">pdpy.classes.coords</span></code></a></p></td>
<td><p>Graphical Coords Class Definitions</p></td>
</tr>
</tbody>
</table>
</section>
<section id="utilities">
<h2>Utilities<a class="headerlink" href="#utilities" title="Permalink to this heading">¶</a></h2>
<table class="autosummary longtable docutils align-default">
<colgroup>
<col style="width: 10%" />
<col style="width: 90%" />
</colgroup>
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="classes/utilities.html#module-pdpy.classes.translator" title="pdpy.classes.translator"><code class="xref py py-obj docutils literal notranslate"><span class="pre">pdpy.classes.translator</span></code></a></p></td>
<td><p>Translator class</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="classes/utilities.html#module-pdpy.util.utils" title="pdpy.util.utils"><code class="xref py py-obj docutils literal notranslate"><span class="pre">pdpy.util.utils</span></code></a></p></td>
<td><p>Utilities</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="classes/utilities.html#module-pdpy.classes.default" title="pdpy.classes.default"><code class="xref py py-obj docutils literal notranslate"><span class="pre">pdpy.classes.default</span></code></a></p></td>
<td><p>Pure Data Default Definitions</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="classes/utilities.html#module-pdpy.classes.exceptions" title="pdpy.classes.exceptions"><code class="xref py py-obj docutils literal notranslate"><span class="pre">pdpy.classes.exceptions</span></code></a></p></td>
<td><p>Exception Definitions</p></td>
</tr>
</tbody>
</table>
</section>
</section>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="usage.html" class="btn btn-neutral float-left" title="Usage" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="classes.html" class="btn btn-neutral float-right" title="Classes" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<hr/>
<div role="contentinfo">
<p>© Copyright 2022, Fede Camara Halac.</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>