agentscript

Version:

AgentScript Model in Model/View architecture

1 lines • 35 kB

JSON

{"list":[{"title":"AgentArray.Symbol.species","link":"<a href=\"AgentArray.Symbol.html#.species\">species</a>","description":"Magic to return AgentArrays rather than AgentList\nor other AgentArray subclasses when using AA methods\n<a href=\"https://goo.gl/Zsxwxd\">Symbol.species</a>"},{"title":"AgentArray.fromArray","link":"<a href=\"AgentArray.html#.fromArray\">fromArray</a>","description":"Convert an existing Array to an AgentArray "in place".\nUse array.slice() if a new array is wanted"},{"title":"AgentArray","link":"<a href=\"AgentArray.html\">AgentArray</a>","description":"Creates an instance of AgentArray. Simply pass-through to super()\nnow, but may add initialization code later."},{"title":"AgentArray#toArray","link":"<a href=\"AgentArray.html#toArray\">toArray</a>","description":"See {@link World} and [MyClass's foo property]{@link World#bboxTransform}.\nConvert this AgentArray to Array in-place"},{"title":"AgentArray#isEmpty","link":"<a href=\"AgentArray.html#isEmpty\">isEmpty</a>","description":"Return true if there are no items in this Array"},{"title":"AgentArray#first","link":"<a href=\"AgentArray.html#first\">first</a>","description":"Return first item in this array. Returns undefined if empty."},{"title":"AgentArray#last","link":"<a href=\"AgentArray.html#last\">last</a>","description":"Return last item in this array. Returns undefined if empty."},{"title":"AgentArray#atIndex","link":"<a href=\"AgentArray.html#atIndex\">atIndex</a>","description":"Return at index. Returns undefined if empty.\nWrap the index to be within the array."},{"title":"AgentArray#all","link":"<a href=\"AgentArray.html#all\">all</a>","description":"Return true if fcn(element) returns true for each element in this array.\nSame as Array.every, using NetLogo's name"},{"title":"AgentArray#props","link":"<a href=\"AgentArray.html#props\">props</a>","description":"Return array of property values from this array's objects.\nArray type is specified, defaults to AgentArray"},{"title":"AgentArray#typedSample","link":"<a href=\"AgentArray.html#typedSample\">typedSample</a>","description":"Creates an Object of Arrays, one Array per each property in obj.\nObj is key, arrayType pairs: x: Float32Array\nThis is advanced, used for web workers, very large data sets, and remote communication"},{"title":"AgentArray#uniq","link":"<a href=\"AgentArray.html#uniq\">uniq</a>","description":"Return new AgentArray of the unique values of this array"},{"title":"AgentArray#forLoop","link":"<a href=\"AgentArray.html#forLoop\">forLoop</a>","description":"Call fcn(agent, index, array) for each item in AgentArray.\nIndex & array optional.\nArray assumed not mutable.\nNote: 5x+ faster than this.forEach(fcn)"},{"title":"AgentArray#ask","link":"<a href=\"AgentArray.html#ask\">ask</a>","description":"Call fcn(agent, [ i, AgentArray ]) for each agent in AgentArray.\nwhere i = agent's array index and AgentArray is this array\nArray can shrink. If it grows, will not visit beyond original length.\nIf it either shrinks or grows, it will console.log a message\n"ask" is NetLogo term."},{"title":"AgentArray#with","link":"<a href=\"AgentArray.html#with\">with</a>","description":"Use: turtles.with(t => t.foo > 20).ask(t => t.bar = true)"},{"title":"AgentArray#clone","link":"<a href=\"AgentArray.html#clone\">clone</a>","description":"Create copy of this AgentArray"},{"title":"AgentArray#sortBy","link":"<a href=\"AgentArray.html#sortBy\">sortBy</a>","description":"Return this AgentArray sorted by the reporter in ascending/descending order.\nIf reporter is a string, convert to a fcn returning that property."},{"title":"AgentList","link":"<a href=\"AgentList.html\">AgentList</a>"},{"title":"AgentList#inRect","link":"<a href=\"AgentList.html#inRect\">inRect</a>","description":"Return all agents within rectangle from given agent.\ndx & dy are (float) half width/height of rect"},{"title":"AgentList#inRadius","link":"<a href=\"AgentList.html#inRadius\">inRadius</a>","description":"Return all agents in AgentArray within radius from given agent."},{"title":"AgentList#inCone","link":"<a href=\"AgentList.html#inCone\">inCone</a>","description":"As above, but also limited to the angle <code>coneAngle</code> around\nan <code>angle</code> from object <code>agent</code>. coneAngle and direction in radians."},{"title":"AgentSet.Symbol.species","link":"<a href=\"AgentSet.Symbol.html#.species\">species</a>","description":"Magic to return AgentArrays rather than AgentSets\n<a href=\"https://goo.gl/Zsxwxd\">Symbol.species</a>"},{"title":"AgentSet","link":"<a href=\"AgentSet.html\">AgentSet</a>"},{"title":"AgentSet#protoMixin","link":"<a href=\"AgentSet.html#protoMixin\">protoMixin</a>","description":"Add common variables to an Agent being added to this AgentSet.\nEach Agent has it's AgentSet and the Model instance.\nIt also has an id, set by the AgentSet's global ID.\nThe Agent also has three methods added: setBreed, getBreed, isBreed."},{"title":"AgentSet#addAgent","link":"<a href=\"AgentSet.html#addAgent\">addAgent</a>","description":"Add an Agent to this AgentSet. Only used by factory methods.\nAdds the <code>id</code> property to Agent. Increment AgentSet <code>ID</code>."},{"title":"AgentSet#removeAgent","link":"<a href=\"AgentSet.html#removeAgent\">removeAgent</a>","description":"Remove an Agent from this AgentSet"},{"title":"AgentSet#setBreed","link":"<a href=\"AgentSet.html#setBreed\">setBreed</a>","description":"Move an agent from its AgentSet/breed to be in this AgentSet/breed"},{"title":"AgentSet#setDefault","link":"<a href=\"AgentSet.html#setDefault\">setDefault</a>","description":"Set a default value shared by all Agents in this AgentSet"},{"title":"AgentSet#getDefault","link":"<a href=\"AgentSet.html#getDefault\">getDefault</a>","description":"Return a default, shared value"},{"title":"AgentSet#newBreed","link":"<a href=\"AgentSet.html#newBreed\">newBreed</a>","description":"Create a subarray of this AgentSet.\nExample: create a people breed of Turtles:\n<code>people = turtles.newBreed('people')</code>"},{"title":"AgentSet#isBreedSet","link":"<a href=\"AgentSet.html#isBreedSet\">isBreedSet</a>"},{"title":"AgentSet#isBaseSet","link":"<a href=\"AgentSet.html#isBaseSet\">isBaseSet</a>"},{"title":"AgentSet#withBreed","link":"<a href=\"AgentSet.html#withBreed\">withBreed</a>","description":"Return breeds in a subset of an AgentSet\nEx: patches.inRect(5).withBreed(houses)"},{"title":"AgentSet#clear","link":"<a href=\"AgentSet.html#clear\">clear</a>","description":"Remove all Agents from this AgentSet using agent.die() for each agent."},{"title":"AgentSet#ask","link":"<a href=\"AgentSet.html#ask\">ask</a>","description":"Call fcn(agent, index, array) for each item in AgentArray.\nIndex & array optional. Overrides AgentArray's ask with\nadditional guards for modifications in AgentSet's array."},{"title":"Animator","link":"<a href=\"Animator.html\">Animator</a>","description":"Sets parameters, then calls start().\nTo have the model not start immediately do:\n<ul>\n<li>const anim = new Animator(<args>).stop()</li>\n</ul>"},{"title":"Animator#start","link":"<a href=\"Animator.html#start\">start</a>","description":"Starts the model running"},{"title":"Animator#stop","link":"<a href=\"Animator.html#stop\">stop</a>","description":"Stops the model running"},{"title":"Color","link":"<a href=\"Color.html\">Color</a>"},{"title":"Color.rgbaCssColor","link":"<a href=\"Color.html#.rgbaCssColor\">rgbaCssColor</a>","description":"Convert 4 r,g,b,a ints in [0-255] ("a" defaulted to 255) to a\ncss color string."},{"title":"Color.hslCssColor","link":"<a href=\"Color.html#.hslCssColor\">hslCssColor</a>","description":"Convert 4 ints, h,s,l,a, h in [0-360], s,l in [0-100]% a in [0-255] to a\ncss color string.\nSee <a href=\"https://developer.mozilla.org/en-US/docs/Web/CSS/color_value/hsl\">hsl()</a>.\nNOTE: h=0 and h=360 are the same, use h in 0-359 for unique colors."},{"title":"Color.hexCssColor","link":"<a href=\"Color.html#.hexCssColor\">hexCssColor</a>","description":"Return a html/css hex color string for an r,g,b opaque color (a=255).\nHex strings do not support alpha.\nBoth #nnn and #nnnnnn forms supported.\nDefault is to check for the short hex form."},{"title":"ColorMap","link":"<a href=\"ColorMap.html\">ColorMap</a>"},{"title":"ColorMap.gradientImageData","link":"<a href=\"ColorMap.html#.gradientImageData\">gradientImageData</a>","description":"Ask the browser to use the canvas gradient feature\nto create nColors given the gradient color stops and locs.\nSee Mozilla <a href=\"https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/createLinearGradient\">Gradient Doc</a>,\nThis is a powerful browser feature, can be\nused to create all the MatLab colormaps.\nStops are css strings.\nLocs are floats from 0-1, default is equally spaced."},{"title":"ColorMap.arrayToTypedColors","link":"<a href=\"ColorMap.html#.arrayToTypedColors\">arrayToTypedColors</a>","description":"Convert an Array of rgba color arrays into Array of 4 element typedColors."},{"title":"DataSet.emptyDataSet","link":"<a href=\"DataSet.html#.emptyDataSet\">emptyDataSet</a>","description":"Factory method returning an empty dataset of given\nwidth, height, dataType"},{"title":"DataSet","link":"<a href=\"DataSet.html\">DataSet</a>","description":"Creates an instance of DataSet.\nChecks data is right size, throws an error if not."},{"title":"GUI","link":"<a href=\"GUI.html\">GUI</a>"},{"title":"GeoDataSet","link":"<a href=\"GeoDataSet.html\">GeoDataSet</a>","description":"Mostly the same a DataSet except it has bounds.\nA few methods, like slope, dzdx, dzdy, and aspect are different because they take into account the size of the bbox in meters"},{"title":"GeoDataSet.viewFromDataSet","link":"<a href=\"GeoDataSet.html#.viewFromDataSet\">viewFromDataSet</a>","description":"Create a view of a Dataset including the bounds."},{"title":"GeoDataSet#sampleGeo","link":"<a href=\"GeoDataSet.html#sampleGeo\">sampleGeo</a>","description":"Samples a pixel at a given latitude and longitude"},{"title":"GeoDataSet#dzdx","link":"<a href=\"GeoDataSet.html#dzdx\">dzdx</a>","description":"Change in z value in terms of x. Finite difference."},{"title":"GeoDataSet#dzdy","link":"<a href=\"GeoDataSet.html#dzdy\">dzdy</a>","description":"Change in z value in terms of y. Finite difference."},{"title":"GeoDataSet#slopeAndAspect","link":"<a href=\"GeoDataSet.html#slopeAndAspect\">slopeAndAspect</a>","description":"Create dzdx, dzdy, slope, and aspect in one function."},{"title":"GeoDataSet#aspect","link":"<a href=\"GeoDataSet.html#aspect\">aspect</a>","description":"The aspect of each pixel in radians."},{"title":"GeoDataSet#slope","link":"<a href=\"GeoDataSet.html#slope\">slope</a>","description":"Returns the slope in radians"},{"title":"Keyboard","link":"<a href=\"Keyboard.html\">Keyboard</a>","description":"Creates an instance of Keyboard.\nThe objects in the keyTemplates look like:"},{"title":"Keyboard#start","link":"<a href=\"Keyboard.html#start\">start</a>","description":"Start the keyboard running"},{"title":"Keyboard#stop","link":"<a href=\"Keyboard.html#stop\">stop</a>","description":"Stop the keyboard running"},{"title":"Link","link":"<a href=\"Link.html\">Link</a>"},{"title":"Links","link":"<a href=\"Links.html\">Links</a>"},{"title":"Model","link":"<a href=\"Model.html\">Model</a>","description":"Creates an instance of Model.\nThe worldOptions define the coordinate system for this model\nThe {@link World} options sets xMin, xMax, yMin, yMax\nand when using 3D: zMin, zMax\nFine point: Can also be an instance of World or GeoWorld"},{"title":"Model#initModel","link":"<a href=\"Model.html#initModel\">initModel</a>","description":"Initialize model to initial state w/ new Patches, Turtles, Links.\nThe worldOptions will default to initial values but can be\nchanged by modeler."},{"title":"Model#reset","link":"<a href=\"Model.html#reset\">reset</a>","description":"Reset the model by clearing the turtles, setting ID & ticks to 0\nand calling setup()"},{"title":"Model#tick","link":"<a href=\"Model.html#tick\">tick</a>","description":"Increment the tick cound. Not needed if autoTick true, the default"},{"title":"Model#startup","link":"<a href=\"Model.html#startup\">startup</a>","description":"An abstract method to perform one-time initialization.\nSubclasses provide their versions of this to import data."},{"title":"Model#setup","link":"<a href=\"Model.html#setup\">setup</a>","description":"An abstract method for initializing the model\nSubclasses provide their version of this to initialice the model"},{"title":"Model#step","link":"<a href=\"Model.html#step\">step</a>","description":"An abstract method to run the model one step."},{"title":"Model#patchBreeds","link":"<a href=\"Model.html#patchBreeds\">patchBreeds</a>","description":"Create breeds (sub-arrays) of Patches. Used in the Exit model:\n<ul>\n<li>this.patchBreeds('exits inside wall')</li>\n</ul>"},{"title":"Model#turtleBreeds","link":"<a href=\"Model.html#turtleBreeds\">turtleBreeds</a>","description":"Create breeds (sub-arrays) of Turtles. Used in Wallfollower model:\n<ul>\n<li>this.turtleBreeds('lefty righty')</li>\n</ul>"},{"title":"Model#linkBreeds","link":"<a href=\"Model.html#linkBreeds\">linkBreeds</a>","description":"Create breeds (sub-arrays) of Links. Used in Roads model:\n<ul>\n<li>this.linkBreeds('trips')</li>\n</ul>"},{"title":"Model3D","link":"<a href=\"Model3D.html\">Model3D</a>"},{"title":"Mouse","link":"<a href=\"Mouse.html\">Mouse</a>","description":"Create and start mouse obj, args: a model, and a callback method."},{"title":"Mouse#start","link":"<a href=\"Mouse.html#start\">start</a>","description":"Start the mouseListeners."},{"title":"Mouse#stop","link":"<a href=\"Mouse.html#stop\">stop</a>","description":"Start the mouseListeners."},{"title":"Patch","link":"<a href=\"Patch.html\">Patch</a>"},{"title":"Patch#isOnEdge","link":"<a href=\"Patch.html#isOnEdge\">isOnEdge</a>","description":"Return whether or not this patch is on the edge of the atches."},{"title":"Patch#neighbors","link":"<a href=\"Patch.html#neighbors\">neighbors</a>","description":"Return an array of this patch's 8\n<a href=\"https://en.wikipedia.org/wiki/Moore_neighborhood\">Moore neighbors</a>."},{"title":"Patch#neighbors4","link":"<a href=\"Patch.html#neighbors4\">neighbors4</a>","description":"Return an array of this patch's 4\n<a href=\"https://en.wikipedia.org/wiki/Von_Neumann_neighborhood\">Von Neumann neighbors</a>\n(north, south, east, west)."},{"title":"Patch#turtlesHere","link":"<a href=\"Patch.html#turtlesHere\">turtlesHere</a>","description":"Return an Array of the turtles on this patch."},{"title":"Patch#breedsHere","link":"<a href=\"Patch.html#breedsHere\">breedsHere</a>","description":"Returns an Array of the particular breed on this patch."},{"title":"Patches","link":"<a href=\"Patches.html\">Patches</a>","description":"Creates an instance of Patches."},{"title":"Patches#neighbors","link":"<a href=\"Patches.html#neighbors\">neighbors</a>","description":"Return the 8 patch\n<a href=\"https://en.wikipedia.org/wiki/Moore_neighborhood\">"Moore" neighbors</a>\nof the given patch.\nWill be less than 8 on the edge of the patches"},{"title":"Patches#neighbors4","link":"<a href=\"Patches.html#neighbors4\">neighbors4</a>","description":"Return the 4 patch\n<a href=\"https://en.wikipedia.org/wiki/Von_Neumann_neighborhood\">"Van Neumann" neighbors</a>\nof the given patch.\nWill be less than 4 on the edge of the patches"},{"title":"Patches#importDataSet","link":"<a href=\"Patches.html#importDataSet\">importDataSet</a>","description":"Assign a DataSet's values into the patches as the given property name"},{"title":"Patches#exportDataSet","link":"<a href=\"Patches.html#exportDataSet\">exportDataSet</a>","description":"Extract a property from each Patch as a DataSet"},{"title":"Patches#patchIndex","link":"<a href=\"Patches.html#patchIndex\">patchIndex</a>","description":"Return index into Patches given valid x,y integers"},{"title":"RGBDataSet.rgbToInt24","link":"<a href=\"RGBDataSet.html#.rgbToInt24\">rgbToInt24</a>","description":"Convert an r,g,b triple into an integer"},{"title":"RGBDataSet.rgbScaleFunction","link":"<a href=\"RGBDataSet.html#.rgbScaleFunction\">rgbScaleFunction</a>","description":"As above with min/scale"},{"title":"RGBDataSet","link":"<a href=\"RGBDataSet.html\">RGBDataSet</a>","description":"Create a {@link DataSet} from image pixel data"},{"title":"ThreeDraw","link":"<a href=\"ThreeDraw.html\">ThreeDraw</a>"},{"title":"Turtle","link":"<a href=\"Turtle.html\">Turtle</a>"},{"title":"Turtle#die","link":"<a href=\"Turtle.html#die\">die</a>","description":"Ask this turtle to "die"\n<ul>\n<li>Removes itself from the Turtles array</li>\n<li>Removes itself from any Turtles breeds</li>\n<li>Removes all my Links if any exist</li>\n<li>Removes me from my Patch list of turtles on it</li>\n<li>Set it's id to -1 to indicate to others it's gone</li>\n</ul>"},{"title":"Turtle#hatch","link":"<a href=\"Turtle.html#hatch\">hatch</a>","description":"Factory method: create num new turtles at this turtle's location."},{"title":"Turtle#links","link":"<a href=\"Turtle.html#links\">links</a>","description":"Returns an array of the Links that have this Turtle as one of the end points"},{"title":"Turtle#patch","link":"<a href=\"Turtle.html#patch\">patch</a>","description":"Return the patch this Turtle is on. Return null if Turtle off-world."},{"title":"Turtle#heading","link":"<a href=\"Turtle.html#heading\">heading</a>","description":"Return this Turtle's heading"},{"title":"Turtle#heading","link":"<a href=\"Turtle.html#heading\">heading</a>","description":"Sets this Turtle's heading"},{"title":"Turtle#subtractHeading","link":"<a href=\"Turtle.html#subtractHeading\">subtractHeading</a>","description":"Computes the difference between the my heading and the given heading,\nthe smallest angle by which t could be rotated to produce heading."},{"title":"Turtle#setxy","link":"<a href=\"Turtle.html#setxy\">setxy</a>","description":"Set Turtles x, y position. If z given, override default z of 0."},{"title":"Turtle#handleEdge","link":"<a href=\"Turtle.html#handleEdge\">handleEdge</a>","description":"Handle turtle x,y,z if turtle off-world.\nUses the Turtle's atEdge property to determine how to manage the Turtle.\nDefaults to 'wrap', wrapping the x,y,z to the opposite edge.\natEdge can be:\n<ul>\n<li>'die'</li>\n<li>'wrap'</li>\n<li>'bounce'</li>\n<li>'clamp'</li>\n<li>'random'</li>\n<li>a function called with the Turtle as it's argument</li>\n</ul>"},{"title":"Turtle#moveTo","link":"<a href=\"Turtle.html#moveTo\">moveTo</a>","description":"Place the turtle at the given patch/turtle location"},{"title":"Turtle#forward","link":"<a href=\"Turtle.html#forward\">forward</a>","description":"Move forward, along the Turtle's heading d units in Patch coordinates"},{"title":"Turtle#rotate","link":"<a href=\"Turtle.html#rotate\">rotate</a>","description":"Change Turtle's heading by angle"},{"title":"Turtle#right","link":"<a href=\"Turtle.html#right\">right</a>","description":"Turn Turtle right by angle"},{"title":"Turtle#left","link":"<a href=\"Turtle.html#left\">left</a>","description":"Turn Turtle left by angle"},{"title":"Turtle#face","link":"<a href=\"Turtle.html#face\">face</a>","description":"Turn turtle so at to be facing the given Turtle or Patch"},{"title":"Turtle#facexy","link":"<a href=\"Turtle.html#facexy\">facexy</a>","description":"Turn turtle so at to be facing the given x, y patch coordinate"},{"title":"Turtle#patchAhead","link":"<a href=\"Turtle.html#patchAhead\">patchAhead</a>","description":"Return the patch ahead of this turtle by distance.\nReturn undefined if the distance puts the patch off-world"},{"title":"Turtle#patchRightAndAhead","link":"<a href=\"Turtle.html#patchRightAndAhead\">patchRightAndAhead</a>","description":"Return the patch angle to the right and ahead by distance\nReturn undefined if the distance puts the patch off-world"},{"title":"Turtle#patchLeftAndAhead","link":"<a href=\"Turtle.html#patchLeftAndAhead\">patchLeftAndAhead</a>","description":"Return the patch angle to the left and ahead by distance\nReturn undefined if the distance puts the patch off-world"},{"title":"Turtle#canMove","link":"<a href=\"Turtle.html#canMove\">canMove</a>","description":"Can I move forward by distance and not be off-world?"},{"title":"Turtle#distanceXY","link":"<a href=\"Turtle.html#distanceXY\">distanceXY</a>","description":"Distance from this turtle to x, y\nNo off-world test done.\n2.5D: use z too if both z & this.z exist."},{"title":"Turtle#distance","link":"<a href=\"Turtle.html#distance\">distance</a>","description":"Return distance from me to the Patch or Turtle\n2.5D: use z too if both agent.z and this.z exist"},{"title":"Turtle#dx","link":"<a href=\"Turtle.html#dx\">dx</a>","description":"A property for the x-increment if the turtle were to take one step\nforward in its current heading."},{"title":"Turtle#dy","link":"<a href=\"Turtle.html#dy\">dy</a>","description":"A property for the y-increment if the turtle were to take one step\nforward in its current heading."},{"title":"Turtle#towards","link":"<a href=\"Turtle.html#towards\">towards</a>","description":"Return the heading towards the Patch or Turtle given."},{"title":"Turtle#towardsXY","link":"<a href=\"Turtle.html#towardsXY\">towardsXY</a>","description":"Return the heading towards the given x,y coordinates."},{"title":"Turtle#patchAt","link":"<a href=\"Turtle.html#patchAt\">patchAt</a>","description":"The patch at dx, dy from my current position.\nReturn undefined if off-world"},{"title":"Turtle#patchAtHeadingAndDistance","link":"<a href=\"Turtle.html#patchAtHeadingAndDistance\">patchAtHeadingAndDistance</a>","description":"Return the patch at the absolute, not relative heading and distance\nfrom this turtle. Return undefined if off-world\nUse the Left/Right versions for relative heading."},{"title":"Turtle#otherEnd","link":"<a href=\"Turtle.html#otherEnd\">otherEnd</a>","description":"Return the other end of this link from me. Link must include me!\nSee links property for all my links, if any."},{"title":"Turtle#linkNeighbors","link":"<a href=\"Turtle.html#linkNeighbors\">linkNeighbors</a>","description":"Return all turtles linked to me. Basically me.otherEnd of all my links."},{"title":"Turtle#isLinkNeighbor","link":"<a href=\"Turtle.html#isLinkNeighbor\">isLinkNeighbor</a>","description":"Is the given Turtle linked to me?"},{"title":"Turtle3D","link":"<a href=\"Turtle3D.html\">Turtle3D</a>"},{"title":"Turtle3D#reset","link":"<a href=\"Turtle3D.html#reset\">reset</a>","description":"Resets this turtle's position, rotation and heading all to 0's"},{"title":"Turtle3D#setxyz","link":"<a href=\"Turtle3D.html#setxyz\">setxyz</a>","description":"Set's this turtle's 3D, x y z, position"},{"title":"Turtles","link":"<a href=\"Turtles.html\">Turtles</a>"},{"title":"Turtles#createOne","link":"<a href=\"Turtles.html#createOne\">createOne</a>","description":"Create a single Turtle, adding it to this Turtles array.\nThe init function is called to initialize the new Turtle.\nReturns the new Turtle."},{"title":"Turtles#create","link":"<a href=\"Turtles.html#create\">create</a>","description":"Create num Turtles, adding them to this Turtles array.\nThe init function is called to initialize each new Turtle.\nReturns an array of the new Turtles"},{"title":"Turtles#closestTurtle","link":"<a href=\"Turtles.html#closestTurtle\">closestTurtle</a>","description":"Return the closest turtle within radius distance of x,y.\nReturn null if no turtles within radius.\nIf I am a breed, return the closest fellow breed."},{"title":"Turtles#inPatches","link":"<a href=\"Turtles.html#inPatches\">inPatches</a>","description":"Return an array of Turtles within the array of patchs.\nIf I am a breed, return only the Turtles of my breed."},{"title":"Turtles#inPatchRect","link":"<a href=\"Turtles.html#inPatchRect\">inPatchRect</a>","description":"Return an array of Turtles within the dx,dy patchRect centered on turtle.\nIf I am a breed, return only the Turtles of my breed."},{"title":"Turtles#inPatchRectXY","link":"<a href=\"Turtles.html#inPatchRectXY\">inPatchRectXY</a>","description":"Return an array of Turtles within the dx,dy patchRect centered on x,y.\nIf I am a breed, return only the Turtles of my breed."},{"title":"Turtles#inRadius","link":"<a href=\"Turtles.html#inRadius\">inRadius</a>","description":"Return all the Turtles within radius of me.\nIf I am a breed, return only fellow breeds."},{"title":"Turtles#inCone","link":"<a href=\"Turtles.html#inCone\">inCone</a>","description":"Return all the Turtles with a cone of me.\nThe cone is coneAngle wide, centered on my heading.\nIf I am a breed, return only fellow breeds."},{"title":"Turtles#layoutCircle","link":"<a href=\"Turtles.html#layoutCircle\">layoutCircle</a>","description":"Position the Turtles in this breed in an equally spaced circle\nof the given center and radius.\nThe turtle headings will be away from the center."},{"title":"TwoDraw","link":"<a href=\"TwoDraw.html\">TwoDraw</a>"},{"title":"World.defaultOptions","link":"<a href=\"World.html#.defaultOptions\">defaultOptions</a>","description":"Return a default options object, origin at center."},{"title":"World.defaultWorld","link":"<a href=\"World.html#.defaultWorld\">defaultWorld</a>","description":"Factory to create a default World instance."},{"title":"World","link":"<a href=\"World.html\">World</a>","description":"Create a new World object given an Object with optional\nminX, maxX, minY, maxY, minZ, maxZ overriding class properties."},{"title":"World#getOptions","link":"<a href=\"World.html#getOptions\">getOptions</a>","description":"Return the options (minX, maxX, ..) used to create this world."},{"title":"World#randomPoint","link":"<a href=\"World.html#randomPoint\">randomPoint</a>","description":"Return a random 2D float point within the World"},{"title":"World#random3DPoint","link":"<a href=\"World.html#random3DPoint\">random3DPoint</a>","description":"Return a random 3D point within the World"},{"title":"World#randomPatchPoint","link":"<a href=\"World.html#randomPatchPoint\">randomPatchPoint</a>","description":"Return a random Patch 2D integer point"},{"title":"World#isOnWorld","link":"<a href=\"World.html#isOnWorld\">isOnWorld</a>","description":"Given x,y,z values return true if within the world"},{"title":"World#bboxTransform","link":"<a href=\"World.html#bboxTransform\">bboxTransform</a>","description":"Return an instance of a bounding box 2D transform.\nIt linearly interpolates between the given minX, minY, maxX, maxY,\nand the world's values of the same properties.\nThe parameters are in the popular geojson order: west, south, east, north\nUseful for Canvas (pixel) top-left transforms and geojson transforms.\nNote minX etc NOT the world's but of the coord sys we want to use."},{"title":"BBoxTransform#toWorld","link":"<a href=\"BBoxTransform.html#toWorld\">toWorld</a>","description":"Convert from bbox point to world point"},{"title":"BBoxTransform#toBBox","link":"<a href=\"BBoxTransform.html#toBBox\">toBBox</a>","description":"Convert from world point to bbox point"},{"title":"module:src/geojson","link":"<a href=\"module-src_geojson.html\">src/geojson</a>"},{"title":"module:src/geojson.flattenMultiLineStrings","link":"<a href=\"module-src_geojson.html#.flattenMultiLineStrings\">flattenMultiLineStrings</a>","description":"Flatten MultiLineStrings to single LineStrings features."},{"title":"module:src/geojson.lineStringsToLinks","link":"<a href=\"module-src_geojson.html#.lineStringsToLinks\">lineStringsToLinks</a>"},{"title":"module:src/gis","link":"<a href=\"module-src_gis.html\">src/gis</a>"},{"title":"module:src/gis.latlon","link":"<a href=\"module-src_gis.html#.latlon\">latlon</a>","description":"Current gis and geoJson uses [lon, lat] coords, i.e. x,y.\n<ul>\n<li>This converts these to [lat, lon], i.e. y,x as used by leaflet</li>\n<li>If Array contains multiple [lon, lat] subarrays, convert them all</li>\n</ul>"},{"title":"module:src/utils","link":"<a href=\"module-src_utils.html\">src/utils</a>"},{"title":"module:src/utils.pause","link":"<a href=\"module-src_utils.html#.pause\">pause</a>","description":"Return promise for pause of ms.\nUse: await pause(ms)"},{"title":"module:src/utils.timeoutLoop","link":"<a href=\"module-src_utils.html#.timeoutLoop\">timeoutLoop</a>","description":"Use pause for an animation loop.\nCalls the fcn each step\nStops after steps calls, negative means run forever"},{"title":"module:src/utils.randomInt","link":"<a href=\"module-src_utils.html#.randomInt\">randomInt</a>","description":"Returns ramdp, int in [0, max), equal or grater than 0, less than max"},{"title":"module:src/utils.randomInt2","link":"<a href=\"module-src_utils.html#.randomInt2\">randomInt2</a>","description":"Returns an int in [min, max), equal or grater than min, less than max"},{"title":"module:src/utils.randomFloat","link":"<a href=\"module-src_utils.html#.randomFloat\">randomFloat</a>","description":"Returns a random float in [0, max)"},{"title":"module:src/utils.randomFloat2","link":"<a href=\"module-src_utils.html#.randomFloat2\">randomFloat2</a>","description":"Returns a random float in [min, max)"},{"title":"module:src/utils.randomCentered","link":"<a href=\"module-src_utils.html#.randomCentered\">randomCentered</a>","description":"Return a random float centered around r, in [-r/2, r/2)"},{"title":"module:src/utils.randomSeed","link":"<a href=\"module-src_utils.html#.randomSeed\">randomSeed</a>","description":"Install a seeded random generator as Math.random\nUses an optimized version of the Park-Miller PRNG.\nMath.random will return a sequence of "random" numbers in a known\nsequence. Useful for testing to see if the same results\noccur in multiple runs of a model with the same parameters."},{"title":"module:src/utils.precision","link":"<a href=\"module-src_utils.html#.precision\">precision</a>","description":"Round a number to be of a given decimal precision.\nIf the number is an array, round each item in the array"},{"title":"module:src/utils.mod","link":"<a href=\"module-src_utils.html#.mod\">mod</a>","description":"A true modulus function, differing from the % remainder operation."},{"title":"module:src/utils.clamp","link":"<a href=\"module-src_utils.html#.clamp\">clamp</a>","description":"Clamp a float to be between [min, max)."},{"title":"module:src/utils.degToRad","link":"<a href=\"module-src_utils.html#.degToRad\">degToRad</a>","description":"Convert from degrees to radians"},{"title":"module:src/utils.radToDeg","link":"<a href=\"module-src_utils.html#.radToDeg\">radToDeg</a>","description":"Convert from radians to degrees"},{"title":"module:src/utils.radToHeading","link":"<a href=\"module-src_utils.html#.radToHeading\">radToHeading</a>","description":"Convert from radians to heading\nHeading is 0-up (y-axis), clockwise angle measured in degrees.\nRadians is euclidean: 0-right (x-axis), counterclockwise in radians"},{"title":"module:src/utils.headingToRad","link":"<a href=\"module-src_utils.html#.headingToRad\">headingToRad</a>","description":"Convert from heading to radians"},{"title":"module:src/utils.subtractHeadings","link":"<a href=\"module-src_utils.html#.subtractHeadings\">subtractHeadings</a>","description":"Subtract two headings, returning the smaller difference.\nComputes the difference between the given headings, that is,\nthe number of degrees in the smallest angle by which heading2\ncould be rotated to produce heading1\nSee NetLogo's <a href=\"http://goo.gl/CjoHuV\">subtract-headings</a> for explanation"},{"title":"module:src/utils.sampleModel","link":"<a href=\"module-src_utils.html#.sampleModel\">sampleModel</a>","description":"Return an object with samples of the models components.\nUseful for testing Models without needing a View, just data."},{"title":"module:src/utils.repeat","link":"<a href=\"module-src_utils.html#.repeat\">repeat</a>","description":"Repeats the function f(i, a) i in 0, n-1.\na is an optional array, default a new empty Array\nreturns a, only needed if f() places data in a"},{"title":"module:src/utils.oneOf","link":"<a href=\"module-src_utils.html#.oneOf\">oneOf</a>","description":"Return random item from an array"},{"title":"module:src/utils.imagePromise","link":"<a href=\"module-src_utils.html#.imagePromise\">imagePromise</a>","description":"Return a Promise for getting an image.\nSee https://deno.land/x/skia_canvas/mod.ts?s=Image for Image in deno\nuse: imagePromise('./path/to/img').then(img => imageFcn(img))\nor: await imagePromise('./path/to/img')"},{"title":"module:src/utils.createCanvas","link":"<a href=\"module-src_utils.html#.createCanvas\">createCanvas</a>","description":"Create a blank 2D canvas of a given width/height."},{"title":"module:src/utils.createCtx","link":"<a href=\"module-src_utils.html#.createCtx\">createCtx</a>","description":"As above, but returing the 2D context object instead of the canvas.\nNote ctx.canvas is the canvas for the ctx, and can be use as an image."},{"title":"module:src/utils.setCtxImage","link":"<a href=\"module-src_utils.html#.setCtxImage\">setCtxImage</a>","description":"Fill this context with the given image, resizing it to img size if needed."},{"title":"module:src/utils.toWindow","link":"<a href=\"module-src_utils.html#.toWindow\">toWindow</a>","description":"Merge a module's obj key/val pairs into to the global/window namespace.\nPrimary use is to make console logging easier when debugging\nmodules."}]}