-
Notifications
You must be signed in to change notification settings - Fork 16
/
Copy pathTurtle.js.html
467 lines (446 loc) · 31.3 KB
/
Turtle.js.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
<!DOCTYPE html><html lang="en" style="font-size:16px"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width,initial-scale=1"><link rel="icon" href="../favicon.ico"><title>Source: Turtle.js</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 data-theme="dark"><div class="sidebar-container"><div class="sidebar" id="sidebar"><a href="/" class="sidebar-title sidebar-title-anchor">Home</a><div class="sidebar-items-container"><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></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://code.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 id="source-page" class="source-page"><header><h1 id="title" class="has-anchor">Turtle.js</h1></header><article><pre class="prettyprint source lang-js"><code>import AgentList from './AgentList.js'
import * as util from './utils.js'
/**
* Class Turtle instances represent the dynamic, behavioral element of modeling.
* Each turtle knows the patch it is on, and interacts with that and other
* patches, as well as other turtles. Turtles are also the end points of Links.
*
* You do not call `new Turtle()`, instead class Turtles creates Turtle instances
* via {@link Turtles#create} or {@link Turtles#createOne}
*
* I.e. class Turtles is a factory for all of it's Turtle instances.
* So *don't* do this:
*/
class Turtle {
static defaults = {
atEdge: 'wrap',
hidden: false,
z: 0,
// Set by AgentSet
agentSet: null,
model: null,
name: null,
}
static variables = {
id: null,
theta: 0,
x: 0,
y: 0,
}
constructor() {
Object.assign(this, Turtle.defaults)
}
newInstance(agentProto) {
const insstance = Object.create(agentProto)
Object.assign(insstance, Turtle.variables)
return insstance
}
/**
* Ask this turtle to "die"
* - Removes itself from the Turtles array
* - Removes itself from any Turtles breeds
* - Removes all my Links if any exist
* - Removes me from my Patch list of turtles on it
* - Set it's id to -1 to indicate to others it's gone
*/
die() {
if (this.id === -1) return
this.agentSet.removeAgent(this) // remove me from my baseSet and breeds
// Remove my links if any exist.
// Careful: don't promote links
if (this.hasOwnProperty('links')) {
while (this.links.length > 0) this.links[0].die()
}
// Remove me from patch.turtles cache if patch.turtles array exists
// if (this.patch.turtles != null) {
// util.removeArrayItem(this.patch.turtles, this)
// }
if (this.patch && this.patch.turtles)
util.removeArrayItem(this.patch.turtles, this)
// Set id to -1, indicates that I've died.
// Useful when other JS objects contain turtles. Views for example.
this.id = -1
}
isDead() {
return this.id === -1
}
/**
* Factory method: create num new turtles at this turtle's location.
*
* @param {number} [num=1] The number of new turtles to create
* @param {AgentSet} [breed=this.agentSet] The type of turtles to create,
* defaults to my type
* @param {Function} [init=turtle => {}] A function to initialize the new
* turtles, defaults to no-op
* @returns {Array} An Array of the new Turtles, generally ignored
* due to the init function
*/
hatch(num = 1, breed = this.agentSet, init = turtle => {}) {
return breed.create(num, turtle => {
// turtle.setxy(this.x, this.y)
turtle.setxy(this.x, this.y, this.z)
turtle.theta = this.theta
// // hatched turtle inherits parents' ownVariables
// for (const key of breed.ownVariables) {
// if (turtle[key] == null) turtle[key] = this[key]
// }
init(turtle)
})
}
// Getter for links for this turtle.
// Uses lazy evaluation to promote links to instance variables.
/**
* Returns an array of the Links that have this Turtle as one of the end points
* @returns {Array} An AgentList Array of my Links
*/
get links() {
// lazy promote links from getter to instance prop.
Object.defineProperty(this, 'links', {
value: new AgentList(this.model),
enumerable: true,
})
return this.links
}
/**
* Return the patch this Turtle is on. Return null if Turtle off-world.
*/
get patch() {
return this.model.patches.patch(this.x, this.y)
}
/**
* Return this Turtle's heading
*/
get heading() {
return this.model.fromRads(this.theta)
}
/**
* Sets this Turtle's heading
*/
set heading(heading) {
this.theta = this.model.toRads(heading)
}
/**
* Computes the difference between the my heading and the given heading,
* the smallest angle by which t could be rotated to produce heading.
*
* @param {Angle} heading The heading I wish to be roated to.
* @returns {Angle}
*/
subtractHeading(heading) {
// // Using rads so will work with any geometry.
// const rads1 = this.model.toRads(this.heading)
// const rads2 = this.model.toRads(heading)
// const diff = util.subtractRadians(rads2, rads1)
// return this.model.fromRads(diff)
return util.subtractHeadings(heading, this.heading)
}
/**
* Set Turtles x, y position. If z given, override default z of 0.
*
* @param {number} x Turtle's x coord, a Float in patch space
* @param {number} y Turtle's Y coord, a Float in patch space
* @param {number|undefined} [z=undefined] Turtle's Z coord if given
*/
setxy(x, y, z = undefined) {
const p0 = this.patch
this.x = x
this.y = y
if (z != null) this.z = z
this.checkXYZ(p0)
}
checkXYZ(p0) {
this.checkEdge()
this.checkPatch(p0)
}
checkEdge() {
const { x, y, z } = this
// if (!(this.model.world.isOnWorld(x, y, z) || this.atEdge === 'OK')) {
if (!this.model.world.isOnWorld(x, y, z) && this.atEdge !== 'OK') {
this.handleEdge(x, y, z)
}
}
checkPatch(p0) {
const p = this.patch
// both can be null
if (p != p0) {
if (p0 && p0.turtles) util.removeArrayItem(p0.turtles, this)
if (p && p.turtles) p.turtles.push(this)
}
}
/**
* Handle turtle x,y,z if turtle off-world.
* Uses the Turtle's atEdge property to determine how to manage the Turtle.
* Defaults to 'wrap', wrapping the x,y,z to the opposite edge.
*
* atEdge can be:
* - 'die'
* - 'wrap'
* - 'bounce'
* - 'clamp'
* - 'random'
* - a function called with the Turtle as it's argument
*
* @param {number} x Turtle's x coord
* @param {number} y Turtle's y coord
* @param {number|undefined} [z=undefined] Turtle's z coord if not undefined
*/
handleEdge(x, y, z = undefined) {
let atEdge = this.atEdge
if (util.isString(atEdge)) {
const { minXcor, maxXcor, minYcor, maxYcor, minZcor, maxZcor } =
this.model.world
if (atEdge === 'wrap') {
this.x = util.wrap(x, minXcor, maxXcor)
this.y = util.wrap(y, minYcor, maxYcor)
if (z != null) this.z = util.wrap(z, minZcor, maxZcor)
} else if (atEdge === 'die') {
this.die()
} else if (atEdge === 'random') {
this.setxy(...this.model.world.randomPoint())
} else if (atEdge === 'clamp' || atEdge === 'bounce') {
this.x = util.clamp(x, minXcor, maxXcor)
this.y = util.clamp(y, minYcor, maxYcor)
if (z != null) this.z = util.clamp(z, minZcor, maxZcor)
if (atEdge === 'bounce') {
if (this.x === minXcor || this.x === maxXcor) {
this.theta = Math.PI - this.theta
} else if (this.y === minYcor || this.y === maxYcor) {
this.theta = -this.theta
} else if (this.z === minZcor || this.z === maxZcor) {
if (this.pitch) {
this.pitch = -this.pitch
} else {
this.z = util.wrap(z, minZcor, maxZcor)
}
}
}
} else {
throw Error(`turtle.handleEdge: bad atEdge: ${atEdge}`)
}
} else {
this.atEdge(this)
}
}
/**
* Place the turtle at the given patch/turtle location
*
* @param {Patch|Turtle} agent A Patch or Turtle who's location is used
*/
moveTo(agent) {
// this.setxy(agent.x, agent.y)
this.setxy(agent.x, agent.y, agent.z)
}
/**
* Move forward, along the Turtle's heading d units in Patch coordinates
*
* @param {number} d The distance to move
*/
forward(d) {
this.setxy(
this.x + d * Math.cos(this.theta),
this.y + d * Math.sin(this.theta)
)
}
/**
* Change Turtle's heading by angle
*
* @param {number} angle The angle to rotate by
*/
rotate(angle) {
angle = this.model.toCCW(angle)
this.heading += angle
}
/**
* Turn Turtle right by angle
*
* @param {number} angle The angle to rotate by
*/
right(angle) {
this.rotate(-angle)
}
/**
* Turn Turtle left by angle
*
* @param {number} angle The angle to rotate by
*/
left(angle) {
this.rotate(angle)
}
/**
* Turn turtle so at to be facing the given Turtle or Patch
*
* @param {Patch|Turtle} agent The agent to face towards
*/
face(agent) {
// this.theta = this.towards(agent)
this.heading = this.towards(agent)
}
/**
* Turn turtle so at to be facing the given x, y patch coordinate
*
* @param {number} x The x coordinate
* @param {number} y The y coordinate
*/
facexy(x, y) {
// this.theta = this.towardsXY(x, y)
this.heading = this.towardsXY(x, y)
}
/**
* Return the patch ahead of this turtle by distance.
* Return undefined if the distance puts the patch off-world
* @param {number} distance The distance ahead
* @returns {Patch|undefined} The patch at the distance ahead of this Turtle
*/
patchAhead(distance) {
return this.patchAtHeadingAndDistance(this.heading, distance)
}
/**
* Return the patch angle to the right and ahead by distance
* Return undefined if the distance puts the patch off-world
* @param {number} angle The angle to the right
* @param {number} distance The distance ahead
* @returns {Patch|undefined} The patch found, or undefined if off-world
*/
patchRightAndAhead(angle, distance) {
// if (this.model.geometry === 'heading') angle = -angle
angle = this.model.toCCW(angle)
return this.patchAtHeadingAndDistance(this.heading - angle, distance)
}
/**
* Return the patch angle to the left and ahead by distance
* Return undefined if the distance puts the patch off-world
* @param {number} angle The angle to the left
* @param {number} distance The distance ahead
* @returns {Patch|undefined} The patch found, or undefined if off-world
*/
patchLeftAndAhead(angle, distance) {
return this.patchRightAndAhead(-angle, distance)
}
/**
* Can I move forward by distance and not be off-world?
* @param {number} distance The distance ahead
* @returns {Boolean} True if moving forward by distance is on-world
*/
canMove(distance) {
return this.patchAhead(distance) != null
}
/**
* Distance from this turtle to x, y
* No off-world test done.
*
* 2.5D: use z too if both z & this.z exist.
* @param {number} x
* @param {number} y
* @param {number|undefined} [z=null]
* @returns {number} distance in patch coordinates.
*/
distanceXY(x, y, z = null) {
const useZ = z != null && this.z != null
return useZ
? util.distance3(this.x, this.y, this.z, x, y, z)
: util.distance(this.x, this.y, x, y)
}
/**
* Return distance from me to the Patch or Turtle
*
* 2.5D: use z too if both agent.z and this.z exist
* @param {Patch|Turtle} agent
* @returns {number} distance in patch coordinates.
*/
distance(agent) {
const { x, y, z } = agent
return this.distanceXY(x, y, z)
}
/**
* A property for the x-increment if the turtle were to take one step
* forward in its current heading.
* @readonly
*/
get dx() {
return Math.cos(this.theta)
}
/**
* A property for the y-increment if the turtle were to take one step
* forward in its current heading.
* @readonly
*/
get dy() {
return Math.sin(this.theta)
}
/**
* Return the heading towards the Patch or Turtle given.
* @param {Patch|Turtle} agent The agent who's angle from this Turtle we use
* @returns {number} The angle towards the agent
*/
towards(agent) {
return this.towardsXY(agent.x, agent.y)
}
/**
* Return the heading towards the given x,y coordinates.
* @param {number} x The x coordinarte
* @param {number} y The y coordinarte
* @returns {number} The angle towards x,y
*/
towardsXY(x, y) {
// return util.radiansTowardXY(this.x, this.y, x, y)
let rads = util.radiansTowardXY(this.x, this.y, x, y)
// rads = this.model.toCCW(rads)
return this.model.fromRads(rads)
}
/**
* The patch at dx, dy from my current position.
* Return undefined if off-world
* @param {number} dx The delta x ahead
* @param {number} dy The delta y ahead
* @returns {Patch|undefined} The patch dx, dy ahead; undefined if off-world
*/
patchAt(dx, dy) {
return this.model.patches.patch(this.x + dx, this.y + dy)
}
/**
* Return the patch at the absolute, not relative heading and distance
* from this turtle. Return undefined if off-world
*
* Use the Left/Right versions for relative heading.
* @param {number} heading The absolute angle from this turtle
* @param {number} distance The distance ahead
* @returns {Patch|undefined} The Patch, or undefined if off-world
*/
patchAtHeadingAndDistance(heading, distance) {
return this.model.patches.patchAtHeadingAndDistance(
this,
heading,
distance
)
}
/**
* Return the other end of this link from me. Link must include me!
*
* See links property for all my links, if any.
* @param {Link} l
* @returns {Turtle} The other turtle making this Link
*/
otherEnd(l) {
return l.end0 === this ? l.end1 : l.end0
}
// Return all turtles linked to me
/**
* Return all turtles linked to me. Basically me.otherEnd of all my links.
* @returns {Array} All the turtles linked to me
*/
linkNeighbors() {
return this.links.map(l => this.otherEnd(l))
}
/**
* Is the given Turtle linked to me?
* @param {Turtle} t
* @returns {Boolean}
*/
isLinkNeighbor(t) {
return t in this.linkNeighbors()
}
}
export default Turtle
</code></pre></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://code.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>