Extra "ports" of juce-based plugins using the distrho build system
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

470 lines
11KB

  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
  2. "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
  3. <html>
  4. <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
  5. <head>
  6. <title>protoplug: Class juce.AffineTransform</title>
  7. <link rel="stylesheet" href="../ldoc.css" type="text/css" />
  8. </head>
  9. <body>
  10. <div id="container">
  11. <div id="product">
  12. <div id="product_logo"></div>
  13. <div id="product_name"><big><b></b></big></div>
  14. <div id="product_description"></div>
  15. </div> <!-- id="product" -->
  16. <div id="main">
  17. <!-- Menu -->
  18. <div id="navigation">
  19. <a href="http://osar.fr">
  20. <div class=osarlogo> </div>
  21. </a>
  22. <br/>
  23. <a href="http://osar.fr/protoplug">
  24. <h1>protoplug</h1>
  25. </a>
  26. <span class="proto_subtitle">Lua API reference</span>
  27. <ul>
  28. <li><a href="../index.html">Index</a></li>
  29. </ul>
  30. <h2>Contents</h2>
  31. <ul>
  32. <li><a href="#Constructors">Constructors</a></li>
  33. <li><a href="#Methods">Methods</a></li>
  34. <li><a href="#Fields">Fields</a></li>
  35. <li><a href="#Predefined_values">Predefined values</a></li>
  36. </ul>
  37. <h2>Classes</h2>
  38. <ul class="$(kind=='Topics' and '' or 'nowrap'">
  39. <li><strong>juce.AffineTransform</strong></li>
  40. <li><a href="../classes/juce.AudioFormatReader.html">juce.AudioFormatReader</a></li>
  41. <li><a href="../classes/juce.Colour.html">juce.Colour</a></li>
  42. <li><a href="../classes/juce.ColourGradient.html">juce.ColourGradient</a></li>
  43. <li><a href="../classes/juce.Component.html">juce.Component</a></li>
  44. <li><a href="../classes/juce.FillType.html">juce.FillType</a></li>
  45. <li><a href="../classes/juce.Font.html">juce.Font</a></li>
  46. <li><a href="../classes/juce.Graphics.html">juce.Graphics</a></li>
  47. <li><a href="../classes/juce.Image.html">juce.Image</a></li>
  48. <li><a href="../classes/juce.Justification.html">juce.Justification</a></li>
  49. <li><a href="../classes/juce.LagrangeInterpolator.html">juce.LagrangeInterpolator</a></li>
  50. <li><a href="../classes/juce.Line.html">juce.Line</a></li>
  51. <li><a href="../classes/juce.Path.html">juce.Path</a></li>
  52. <li><a href="../classes/juce.Point.html">juce.Point</a></li>
  53. <li><a href="../classes/juce.RectanglePlacement.html">juce.RectanglePlacement</a></li>
  54. <li><a href="../classes/juce.Rectangle_float.html">juce.Rectangle_float</a></li>
  55. <li><a href="../classes/juce.Rectangle_int.html">juce.Rectangle_int</a></li>
  56. </ul>
  57. <h2>Modules</h2>
  58. <ul class="$(kind=='Topics' and '' or 'nowrap'">
  59. <li><a href="../modules/plugin.html">plugin</a></li>
  60. <li><a href="../modules/script.html">script</a></li>
  61. <li><a href="../modules/midi.html">midi</a></li>
  62. <li><a href="../modules/gui.html">gui</a></li>
  63. <li><a href="../modules/polyGen.html">polyGen</a></li>
  64. <li><a href="../modules/stereoFx.html">stereoFx</a></li>
  65. </ul>
  66. <h2>Examples</h2>
  67. <ul class="$(kind=='Topics' and '' or 'nowrap'">
  68. <li><a href="../examples/classic-filter.lua.html">classic-filter.lua</a></li>
  69. <li><a href="../examples/sine-organ.lua.html">sine-organ.lua</a></li>
  70. <li><a href="../examples/midi-chordify.lua.html">midi-chordify.lua</a></li>
  71. <li><a href="../examples/sinemouse-demo.lua.html">sinemouse-demo.lua</a></li>
  72. <li><a href="../examples/soundfile-test.lua.html">soundfile-test.lua</a></li>
  73. </ul>
  74. </div>
  75. <div id="content">
  76. <h1>Class <code>juce.AffineTransform</code></h1>
  77. <p>A geometric transformation.</p>
  78. <p>
  79. <p> Is converted to a <a href="http://www.juce.com/api/classAffineTransform.html">JUCE AffineTransform</a>.</p>
  80. <p> The default constructor makes an <a href="../classes/juce.AffineTransform.html#juce.AffineTransform.identity">identity</a> transform, so all kinds of
  81. transformations can be created as follows :</p>
  82. <pre><code>rot180 = juce.AffineTransform():rotated(math.pi)
  83. chainey = juce.AffineTransform():scaled(2.5):translated(140,140)
  84. </code></pre>
  85. </p>
  86. <h2><a href="#Constructors">Constructors</a></h2>
  87. <table class="function_list">
  88. <tr>
  89. <td class="name" nowrap><a href="#juce.AffineTransform.AffineTransform"><span class="proto_prefix">juce</span>.AffineTransform (mat00, mat01, mat02, mat10, mat11, mat12)</a></td>
  90. <td class="summary">Constuctor.</td>
  91. </tr>
  92. </table>
  93. <h2><a href="#Methods">Methods</a></h2>
  94. <table class="function_list">
  95. <tr>
  96. <td class="name" nowrap><a href="#juce.AffineTransform:translated"><span class="proto_prefix">juce.AffineTransform</span>:translated (dx, dy)</a></td>
  97. <td class="summary">Translated.</td>
  98. </tr>
  99. <tr>
  100. <td class="name" nowrap><a href="#juce.AffineTransform:rotated"><span class="proto_prefix">juce.AffineTransform</span>:rotated (rad)</a></td>
  101. <td class="summary">Rotated.</td>
  102. </tr>
  103. <tr>
  104. <td class="name" nowrap><a href="#juce.AffineTransform:scaled"><span class="proto_prefix">juce.AffineTransform</span>:scaled (scaleX[, scaleY=scaleX])</a></td>
  105. <td class="summary">Scaled.</td>
  106. </tr>
  107. <tr>
  108. <td class="name" nowrap><a href="#juce.AffineTransform:followedBy"><span class="proto_prefix">juce.AffineTransform</span>:followedBy (other)</a></td>
  109. <td class="summary">Followed by.</td>
  110. </tr>
  111. </table>
  112. <h2><a href="#Fields">Fields</a></h2>
  113. <table class="function_list">
  114. <tr>
  115. <td class="name" nowrap><a href="#juce.AffineTransform.mat00"><span class="proto_prefix">juce.AffineTransform</span>.mat00</a></td>
  116. <td class="summary">Matrix [0] [0]</td>
  117. </tr>
  118. <tr>
  119. <td class="name" nowrap><a href="#juce.AffineTransform.mat01"><span class="proto_prefix">juce.AffineTransform</span>.mat01</a></td>
  120. <td class="summary">Matrix [0] [1]</td>
  121. </tr>
  122. <tr>
  123. <td class="name" nowrap><a href="#juce.AffineTransform.mat02"><span class="proto_prefix">juce.AffineTransform</span>.mat02</a></td>
  124. <td class="summary">Matrix [0] [2]</td>
  125. </tr>
  126. <tr>
  127. <td class="name" nowrap><a href="#juce.AffineTransform.mat10"><span class="proto_prefix">juce.AffineTransform</span>.mat10</a></td>
  128. <td class="summary">Matrix [1] [0]</td>
  129. </tr>
  130. <tr>
  131. <td class="name" nowrap><a href="#juce.AffineTransform.mat11"><span class="proto_prefix">juce.AffineTransform</span>.mat11</a></td>
  132. <td class="summary">Matrix [1] [1]</td>
  133. </tr>
  134. <tr>
  135. <td class="name" nowrap><a href="#juce.AffineTransform.mat12"><span class="proto_prefix">juce.AffineTransform</span>.mat12</a></td>
  136. <td class="summary">Matrix [1] [2]</td>
  137. </tr>
  138. </table>
  139. <h2><a href="#Predefined_values">Predefined values</a></h2>
  140. <table class="function_list">
  141. <tr>
  142. <td class="name" nowrap><a href="#juce.AffineTransform.identity"><span class="proto_prefix">juce.AffineTransform</span>.identity</a></td>
  143. <td class="summary">Identity.</td>
  144. </tr>
  145. </table>
  146. <br/>
  147. <br/>
  148. <h2><a name="Constructors"></a>Constructors</h2>
  149. <dl class="function">
  150. <dt>
  151. <a name = "juce.AffineTransform.AffineTransform"></a>
  152. <strong><span class="proto_prefix">juce</span>.AffineTransform (mat00, mat01, mat02, mat10, mat11, mat12)</strong>
  153. </dt>
  154. <dd>
  155. <p>Constuctor.
  156. parameters thusly define a transformation matrix :</p>
  157. <pre><code>(mat00 mat01 mat02)
  158. (mat10 mat11 mat12)
  159. (0 0 1)
  160. </code></pre>
  161. </ul>
  162. <h3>Parameters:</h3>
  163. <ul>
  164. <li><span class="parameter">mat00</span>
  165. </li>
  166. <li><span class="parameter">mat01</span>
  167. </li>
  168. <li><span class="parameter">mat02</span>
  169. </li>
  170. <li><span class="parameter">mat10</span>
  171. </li>
  172. <li><span class="parameter">mat11</span>
  173. </li>
  174. <li><span class="parameter">mat12</span>
  175. </li>
  176. </ul>
  177. </dd>
  178. </dl>
  179. <h2><a name="Methods"></a>Methods</h2>
  180. <dl class="function">
  181. <dt>
  182. <a name = "juce.AffineTransform:translated"></a>
  183. <strong><span class="proto_prefix">juce.AffineTransform</span>:translated (dx, dy)</strong>
  184. </dt>
  185. <dd>
  186. Translated.
  187. </ul>
  188. <h3>Parameters:</h3>
  189. <ul>
  190. <li><span class="parameter">dx</span>
  191. the horizontal offset
  192. </li>
  193. <li><span class="parameter">dy</span>
  194. the vertical offset
  195. </li>
  196. </ul>
  197. <h3>Returns:</h3>
  198. <ol>
  199. a translated version of this transform
  200. </ol>
  201. </dd>
  202. <dt>
  203. <a name = "juce.AffineTransform:rotated"></a>
  204. <strong><span class="proto_prefix">juce.AffineTransform</span>:rotated (rad)</strong>
  205. </dt>
  206. <dd>
  207. Rotated.
  208. </ul>
  209. <h3>Parameters:</h3>
  210. <ul>
  211. <li><span class="parameter">rad</span>
  212. the degree of rotation in radians
  213. </li>
  214. </ul>
  215. <h3>Returns:</h3>
  216. <ol>
  217. a rotated version of this transform
  218. </ol>
  219. </dd>
  220. <dt>
  221. <a name = "juce.AffineTransform:scaled"></a>
  222. <strong><span class="proto_prefix">juce.AffineTransform</span>:scaled (scaleX[, scaleY=scaleX])</strong>
  223. </dt>
  224. <dd>
  225. Scaled.
  226. </ul>
  227. <h3>Parameters:</h3>
  228. <ul>
  229. <li><span class="parameter">scaleX</span>
  230. </li>
  231. <li><span class="parameter">scaleY</span>
  232. (<em>default</em> scaleX)
  233. </li>
  234. </ul>
  235. <h3>Returns:</h3>
  236. <ol>
  237. a scaled version of this transform
  238. </ol>
  239. </dd>
  240. <dt>
  241. <a name = "juce.AffineTransform:followedBy"></a>
  242. <strong><span class="proto_prefix">juce.AffineTransform</span>:followedBy (other)</strong>
  243. </dt>
  244. <dd>
  245. Followed by.
  246. </ul>
  247. <h3>Parameters:</h3>
  248. <ul>
  249. <li><span class="parameter">other</span>
  250. </li>
  251. </ul>
  252. <h3>Returns:</h3>
  253. <ol>
  254. a version of this transform followed by another
  255. </ol>
  256. </dd>
  257. </dl>
  258. <h2><a name="Fields"></a>Fields</h2>
  259. <dl class="function">
  260. <dt>
  261. <a name = "juce.AffineTransform.mat00"></a>
  262. <strong><span class="proto_prefix">juce.AffineTransform</span>.mat00</strong>
  263. </dt>
  264. <dd>
  265. Matrix [0] [0]
  266. </ul>
  267. </dd>
  268. <dt>
  269. <a name = "juce.AffineTransform.mat01"></a>
  270. <strong><span class="proto_prefix">juce.AffineTransform</span>.mat01</strong>
  271. </dt>
  272. <dd>
  273. Matrix [0] [1]
  274. </ul>
  275. </dd>
  276. <dt>
  277. <a name = "juce.AffineTransform.mat02"></a>
  278. <strong><span class="proto_prefix">juce.AffineTransform</span>.mat02</strong>
  279. </dt>
  280. <dd>
  281. Matrix [0] [2]
  282. </ul>
  283. </dd>
  284. <dt>
  285. <a name = "juce.AffineTransform.mat10"></a>
  286. <strong><span class="proto_prefix">juce.AffineTransform</span>.mat10</strong>
  287. </dt>
  288. <dd>
  289. Matrix [1] [0]
  290. </ul>
  291. </dd>
  292. <dt>
  293. <a name = "juce.AffineTransform.mat11"></a>
  294. <strong><span class="proto_prefix">juce.AffineTransform</span>.mat11</strong>
  295. </dt>
  296. <dd>
  297. Matrix [1] [1]
  298. </ul>
  299. </dd>
  300. <dt>
  301. <a name = "juce.AffineTransform.mat12"></a>
  302. <strong><span class="proto_prefix">juce.AffineTransform</span>.mat12</strong>
  303. </dt>
  304. <dd>
  305. Matrix [1] [2]
  306. </ul>
  307. </dd>
  308. </dl>
  309. <h2><a name="Predefined_values"></a>Predefined values</h2>
  310. <dl class="function">
  311. <dt>
  312. <a name = "juce.AffineTransform.identity"></a>
  313. <strong><span class="proto_prefix">juce.AffineTransform</span>.identity</strong>
  314. </dt>
  315. <dd>
  316. Identity.
  317. The non-transform.
  318. </ul>
  319. </dd>
  320. </dl>
  321. </div> <!-- id="content" -->
  322. </div> <!-- id="main" -->
  323. <div id="about">
  324. <i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.2</a></i>
  325. </div> <!-- id="about" -->
  326. </div> <!-- id="container" -->
  327. </body>
  328. </html>