- Notifications
You must be signed in to change notification settings - Fork 17
Expand file tree
/
Copy pathWorld.html
More file actions
Latest commit
11 lines (11 loc) · 28.3 KB
/
Copy pathWorld.html
File metadata and controls
11 lines (11 loc) · 28.3 KB
1
2
3
4
5
6
7
8
9
10
11
<!DOCTYPE html><htmllang="en" style="font-size:16px"><head><metacharset="utf-8"><metaname="viewport" content="width=device-width,initial-scale=1"><linkrel="icon" href="../favicon.ico"><title>Class: World</title><!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]--><scriptsrc="scripts/third-party/hljs.js" defer="defer"></script><scriptsrc="scripts/third-party/hljs-line-num.js" defer="defer"></script><scriptsrc="scripts/third-party/popper.js" defer="defer"></script><scriptsrc="scripts/third-party/tippy.js" defer="defer"></script><scriptsrc="scripts/third-party/tocbot.min.js"></script><script>varbaseURL="/",locationPathname="";baseURL=(locationPathname=document.location.pathname).substr(0,locationPathname.lastIndexOf("/")+1)</script><linkrel="stylesheet" href="styles/clean-jsdoc-theme.min.css"><svgaria-hidden="true" version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" style="display:none"><defs><symbolid="copy-icon" viewbox="0 0 488.3 488.3"><g><pathd="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"/><pathd="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><symbolid="search-icon" viewBox="0 0 512 512"><g><g><pathd="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><pathd="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><symbolid="font-size-icon" viewBox="0 0 24 24"><pathfill="none" d="M0 0h24v24H0z"/><pathd="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><symbolid="add-icon" viewBox="0 0 24 24"><pathfill="none" d="M0 0h24v24H0z"/><pathd="M11 11V5h2v6h6v2h-6v6h-2v-6H5v-2z"/></symbol><symbolid="minus-icon" viewBox="0 0 24 24"><pathfill="none" d="M0 0h24v24H0z"/><pathd="M5 11h14v2H5z"/></symbol><symbolid="dark-theme-icon" viewBox="0 0 24 24"><pathfill="none" d="M0 0h24v24H0z"/><pathd="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><symbolid="light-theme-icon" viewBox="0 0 24 24"><pathfill="none" d="M0 0h24v24H0z"/><pathd="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><symbolid="reset-icon" viewBox="0 0 24 24"><pathfill="none" d="M0 0h24v24H0z"/><pathd="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><symbolid="down-icon" viewBox="0 0 16 16"><pathfill-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><symbolid="codepen-icon" viewBox="0 0 24 24"><pathfill="none" d="M0 0h24v24H0z"/><pathd="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><symbolid="close-icon" viewBox="0 0 24 24"><pathfill="none" d="M0 0h24v24H0z"/><pathd="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><symbolid="menu-icon" viewBox="0 0 24 24"><pathfill="none" d="M0 0h24v24H0z"/><pathd="M3 4h18v2H3V4zm0 7h18v2H3v-2zm0 7h18v2H3v-2z"/></symbol></defs></svg></head><bodydata-theme="dark"><divclass="sidebar-container"><divclass="sidebar" id="sidebar"><ahref="/" class="sidebar-title sidebar-title-anchor">Home</a><divclass="sidebar-items-container"><divclass="sidebar-section-title with-arrow" data-isopen="false" id="sidebar-classes"><div>Classes</div><svg><usexlink:href="#down-icon"></use></svg></div><divclass="sidebar-section-children-container"><divclass="sidebar-section-children"><ahref="AgentArray.html">AgentArray</a></div><divclass="sidebar-section-children"><ahref="AgentList.html">AgentList</a></div><divclass="sidebar-section-children"><ahref="AgentSet.html">AgentSet</a></div><divclass="sidebar-section-children"><ahref="Animator.html">Animator</a></div><divclass="sidebar-section-children"><ahref="DataSet.html">DataSet</a></div><divclass="sidebar-section-children"><ahref="GUI.html">GUI</a></div><divclass="sidebar-section-children"><ahref="GeoDataSet.html">GeoDataSet</a></div><divclass="sidebar-section-children"><ahref="Keyboard.html">Keyboard</a></div><divclass="sidebar-section-children"><ahref="Link.html">Link</a></div><divclass="sidebar-section-children"><ahref="Links.html">Links</a></div><divclass="sidebar-section-children"><ahref="Model.html">Model</a></div><divclass="sidebar-section-children"><ahref="Model3D.html">Model3D</a></div><divclass="sidebar-section-children"><ahref="Mouse.html">Mouse</a></div><divclass="sidebar-section-children"><ahref="Patch.html">Patch</a></div><divclass="sidebar-section-children"><ahref="Patches.html">Patches</a></div><divclass="sidebar-section-children"><ahref="RGBDataSet.html">RGBDataSet</a></div><divclass="sidebar-section-children"><ahref="ThreeDraw.html">ThreeDraw</a></div><divclass="sidebar-section-children"><ahref="Turtle.html">Turtle</a></div><divclass="sidebar-section-children"><ahref="Turtle3D.html">Turtle3D</a></div><divclass="sidebar-section-children"><ahref="Turtles.html">Turtles</a></div><divclass="sidebar-section-children"><ahref="TwoDraw.html">TwoDraw</a></div><divclass="sidebar-section-children"><ahref="World.html">World</a></div></div><divclass="sidebar-section-title with-arrow" data-isopen="false" id="sidebar-modules"><div>Modules</div><svg><usexlink:href="#down-icon"></use></svg></div><divclass="sidebar-section-children-container"><divclass="sidebar-section-children"><ahref="module-src_geojson.html">src/geojson</a></div><divclass="sidebar-section-children"><ahref="module-src_gis.html">src/gis</a></div><divclass="sidebar-section-children"><ahref="module-src_utils.html">src/utils</a></div></div><divclass="sidebar-section-title with-arrow" data-isopen="false" id="sidebar-tutorials"><div>Tutorials</div><svg><usexlink:href="#down-icon"></use></svg></div><divclass="sidebar-section-children-container"><divclass="sidebar-section-children"><ahref="tutorial-1 - AgentScript.html">1 - AgentScript</a></div><divclass="sidebar-section-children"><ahref="tutorial-2 - JavaScript.html">2 - JavaScript</a></div><divclass="sidebar-section-children"><ahref="tutorial-3 - Browser.html">3 - Browser</a></div><div class="sidebar-section-children"><a href="tutorial-4 - Model.html">4 - Model</a></div><div class="sidebar-section-children"><a href="tutorial-5 - View.html">5 - View</a></div><div class="sidebar-section-children"><a href="tutorial-6.1 - AnimatorController.html">6.1 - AnimatorController</a></div><div class="sidebar-section-children"><a href="tutorial-6.2 - KeyboardController.html">6.2 - KeyboardController</a></div><div class="sidebar-section-children"><a href="tutorial-6.3 - GuiController.html">6.3 - GuiController</a></div><div class="sidebar-section-children"><a href="tutorial-6.4 - MouseController.html">6.4 - MouseController</a></div><div class="sidebar-section-children"><a href="tutorial-7 - CodePenServer.html">7 - CodePenServer</a></div></div></div></div></div><div class="navbar-container" id="VuAckcnZhf"><nav class="navbar"><div class="navbar-left-items"><div class="navbar-item"><a id="github" href="https://github.com/backspaces/agentscript" target="">Github</a></div><div class="navbar-item"><a id="AgentScript" href="https://agentscript.org" target="">AgentScript.org</a></div><div class="navbar-item"><a id="npm" href="https://www.npmjs.com/package/agentscript" target="">npm</a></div><div class="navbar-item"><a id="unpkg" href="https://unpkg.com/browse/agentscript/" target="">unpkg</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="World-title" class="has-anchor">World</h1><div class="class-description"><p>Class World defines the coordinate system for the model. It has transforms for multiple coordinate systems.</p><p>The world is defined by an object with 6 properties:</p><pre><code> WorldOptions = {
minX: integer,
maxX: integer,
minY: integer,
maxY: integer,
minZ: integer,
maxZ: integer,
}
</code></pre></div></header><article><divclass="container-overview"><h2id="constructor" class="has-anchor">Constructor</h2><h3class="name has-anchor" id="World"><spanclass="type-signature"></span>new World<spanclass="signature">(options)</span></h3><divclass="description"><p>Create a new World object given an Object with optional minX, maxX, minY, maxY, minZ, maxZ overriding class properties.</p></div><divclass="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Parameters:</strong><tableclass="params"><thead><tr><th>Name</th><th>Type</th><thclass="last">Description</th></tr></thead><tbody><tr><tdclass="name"><code>options</code></td><tdclass="type"><spanclass="param-type"><ahref="World.html">World</a></span> |<wbr><spanclass="param-type">WorldOptions</span> |<wbr><spanclass="param-type">Object</span></td><tdclass="description last"><p>Object with overrides for class properties</p></td></tr></tbody></table></div><dlclass="details"><divclass="details-item-container"><dtclass="tag-source bold">Source</dt><ddclass="tag-source"><ul><li><ahref="World.js.html">World.js</a>, <ahref="World.js.html#line35">line 35</a></li></ul></dd></div></dl></div><h2id="methods" class="subsection-title has-anchor">Methods</h2><h3class="name has-anchor" id=".defaultOptions"><spanclass="type-signature">(static) </span>defaultOptions<spanclass="signature">(maxX<spanclass="signature-attributes">opt</span>, maxY<spanclass="signature-attributes">opt</span>, maxZ<spanclass="signature-attributes">opt</span>)</span></h3><divclass="description"><p>Return a default options object, origin at center.</p></div><divclass="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Parameters:</strong><tableclass="params"><thead><tr><th>Name</th><th>Type</th><th>Attributes</th><th>Default</th><thclass="last">Description</th></tr></thead><tbody><tr><tdclass="name"><code>maxX</code></td><tdclass="type"><spanclass="param-type">number</span></td><tdclass="attributes"><optional><br></td><tdclass="default">16</td><tdclass="description last"><p>Integer max X value</p></td></tr><tr><tdclass="name"><code>maxY</code></td><tdclass="type"><spanclass="param-type">number</span></td><tdclass="attributes"><optional><br></td><tdclass="default">maxX</td><tdclass="description last"><p>Integer max Y value</p></td></tr><tr><tdclass="name"><code>maxZ</code></td><tdclass="type"><spanclass="param-type">number</span></td><tdclass="attributes"><optional><br></td><tdclass="default">Math.max(maxX, maxY)</td><tdclass="description last"><p>Integer max Z value</p></td></tr></tbody></table></div><dlclass="details"><divclass="details-item-container"><dtclass="tag-source bold">Source</dt><ddclass="tag-source"><ul><li><ahref="World.js.html">World.js</a>, <ahref="World.js.html#line53">line 53</a></li></ul></dd></div></dl><divclass="method-member-container mt-20"><strong>Returns:</strong><divclass="param-desc"><p>WorldOptions</p></div></div><h3class="name has-anchor" id=".defaultWorld"><spanclass="type-signature">(static) </span>defaultWorld<spanclass="signature">(maxX<spanclass="signature-attributes">opt</span>, maxY<spanclass="signature-attributes">opt</span>, maxZ<spanclass="signature-attributes">opt</span>)</span><spanclass="type-signature"> → {<ahref="World.html">World</a>}</span></h3><divclass="description"><p>Factory to create a default World instance.</p></div><divclass="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Parameters:</strong><tableclass="params"><thead><tr><th>Name</th><th>Type</th><th>Attributes</th><th>Default</th><thclass="last">Description</th></tr></thead><tbody><tr><tdclass="name"><code>maxX</code></td><tdclass="type"><spanclass="param-type">number</span></td><tdclass="attributes"><optional><br></td><tdclass="default">16</td><tdclass="description last"><p>Integer max X value</p></td></tr><tr><tdclass="name"><code>maxY</code></td><tdclass="type"><spanclass="param-type">number</span></td><tdclass="attributes"><optional><br></td><tdclass="default">maxX</td><tdclass="description last"><p>Integer max Y value</p></td></tr><tr><td class="name"><code>maxZ</code></td><td class="type"><span class="param-type">number</span></td><td class="attributes"><optional><br></td><td class="default">Math.max(maxX, maxY)</td><td class="description last"><p>Integer max Z 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="World.js.html">World.js</a>, <a href="World.js.html#line72">line 72</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"><a href="World.html">World</a></span></dd></dl></div><h3 class="name has-anchor" id="getOptions"><span class="type-signature"></span>getOptions<span class="signature">()</span><span class="type-signature"> → {Object}</span></h3><div class="description"><p>Return the options (minX, maxX, ..) used to create this world.</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="World.js.html">World.js</a>, <a href="World.js.html#line125">line 125</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc"><p>A WorldOptions object</p></div><dl class="param-type"><dt>Type: </dt><dd><span class="param-type">Object</span></dd></dl></div><h3 class="name has-anchor" id="randomPoint"><span class="type-signature"></span>randomPoint<span class="signature">()</span><span class="type-signature"> → {Array}</span></h3><div class="description"><p>Return a random 2D float point within the World</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="World.js.html">World.js</a>, <a href="World.js.html#line135">line 135</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc"><p>A random x,y float array</p></div><dl class="param-type"><dt>Type: </dt><dd><span class="param-type">Array</span></dd></dl></div><h3 class="name has-anchor" id="random3DPoint"><span class="type-signature"></span>random3DPoint<span class="signature">()</span><span class="type-signature"> → {Array}</span></h3><div class="description"><p>Return a random 3D point within the World</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="World.js.html">World.js</a>, <a href="World.js.html#line147">line 147</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc"><p>A random x,y,z float array</p></div><dl class="param-type"><dt>Type: </dt><dd><span class="param-type">Array</span></dd></dl></div><h3 class="name has-anchor" id="randomPatchPoint"><span class="type-signature"></span>randomPatchPoint<span class="signature">()</span><span class="type-signature"> → {Array}</span></h3><div class="description"><p>Return a random Patch 2D integer point</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="World.js.html">World.js</a>, <a href="World.js.html#line160">line 160</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc"><p>A random x,y integer array</p></div><dl class="param-type"><dt>Type: </dt><dd><span class="param-type">Array</span></dd></dl></div><h3 class="name has-anchor" id="isOnWorld"><span class="type-signature"></span>isOnWorld<span class="signature">(x, y, z<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {boolean}</span></h3><div class="description"><p>Given x,y,z values return true if within the world</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>x</code></td><td class="type"><span class="param-type">number</span></td><td class="attributes"></td><td class="default"></td><td class="description last"><p>x value</p></td></tr><tr><td class="name"><code>y</code></td><td class="type"><span class="param-type">number</span></td><td class="attributes"></td><td class="default"></td><td class="description last"><p>y value</p></td></tr><tr><td class="name"><code>z</code></td><td class="type"><span class="param-type">number</span></td><td class="attributes"><optional><br></td><td class="default">this.centerZ</td><td class="description last"><p>z 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="World.js.html">World.js</a>, <a href="World.js.html#line175">line 175</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc"><p>Whether or not on-world</p></div><dl class="param-type"><dt>Type: </dt><dd><span class="param-type">boolean</span></dd></dl></div><h3 class="name has-anchor" id="bboxTransform"><span class="type-signature"></span>bboxTransform<span class="signature">(minX, minY, maxX, maxY)</span><span class="type-signature"> → {<a href="BBoxTransform.html">BBoxTransform</a>}</span></h3><div class="description"><p>Return an instance of a bounding box 2D transform. It linearly interpolates between the given minX, minY, maxX, maxY, and the world's values of the same properties.</p><p>The parameters are in the popular geojson order: west, south, east, north</p><p>Useful for Canvas (pixel) top-left transforms and geojson transforms.</p><p>Note minX etc NOT the world's but of the coord sys we want to use.</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>minX</code></td><td class="type"><span class="param-type">number</span></td><td class="description last"><p>min bounding box x value</p></td></tr><tr><td class="name"><code>minY</code></td><td class="type"><span class="param-type">number</span></td><td class="description last"><p>min bounding box y value</p></td></tr><tr><td class="name"><code>maxX</code></td><td class="type"><span class="param-type">number</span></td><td class="description last"><p>max bounding box x value</p></td></tr><tr><td class="name"><code>maxY</code></td><td class="type"><span class="param-type">number</span></td><td class="description last"><p>max bounding box 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="World.js.html">World.js</a>, <a href="World.js.html#line206">line 206</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc"><p>Instance of the BBoxTransform</p></div><dl class="param-type"><dt>Type: </dt><dd><span class="param-type"><a href="BBoxTransform.html">BBoxTransform</a></span></dd></dl></div></article></section><footer class="footer" id="PeOAagUepe"><div class="wrapper">AgentScript version: 0.10.20 using clean-jsdoc-theme</div></footer></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">Home</a><div class="mobile-nav-links"><div class="navbar-item"><a id="github-mobile" href="https://github.com/backspaces/agentscript" target="">Github</a></div><div class="navbar-item"><a id="AgentScript-mobile" href="https://agentscript.org" target="">AgentScript.org</a></div><div class="navbar-item"><a id="npm-mobile" href="https://www.npmjs.com/package/agentscript" target="">npm</a></div><div class="navbar-item"><a id="unpkg-mobile" href="https://unpkg.com/browse/agentscript/" target="">unpkg</a></div></div><div class="mobile-sidebar-items-c"><div class="sidebar-section-title with-arrow" data-isopen="false" id="sidebar-classes"><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="AgentArray.html">AgentArray</a></div><div class="sidebar-section-children"><a href="AgentList.html">AgentList</a></div><div class="sidebar-section-children"><a href="AgentSet.html">AgentSet</a></div><div class="sidebar-section-children"><a href="Animator.html">Animator</a></div><div class="sidebar-section-children"><a href="DataSet.html">DataSet</a></div><div class="sidebar-section-children"><a href="GUI.html">GUI</a></div><div class="sidebar-section-children"><a href="GeoDataSet.html">GeoDataSet</a></div><div class="sidebar-section-children"><a href="Keyboard.html">Keyboard</a></div><div class="sidebar-section-children"><a href="Link.html">Link</a></div><div class="sidebar-section-children"><a href="Links.html">Links</a></div><div class="sidebar-section-children"><a href="Model.html">Model</a></div><div class="sidebar-section-children"><a href="Model3D.html">Model3D</a></div><div class="sidebar-section-children"><a href="Mouse.html">Mouse</a></div><div class="sidebar-section-children"><a href="Patch.html">Patch</a></div><div class="sidebar-section-children"><a href="Patches.html">Patches</a></div><div class="sidebar-section-children"><a href="RGBDataSet.html">RGBDataSet</a></div><div class="sidebar-section-children"><a href="ThreeDraw.html">ThreeDraw</a></div><div class="sidebar-section-children"><a href="Turtle.html">Turtle</a></div><div class="sidebar-section-children"><a href="Turtle3D.html">Turtle3D</a></div><div class="sidebar-section-children"><a href="Turtles.html">Turtles</a></div><div class="sidebar-section-children"><a href="TwoDraw.html">TwoDraw</a></div><div class="sidebar-section-children"><a href="World.html">World</a></div></div><div class="sidebar-section-title with-arrow" data-isopen="false" id="sidebar-modules"><div>Modules</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="module-src_geojson.html">src/geojson</a></div><div class="sidebar-section-children"><a href="module-src_gis.html">src/gis</a></div><div class="sidebar-section-children"><a href="module-src_utils.html">src/utils</a></div></div><div class="sidebar-section-title with-arrow" data-isopen="false" id="sidebar-tutorials"><div>Tutorials</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="tutorial-1 - AgentScript.html">1 - AgentScript</a></div><div class="sidebar-section-children"><a href="tutorial-2 - JavaScript.html">2 - JavaScript</a></div><div class="sidebar-section-children"><a href="tutorial-3 - Browser.html">3 - Browser</a></div><div class="sidebar-section-children"><a href="tutorial-4 - Model.html">4 - Model</a></div><div class="sidebar-section-children"><a href="tutorial-5 - View.html">5 - View</a></div><div class="sidebar-section-children"><a href="tutorial-6.1 - AnimatorController.html">6.1 - AnimatorController</a></div><div class="sidebar-section-children"><a href="tutorial-6.2 - KeyboardController.html">6.2 - KeyboardController</a></div><div class="sidebar-section-children"><a href="tutorial-6.3 - GuiController.html">6.3 - GuiController</a></div><div class="sidebar-section-children"><a href="tutorial-6.4 - MouseController.html">6.4 - MouseController</a></div><div class="sidebar-section-children"><a href="tutorial-7 - CodePenServer.html">7 - CodePenServer</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>