p5.beholder
Version:
A p5 library to facilitate using the Beholder system for Aruco marker detection.
26 lines • 28.7 kB
HTML
<html lang="en" style="font-size:16px"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width,initial-scale=1"><title>P5Beholder</title><!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]--><script src="scripts/third-party/hljs.js" defer="defer"></script><script src="scripts/third-party/hljs-line-num.js" defer="defer"></script><script src="scripts/third-party/popper.js" defer="defer"></script><script src="scripts/third-party/tippy.js" defer="defer"></script><script src="scripts/third-party/tocbot.min.js"></script><script>var baseURL="/",locationPathname="",baseURL=(locationPathname=document.location.pathname).substr(0,locationPathname.lastIndexOf("/")+1)</script><link rel="stylesheet" href="styles/clean-jsdoc-theme.min.css"><svg aria-hidden="true" version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" style="display:none"><defs><symbol id="copy-icon" viewbox="0 0 488.3 488.3"><g><path d="M314.25,85.4h-227c-21.3,0-38.6,17.3-38.6,38.6v325.7c0,21.3,17.3,38.6,38.6,38.6h227c21.3,0,38.6-17.3,38.6-38.6V124 C352.75,102.7,335.45,85.4,314.25,85.4z M325.75,449.6c0,6.4-5.2,11.6-11.6,11.6h-227c-6.4,0-11.6-5.2-11.6-11.6V124 c0-6.4,5.2-11.6,11.6-11.6h227c6.4,0,11.6,5.2,11.6,11.6V449.6z"/><path d="M401.05,0h-227c-21.3,0-38.6,17.3-38.6,38.6c0,7.5,6,13.5,13.5,13.5s13.5-6,13.5-13.5c0-6.4,5.2-11.6,11.6-11.6h227 c6.4,0,11.6,5.2,11.6,11.6v325.7c0,6.4-5.2,11.6-11.6,11.6c-7.5,0-13.5,6-13.5,13.5s6,13.5,13.5,13.5c21.3,0,38.6-17.3,38.6-38.6 V38.6C439.65,17.3,422.35,0,401.05,0z"/></g></symbol><symbol id="search-icon" viewBox="0 0 512 512"><g><g><path d="M225.474,0C101.151,0,0,101.151,0,225.474c0,124.33,101.151,225.474,225.474,225.474 c124.33,0,225.474-101.144,225.474-225.474C450.948,101.151,349.804,0,225.474,0z M225.474,409.323 c-101.373,0-183.848-82.475-183.848-183.848S124.101,41.626,225.474,41.626s183.848,82.475,183.848,183.848 S326.847,409.323,225.474,409.323z"/></g></g><g><g><path d="M505.902,476.472L386.574,357.144c-8.131-8.131-21.299-8.131-29.43,0c-8.131,8.124-8.131,21.306,0,29.43l119.328,119.328 c4.065,4.065,9.387,6.098,14.715,6.098c5.321,0,10.649-2.033,14.715-6.098C514.033,497.778,514.033,484.596,505.902,476.472z"/></g></g></symbol><symbol id="font-size-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M11.246 15H4.754l-2 5H.6L7 4h2l6.4 16h-2.154l-2-5zm-.8-2L8 6.885 5.554 13h4.892zM21 12.535V12h2v8h-2v-.535a4 4 0 1 1 0-6.93zM19 18a2 2 0 1 0 0-4 2 2 0 0 0 0 4z"/></symbol><symbol id="add-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M11 11V5h2v6h6v2h-6v6h-2v-6H5v-2z"/></symbol><symbol id="minus-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M5 11h14v2H5z"/></symbol><symbol id="dark-theme-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M10 7a7 7 0 0 0 12 4.9v.1c0 5.523-4.477 10-10 10S2 17.523 2 12 6.477 2 12 2h.1A6.979 6.979 0 0 0 10 7zm-6 5a8 8 0 0 0 15.062 3.762A9 9 0 0 1 8.238 4.938 7.999 7.999 0 0 0 4 12z"/></symbol><symbol id="light-theme-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M12 18a6 6 0 1 1 0-12 6 6 0 0 1 0 12zm0-2a4 4 0 1 0 0-8 4 4 0 0 0 0 8zM11 1h2v3h-2V1zm0 19h2v3h-2v-3zM3.515 4.929l1.414-1.414L7.05 5.636 5.636 7.05 3.515 4.93zM16.95 18.364l1.414-1.414 2.121 2.121-1.414 1.414-2.121-2.121zm2.121-14.85l1.414 1.415-2.121 2.121-1.414-1.414 2.121-2.121zM5.636 16.95l1.414 1.414-2.121 2.121-1.414-1.414 2.121-2.121zM23 11v2h-3v-2h3zM4 11v2H1v-2h3z"/></symbol><symbol id="reset-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M18.537 19.567A9.961 9.961 0 0 1 12 22C6.477 22 2 17.523 2 12S6.477 2 12 2s10 4.477 10 10c0 2.136-.67 4.116-1.81 5.74L17 12h3a8 8 0 1 0-2.46 5.772l.997 1.795z"/></symbol><symbol id="down-icon" viewBox="0 0 16 16"><path fill-rule="evenodd" clip-rule="evenodd" d="M12.7803 6.21967C13.0732 6.51256 13.0732 6.98744 12.7803 7.28033L8.53033 11.5303C8.23744 11.8232 7.76256 11.8232 7.46967 11.5303L3.21967 7.28033C2.92678 6.98744 2.92678 6.51256 3.21967 6.21967C3.51256 5.92678 3.98744 5.92678 4.28033 6.21967L8 9.93934L11.7197 6.21967C12.0126 5.92678 12.4874 5.92678 12.7803 6.21967Z"></path></symbol><symbol id="codepen-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M16.5 13.202L13 15.535v3.596L19.197 15 16.5 13.202zM14.697 12L12 10.202 9.303 12 12 13.798 14.697 12zM20 10.869L18.303 12 20 13.131V10.87zM19.197 9L13 4.869v3.596l3.5 2.333L19.197 9zM7.5 10.798L11 8.465V4.869L4.803 9 7.5 10.798zM4.803 15L11 19.131v-3.596l-3.5-2.333L4.803 15zM4 13.131L5.697 12 4 10.869v2.262zM2 9a1 1 0 0 1 .445-.832l9-6a1 1 0 0 1 1.11 0l9 6A1 1 0 0 1 22 9v6a1 1 0 0 1-.445.832l-9 6a1 1 0 0 1-1.11 0l-9-6A1 1 0 0 1 2 15V9z"/></symbol><symbol id="close-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M12 10.586l4.95-4.95 1.414 1.414-4.95 4.95 4.95 4.95-1.414 1.414-4.95-4.95-4.95 4.95-1.414-1.414 4.95-4.95-4.95-4.95L7.05 5.636z"/></symbol><symbol id="menu-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M3 4h18v2H3V4zm0 7h18v2H3v-2zm0 7h18v2H3v-2z"/></symbol></defs></svg></head><body class="dark" data-theme="dark"><div class="sidebar-container"><div class="sidebar" id="sidebar"><a href="/" class="sidebar-title sidebar-title-anchor">p5.beholder</a><div class="sidebar-items-container"><div class="sidebar-section-title with-arrow" data-isopen="false" id="Lkq_Pw7loldzme-6DicJv"><div>Classes</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="P5Beholder.html">P5Beholder</a></div></div><div class="sidebar-section-title with-arrow" data-isopen="false" id="lonO2ZpEFHAclK9q9bcyN"><div>Global</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="global.html#p5beholder">p5beholder</a></div></div></div></div></div><div class="navbar-container" id="VuAckcnZhf"><nav class="navbar"><div class="navbar-left-items"><div class="github-link navbar-item"><a id="repository" href="https://github.com/enricllagostera/p5.beholder" target="_blank">GitHub</a></div><div class="navbar-item"><a id="" href="https://enric.llagostera.com.br/" target="_blank">Made by Enric Llagostera</a></div></div><div class="navbar-right-items"><div class="navbar-right-item"><button class="icon-button search-button" aria-label="open-search"><svg><use xlink:href="#search-icon"></use></svg></button></div><div class="navbar-right-item"><button class="icon-button theme-toggle" aria-label="toggle-theme"><svg><use class="theme-svg-use" xlink:href="#light-theme-icon"></use></svg></button></div><div class="navbar-right-item"><button class="icon-button font-size" aria-label="change-font-size"><svg><use xlink:href="#font-size-icon"></use></svg></button></div></div><nav></nav></nav></div><div class="toc-container"><div class="toc-content"><span class="bold">On this page</span><div id="eed4d2a0bfd64539bb9df78095dec881"></div></div></div><div class="body-wrapper"><div class="main-content"><div class="main-wrapper"><section><header><h1 id="P5Beholder-title" class="has-anchor">P5Beholder</h1><div class="class-description"><p>The main class of the library. It should have a single instance per sketch, which is then prepared at the <code>setup()</code> function.</p></div></header><article><div class="container-overview"><h2 id="constructor" class="has-anchor">Constructor</h2><h3 class="name has-anchor" id="P5Beholder"><span class="type-signature">(private) </span>new P5Beholder<span class="signature">()</span><span class="type-signature"></span></h3><div class="description"><p>Creates an instance of P5Beholder. It is automatically called during p5 loading. Initialization of the library is only compelte after <code>prepare()</code> is called on sketch setup (see <a href="P5Beholder.html#prepare">P5Beholder#prepare</a>).</p></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="p5.beholder.js.html">p5.beholder.js</a>, <a href="p5.beholder.js.html#line4">line 4</a></li></ul></dd></div></dl></div><h2 id="members" class="subsection-title has-anchor">Members</h2><h3 class="name has-anchor" id="._defaultConfig"><span class="type-signature">(static) </span>_defaultConfig<span class="type-signature"></span></h3><div class="description"><p>An object holding camera, detection, feed and overlay default options for the Beholder detection system.</p></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="p5.beholder.js.html">p5.beholder.js</a>, <a href="p5.beholder.js.html#line257">line 257</a></li></ul></dd></div></dl><b>Example</b><div class="rel"><pre class="prettyprint"><code>// Structure of the default configuration object
{
camera_params: {
videoSize: 0, // The video size values map to the following [320 x 240, 640 x 480, 1280 x 720, 1920 x 1080]
rearCamera: false, // Boolean value for defaulting to the rear facing camera. Only works on mobile
torch: false, // Boolean value for if torch/flashlight is on. Only works for rear facing mobile cameras. Can only be set from init
},
detection_params: {
minMarkerDistance: 10,
minMarkerPerimeter: 0.2,
maxMarkerPerimeter: 0.8,
sizeAfterPerspectiveRemoval: 49,
},
feed_params: {
contrast: 0,
brightness: 0,
grayscale: 0,
flip: false,
},
overlay_params: {
present: true, // Determines if the Beholder overlay will display or be invisible entirely via display: none
hide: true, // Determines if the overlay should be hidden on the left of the screen or visible
},
}</code></pre></div><h2 id="methods" class="subsection-title has-anchor">Methods</h2><h3 class="name has-anchor" id="angleInRange"><span class="type-signature"></span>angleInRange<span class="signature">(currentAngle, detectionTargetAngle, angleRange)</span><span class="type-signature"> → {true|false}</span></h3><div class="description"><p>Checks if the current angle is within a defined range from a target angle. All angles are in radians.</p></div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Parameters:</strong><table class="params"><thead><tr><th>Name</th><th>Type</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>currentAngle</code></td><td class="type"><span class="param-type">number</span></td><td class="description last"><p>Value to be checked.</p></td></tr><tr><td class="name"><code>detectionTargetAngle</code></td><td class="type"><span class="param-type">number</span></td><td class="description last"><p>The target angle.</p></td></tr><tr><td class="name"><code>angleRange</code></td><td class="type"><span class="param-type">number</span></td><td class="description last"><p>The range centers around the target angle. Should be less than PI.</p></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="p5.beholder.js.html">p5.beholder.js</a>, <a href="p5.beholder.js.html#line212">line 212</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><dl class="param-type"><dt>Type: </dt><dd><span class="param-type">true</span> |<wbr> <span class="param-type">false</span></dd></dl></div><h3 class="name has-anchor" id="cameraToCanvasVector"><span class="type-signature"></span>cameraToCanvasVector<span class="signature">(coord)</span><span class="type-signature"> → {p5.Vector}</span></h3><div class="description"><p>Converts a position from camera to canvas using a p5.Vector.</p></div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Parameters:</strong><table class="params"><thead><tr><th>Name</th><th>Type</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>coord</code></td><td class="type"><span class="param-type">p5.<wbr>Vector</span></td><td class="description last"><p>p5.Vector with camera position.</p></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="p5.beholder.js.html">p5.beholder.js</a>, <a href="p5.beholder.js.html#line171">line 171</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc"><ul><li>p5.Vector with canvas position.</li></ul></div><dl class="param-type"><dt>Type: </dt><dd><span class="param-type">p5.<wbr>Vector</span></dd></dl></div><h3 class="name has-anchor" id="cameraToCanvasX"><span class="type-signature"></span>cameraToCanvasX<span class="signature">(x)</span><span class="type-signature"> → {number}</span></h3><div class="description"><p>Converts X position from camera to canvas.</p></div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Parameters:</strong><table class="params"><thead><tr><th>Name</th><th>Type</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>x</code></td><td class="type"><span class="param-type">number</span></td><td class="description last"><p>Camera X position.</p></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="p5.beholder.js.html">p5.beholder.js</a>, <a href="p5.beholder.js.html#line151">line 151</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc"><ul><li>Canvas X position.</li></ul></div><dl class="param-type"><dt>Type: </dt><dd><span class="param-type">number</span></dd></dl></div><h3 class="name has-anchor" id="cameraToCanvasXY"><span class="type-signature"></span>cameraToCanvasXY<span class="signature">(pX, pY)</span><span class="type-signature"> → {p5.Vector}</span></h3><div class="description"><p>Converts a position from camera to canvas positions using 2 numbers.</p></div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Parameters:</strong><table class="params"><thead><tr><th>Name</th><th>Type</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>pX</code></td><td class="type"><span class="param-type">number</span></td><td class="description last"><p>Camera-relative X value.</p></td></tr><tr><td class="name"><code>pY</code></td><td class="type"><span class="param-type">number</span></td><td class="description last"><p>Camera-relative Y value.</p></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="p5.beholder.js.html">p5.beholder.js</a>, <a href="p5.beholder.js.html#line185">line 185</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc"><ul><li>p5.Vector with canvas position.</li></ul></div><dl class="param-type"><dt>Type: </dt><dd><span class="param-type">p5.<wbr>Vector</span></dd></dl></div><h3 class="name has-anchor" id="cameraToCanvasY"><span class="type-signature"></span>cameraToCanvasY<span class="signature">(y)</span><span class="type-signature"> → {number}</span></h3><div class="description"><p>Converts Y position from camera to canvas.</p></div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Parameters:</strong><table class="params"><thead><tr><th>Name</th><th>Type</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>y</code></td><td class="type"><span class="param-type">number</span></td><td class="description last"><p>Camera Y position.</p></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="p5.beholder.js.html">p5.beholder.js</a>, <a href="p5.beholder.js.html#line161">line 161</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc"><ul><li>Canvas Y position.</li></ul></div><dl class="param-type"><dt>Type: </dt><dd><span class="param-type">number</span></dd></dl></div><h3 class="name has-anchor" id="debugDrawMarker"><span class="type-signature"></span>debugDrawMarker<span class="signature">(markerId<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h3><div class="description"><p>Debug functionality for drawing a marker on the canvas.</p></div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Parameters:</strong><table class="params"><thead><tr><th>Name</th><th>Type</th><th>Attributes</th><th>Default</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>markerId</code></td><td class="type"><span class="param-type">number</span></td><td class="attributes"><optional><br></td><td class="default">0</td><td class="description last"><p>The id of the marker to draw.</p></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="p5.beholder.js.html">p5.beholder.js</a>, <a href="p5.beholder.js.html#line113">line 113</a></li></ul></dd></div></dl><h3 class="name has-anchor" id="markerPresenceToKey"><span class="type-signature"></span>markerPresenceToKey<span class="signature">(markerId<span class="signature-attributes">opt</span>, pKeyCode<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h3><div class="description"><p>Quick converter between marker presence and keyboard input. When a marker is detected, fires the <code>keydown</code> event. Whe the marker is undetected, fires the <code>keyup</code> event.</p></div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Parameters:</strong><table class="params"><thead><tr><th>Name</th><th>Type</th><th>Attributes</th><th>Default</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>markerId</code></td><td class="type"><span class="param-type">number</span></td><td class="attributes"><optional><br></td><td class="default">0</td><td class="description last"><p>The id of the marker to check.</p></td></tr><tr><td class="name"><code>pKeyCode</code></td><td class="type"><span class="param-type">number</span></td><td class="attributes"><optional><br></td><td class="default">32</td><td class="description last"><p>The number with the keyboard code (from <code>event.key</code>).</p></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="p5.beholder.js.html">p5.beholder.js</a>, <a href="p5.beholder.js.html#line77">line 77</a></li></ul></dd></div></dl><h3 class="name has-anchor" id="markerPresenceToMouseClick"><span class="type-signature"></span>markerPresenceToMouseClick<span class="signature">(markerId<span class="signature-attributes">opt, non-null</span>, clickX<span class="signature-attributes">opt</span>, clickY<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h3><div class="description"><p>If a marker is present, the mouse button 0 goes down and, when undetected, goes up. The position of the resulting click can be defined, in pixels.</p></div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Parameters:</strong><table class="params"><thead><tr><th>Name</th><th>Type</th><th>Attributes</th><th>Default</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>markerId</code></td><td class="type"><span class="param-type">number</span></td><td class="attributes"><optional><br></td><td class="default">0</td><td class="description last"><p>The id of the marker to check presence.</p></td></tr><tr><td class="name"><code>clickX</code></td><td class="type"><span class="param-type">number</span></td><td class="attributes"><optional><br></td><td class="default">0</td><td class="description last"><p>The X position where of the resulting click.</p></td></tr><tr><td class="name"><code>clickY</code></td><td class="type"><span class="param-type">number</span></td><td class="attributes"><optional><br></td><td class="default">0</td><td class="description last"><p>The Y position where of the resulting click.</p></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="p5.beholder.js.html">p5.beholder.js</a>, <a href="p5.beholder.js.html#line48">line 48</a></li></ul></dd></div></dl><h3 class="name has-anchor" id="markerRotationInRange"><span class="type-signature"></span>markerRotationInRange<span class="signature">(markerId, detectionTargetAngle, angleRange)</span><span class="type-signature"> → {true|false}</span></h3><div class="description"><p>Checks if a marker's rotation is within a specified range from a target angle. Useful for detecting things like a crank or spinner with a marker at its center. All angles are in radians.</p></div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Parameters:</strong><table class="params"><thead><tr><th>Name</th><th>Type</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>markerId</code></td><td class="type"><span class="param-type">number</span></td><td class="description last"><p>The id of the marker to be checked.</p></td></tr><tr><td class="name"><code>detectionTargetAngle</code></td><td class="type"><span class="param-type">number</span></td><td class="description last"><p>The target angle.</p></td></tr><tr><td class="name"><code>angleRange</code></td><td class="type"><span class="param-type">number</span></td><td class="description last"><p>The range centers around the target angle. Should be less than PI.</p></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="p5.beholder.js.html">p5.beholder.js</a>, <a href="p5.beholder.js.html#line198">line 198</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><dl class="param-type"><dt>Type: </dt><dd><span class="param-type">true</span> |<wbr> <span class="param-type">false</span></dd></dl></div><h3 class="name has-anchor" id="prepare"><span class="type-signature"></span>prepare<span class="signature">(config<span class="signature-attributes">opt</span>, querySelector<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h3><div class="description"><p>Sets-up the p5beholder and sketch integration. Adds Beholder to the HTML page at the and initializes it with proper config file. <strong>Important</strong>: must be called once on <code>setup()</code>. The config file must use <a href="P5Beholder.html#._defaultConfig">P5Beholder._defaultConfig</a> as a base.</p></div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Parameters:</strong><table class="params"><thead><tr><th>Name</th><th>Type</th><th>Attributes</th><th>Default</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>config</code></td><td class="type"><span class="param-type">*</span></td><td class="attributes"><optional><br></td><td class="default">P5Beholder._defaultConfig</td><td class="description last"><p>Controls how Beholder detection will run.</p></td></tr><tr><td class="name"><code>querySelector</code></td><td class="type"><span class="param-type">string</span></td><td class="attributes"><optional><br></td><td class="default">"#beholder_root"</td><td class="description last"><p>Picks an HTML element to be the parent of the Beholder system elements (GUI, etc).</p></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="p5.beholder.js.html">p5.beholder.js</a>, <a href="p5.beholder.js.html#line24">line 24</a></li></ul></dd></div></dl><h3 class="name has-anchor" id="setMarkersTimeout"><span class="type-signature"></span>setMarkersTimeout<span class="signature">(timeout<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h3><div class="description"><p>Changes the timeout value for all markers.</p></div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Parameters:</strong><table class="params"><thead><tr><th>Name</th><th>Type</th><th>Attributes</th><th>Default</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>timeout</code></td><td class="type"><span class="param-type">number</span></td><td class="attributes"><optional><br></td><td class="default">50</td><td class="description last"><p>New time in milliseconds.</p></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="p5.beholder.js.html">p5.beholder.js</a>, <a href="p5.beholder.js.html#line101">line 101</a></li></ul></dd></div></dl></article></section></div></div></div><div class="search-container" id="PkfLWpAbet" style="display:none"><div class="wrapper" id="iCxFxjkHbP"><button class="icon-button search-close-button" id="VjLlGakifb" aria-label="close search"><svg><use xlink:href="#close-icon"></use></svg></button><div class="search-box-c"><svg><use xlink:href="#search-icon"></use></svg> <input type="text" id="vpcKVYIppa" class="search-input" placeholder="Search..." autofocus></div><div class="search-result-c" id="fWwVHRuDuN"><span class="search-result-c-text">Type anything to view search result</span></div></div></div><div class="mobile-menu-icon-container"><button class="icon-button" id="mobile-menu" data-isopen="false" aria-label="menu"><svg><use xlink:href="#menu-icon"></use></svg></button></div><div id="mobile-sidebar" class="mobile-sidebar-container"><div class="mobile-sidebar-wrapper"><a href="/" class="sidebar-title sidebar-title-anchor">p5.beholder</a><div class="mobile-nav-links"><div class="github-link navbar-item"><a id="repository-mobile" href="https://github.com/enricllagostera/p5.beholder" target="_blank">GitHub</a></div><div class="navbar-item"><a id="" href="https://enric.llagostera.com.br/" target="_blank">Made by Enric Llagostera</a></div></div><div class="mobile-sidebar-items-c"><div class="sidebar-section-title with-arrow" data-isopen="false" id="Lkq_Pw7loldzme-6DicJv"><div>Classes</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="P5Beholder.html">P5Beholder</a></div></div><div class="sidebar-section-title with-arrow" data-isopen="false" id="lonO2ZpEFHAclK9q9bcyN"><div>Global</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="global.html#p5beholder">p5beholder</a></div></div></div><div class="mobile-navbar-actions"><div class="navbar-right-item"><button class="icon-button search-button" aria-label="open-search"><svg><use xlink:href="#search-icon"></use></svg></button></div><div class="navbar-right-item"><button class="icon-button theme-toggle" aria-label="toggle-theme"><svg><use class="theme-svg-use" xlink:href="#light-theme-icon"></use></svg></button></div><div class="navbar-right-item"><button class="icon-button font-size" aria-label="change-font-size"><svg><use xlink:href="#font-size-icon"></use></svg></button></div></div></div></div><script type="text/javascript" src="scripts/core.min.js"></script><script src="scripts/search.min.js" defer="defer"></script><script src="scripts/third-party/fuse.js" defer="defer"></script><script type="text/javascript">var tocbotInstance=tocbot.init({tocSelector:"#eed4d2a0bfd64539bb9df78095dec881",contentSelector:".main-content",headingSelector:"h1, h2, h3",hasInnerContainers:!0,scrollContainer:".main-content",headingsOffset:130,onClick:bringLinkToView})</script></body></html>