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
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
|
<?xml version='1.0' encoding='UTF-8'?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html>
<head>
<title>Scaladoc for sims.dynamics.Body</title>
<meta http-equiv="content-type" content="text/html; charset=UTF-8" />
<script type="text/javascript" src="../../lib/jquery.js"></script>
<style type="text/css">
@import url(../../lib/template.css) screen;
</style>
<script type="text/javascript" src="../../lib/template.js"></script>
</head>
<body class="type">
<p id="owner"><a href="../package.html">sims</a>.<a href="package.html">dynamics</a></p>
<div id="definition">
<img src="../../lib/class_big.png" />
<h1>Body</h1>
</div>
<h4 class="signature">
<span class="kind">class</span>
<span class="symbol">
<span class="name">Body</span><span class="result"> extends AnyRef</span>
</span>
</h4>
<div class="fullcomment" id="comment">
<div class="comment cmt"><p>A two dimensional rigid body is made out of shapes.</p></div>
</div>
<div id="template">
<div id="mbrsel">
<div id="ancestors">
<h3>Inherits</h3>
<ol><li class="in" name="scala.AnyRef">AnyRef</li><li class="in" name="scala.Any">Any</li></ol>
</div>
</div>
<div class="members" id="values">
<h3>Value Members</h3>
<ol><li name="sims.dynamics.Body#I">
<h4 class="signature">
<span class="kind">def</span>
<span class="symbol">
<span class="name">I</span><span class="result">: <span class="extype" name="scala.Double">Double</span></span>
</span>
</h4>
<p class="shortcomment cmt">Returns the moment of inertia for rotations about the COM of this body</p><div class="fullcomment">
<div class="comment cmt"><p>Returns the moment of inertia for rotations about the COM of this body.
It is calculated using the moments of inertia of this body's shapes and the parallel axis theorem.
If the body is fixed, its moment of inertia is infinite (<code>Double.PositiveInfinity</code>).</p></div>
</div>
</li><li name="sims.dynamics.Body#angularVelocity">
<h4 class="signature">
<span class="kind">var</span>
<span class="symbol">
<span class="name">angularVelocity</span><span class="result">: <span class="extype" name="scala.Double">Double</span></span>
</span>
</h4>
<p class="shortcomment cmt">Angular velocity of this body</p><div class="fullcomment">
<div class="comment cmt"><p>Angular velocity of this body.</p></div>
</div>
</li><li name="sims.dynamics.Body#applyForce">
<h4 class="signature">
<span class="kind">def</span>
<span class="symbol">
<span class="name">applyForce</span><span class="params">(<span name="force">force: <a href="../geometry/Vector2D.html" class="extype" name="sims.geometry.Vector2D">Vector2D</a></span>, <span name="point">point: <a href="../geometry/Vector2D.html" class="extype" name="sims.geometry.Vector2D">Vector2D</a></span>)</span><span class="result">: <span class="extype" name="scala.Unit">Unit</span></span>
</span>
</h4>
<p class="shortcomment cmt">Applies a force to a point on this body</p><div class="fullcomment">
<div class="comment cmt"><p>Applies a force to a point on this body. Warning: the point is considered to be contained within this body.</p></div>
<dl class="paramcmts block"><dt class="param">force</dt><dd class="cmt"><p>applied force</p></dd><dt class="param">point</dt><dd class="cmt"><p>position vector of the point (in world coordinates)</p></dd></dl>
</div>
</li><li name="sims.dynamics.Body#applyForce">
<h4 class="signature">
<span class="kind">def</span>
<span class="symbol">
<span class="name">applyForce</span><span class="params">(<span name="force">force: <a href="../geometry/Vector2D.html" class="extype" name="sims.geometry.Vector2D">Vector2D</a></span>)</span><span class="result">: <span class="extype" name="scala.Unit">Unit</span></span>
</span>
</h4>
<p class="shortcomment cmt">Applies a force to the COM of this body</p><div class="fullcomment">
<div class="comment cmt"><p>Applies a force to the COM of this body.</p></div>
<dl class="paramcmts block"><dt class="param">force</dt><dd class="cmt"><p>applied force</p></dd></dl>
</div>
</li><li name="sims.dynamics.Body#applyImpulse">
<h4 class="signature">
<span class="kind">def</span>
<span class="symbol">
<span class="name">applyImpulse</span><span class="params">(<span name="impulse">impulse: <a href="../geometry/Vector2D.html" class="extype" name="sims.geometry.Vector2D">Vector2D</a></span>, <span name="point">point: <a href="../geometry/Vector2D.html" class="extype" name="sims.geometry.Vector2D">Vector2D</a></span>)</span><span class="result">: <span class="extype" name="scala.Unit">Unit</span></span>
</span>
</h4>
<p class="shortcomment cmt">Applies an impulse to a point on this body</p><div class="fullcomment">
<div class="comment cmt"><p>Applies an impulse to a point on this body. Warning: the point is considered to be contained within this body.</p></div>
<dl class="paramcmts block"><dt class="param">impulse</dt><dd class="cmt"><p>applied impulse</p></dd><dt class="param">point</dt><dd class="cmt"><p>position vector of the point (in world coordinates)</p></dd></dl>
</div>
</li><li name="sims.dynamics.Body#applyImpulse">
<h4 class="signature">
<span class="kind">def</span>
<span class="symbol">
<span class="name">applyImpulse</span><span class="params">(<span name="impulse">impulse: <a href="../geometry/Vector2D.html" class="extype" name="sims.geometry.Vector2D">Vector2D</a></span>)</span><span class="result">: <span class="extype" name="scala.Unit">Unit</span></span>
</span>
</h4>
<p class="shortcomment cmt">Applies an impulse to the COM of this body</p><div class="fullcomment">
<div class="comment cmt"><p>Applies an impulse to the COM of this body.</p></div>
<dl class="paramcmts block"><dt class="param">impulse</dt><dd class="cmt"><p>applied impulse</p></dd></dl>
</div>
</li><li name="sims.dynamics.Body#contains">
<h4 class="signature">
<span class="kind">def</span>
<span class="symbol">
<span class="name">contains</span><span class="params">(<span name="point">point: <a href="../geometry/Vector2D.html" class="extype" name="sims.geometry.Vector2D">Vector2D</a></span>)</span><span class="result">: <span class="extype" name="scala.Boolean">Boolean</span></span>
</span>
</h4>
<p class="shortcomment cmt">Checks if the point <code>point</code> is contained in this body</p><div class="fullcomment">
<div class="comment cmt"><p>Checks if the point <code>point</code> is contained in this body.</p></div>
</div>
</li><li name="scala.AnyRef#equals">
<h4 class="signature">
<span class="kind">def</span>
<span class="symbol">
<span class="name">equals</span><span class="params">(<span name="arg0">arg0: <span class="extype" name="scala.Any">Any</span></span>)</span><span class="result">: <span class="extype" name="scala.Boolean">Boolean</span></span>
</span>
</h4>
<p class="shortcomment cmt">This method is used to compare the receiver object (<code>this</code>)
with the argument object (<code>arg0</code>) for equivalence</p><div class="fullcomment">
<div class="comment cmt"><p>This method is used to compare the receiver object (<code>this</code>)
with the argument object (<code>arg0</code>) for equivalence.</p><p><p>
The default implementations of this method is an <a
href="http://en.wikipedia.org/wiki/Equivalence_relation">equivalence
relation</a>:
<ul>
<li>It is reflexive: for any instance <code>x</code> of type <code>Any</code>,
<code>x.equals(x)</code> should return <code>true</code>.</li>
<li>It is symmetric: for any instances <code>x</code> and <code>y</code> of type
<code>Any</code>, <code>x.equals(y)</code> should return <code>true</code> if and only
if <code>y.equals(x)</code> returns <code>true</code>.</li>
<li>It is transitive: for any instances
<code>x</code>, <code>y</code>, and <code>z</code> of type <code>AnyRef</code>
if <code>x.equals(y)</code> returns <code>true</code> and
<code>y.equals(z)</code> returns
<code>true</code>, then <code>x.equals(z)</code> should return <code>true</code>.</li>
</ul>
</p></p><p><p>
If you override this method, you should verify that
your implementation remains an equivalence relation.
Additionally, when overriding this method it is often necessary to
override <code>hashCode</code> to ensure that objects that are
"equal" (<code>o1.equals(o2)</code> returns <code>true</code>)
hash to the same <a href="Int.html"><code>Int</code></a>
(<code>o1.hashCode.equals(o2.hashCode)</code>).
</p></div>
<dl class="paramcmts block"><dt class="param">arg0</dt><dd class="cmt"><p>the object to compare against this object for equality.</p></dd><dt>returns</dt><dd class="cmt"><p><code>true</code> if the receiver object is equivalent to the argument; <code>false</code> otherwise.
</p></p></dd></dl>
<div class="block">
definition classes: AnyRef ⇐ Any
</div>
</div>
</li><li name="sims.dynamics.Body#fixed">
<h4 class="signature">
<span class="kind">def</span>
<span class="symbol">
<span class="name">fixed</span><span class="result">: <span class="extype" name="scala.Boolean">Boolean</span></span>
</span>
</h4>
<p class="shortcomment cmt">Returns whether this body is fixed or not</p><div class="fullcomment">
<div class="comment cmt"><p>Returns whether this body is fixed or not.</p></div>
</div>
</li><li name="sims.dynamics.Body#fixed_=">
<h4 class="signature">
<span class="kind">def</span>
<span class="symbol">
<span class="name">fixed_=</span><span class="params">(<span name="value">value: <span class="extype" name="scala.Boolean">Boolean</span></span>)</span><span class="result">: <span class="extype" name="scala.Unit">Unit</span></span>
</span>
</h4>
<p class="shortcomment cmt">Fixes or frees this body</p><div class="fullcomment">
<div class="comment cmt"><p>Fixes or frees this body. By fixing, linear and angular velocities are set to zero.</p></div>
</div>
</li><li name="sims.dynamics.Body#force">
<h4 class="signature">
<span class="kind">var</span>
<span class="symbol">
<span class="name">force</span><span class="result">: <a href="../geometry/Vector2D.html" class="extype" name="sims.geometry.Vector2D">Vector2D</a></span>
</span>
</h4>
<p class="shortcomment cmt">Resulting force on the COM of this body</p><div class="fullcomment">
<div class="comment cmt"><p>Resulting force on the COM of this body.</p></div>
</div>
</li><li name="scala.AnyRef#hashCode">
<h4 class="signature">
<span class="kind">def</span>
<span class="symbol">
<span class="name">hashCode</span><span class="params">()</span><span class="result">: <span class="extype" name="scala.Int">Int</span></span>
</span>
</h4>
<p class="shortcomment cmt">Returns a hash code value for the object</p><div class="fullcomment">
<div class="comment cmt"><p>Returns a hash code value for the object.</p><p><p>
The default hashing algorithm is platform dependent.</p><p>Note that it is allowed for two objects to have identical hash
codes (<code>o1.hashCode.equals(o2.hashCode)</code>) yet not be
equal (<code>o1.equals(o2)</code> returns <code>false</code>). A
degenerate implementation could always return <code>0</code>.
However, it is required that if two objects are equal
(<code>o1.equals(o2)</code> returns <code>true</code>) that they
have identical hash codes
(<code>o1.hashCode.equals(o2.hashCode)</code>). Therefore, when
overriding this method, be sure to verify that the behavior is
consistent with the <code>equals</code> method.
</p></p><p><p></p></div>
<div class="block">
definition classes: AnyRef ⇐ Any
</div>
</div>
</li><li name="sims.dynamics.Body#linearVelocity">
<h4 class="signature">
<span class="kind">var</span>
<span class="symbol">
<span class="name">linearVelocity</span><span class="result">: <a href="../geometry/Vector2D.html" class="extype" name="sims.geometry.Vector2D">Vector2D</a></span>
</span>
</h4>
<p class="shortcomment cmt">Linear velocity of this body</p><div class="fullcomment">
<div class="comment cmt"><p>Linear velocity of this body.</p></div>
</div>
</li><li name="sims.dynamics.Body#mass">
<h4 class="signature">
<span class="kind">def</span>
<span class="symbol">
<span class="name">mass</span><span class="result">: <span class="extype" name="scala.Double">Double</span></span>
</span>
</h4>
<p class="shortcomment cmt">Returns the mass of this body</p><div class="fullcomment">
<div class="comment cmt"><p>Returns the mass of this body. If the body is free, its mass is the sum of the masses of its shapes.
If the body is fixed, its mass is infinite (<code>Double.PositiveInfinity</code>).</p></div>
</div>
</li><li name="sims.dynamics.Body#monitor">
<h4 class="signature">
<span class="kind">var</span>
<span class="symbol">
<span class="name">monitor</span><span class="result">: <span class="extype" name="scala.Boolean">Boolean</span></span>
</span>
</h4>
<p class="shortcomment cmt">Flag for a world to monitor the properties of this body</p><div class="fullcomment">
<div class="comment cmt"><p>Flag for a world to monitor the properties of this body.</p></div>
</div>
</li><li name="sims.dynamics.Body#pos">
<h4 class="signature">
<span class="kind">def</span>
<span class="symbol">
<span class="name">pos</span><span class="result">: <a href="../geometry/Vector2D.html" class="extype" name="sims.geometry.Vector2D">Vector2D</a></span>
</span>
</h4>
<p class="shortcomment cmt">Returns the position of this body</p><div class="fullcomment">
<div class="comment cmt"><p>Returns the position of this body. The position is equivalent to the center of mass.</p></div>
</div>
</li><li name="sims.dynamics.Body#pos_=">
<h4 class="signature">
<span class="kind">def</span>
<span class="symbol">
<span class="name">pos_=</span><span class="params">(<span name="newPos">newPos: <a href="../geometry/Vector2D.html" class="extype" name="sims.geometry.Vector2D">Vector2D</a></span>)</span><span class="result">: <span class="extype" name="scala.Unit">Unit</span></span>
</span>
</h4>
<p class="shortcomment cmt">Sets the position of this body</p><div class="fullcomment">
<div class="comment cmt"><p>Sets the position of this body. By doing so all its shapes are translated.</p></div>
<dl class="paramcmts block"><dt class="param">newPos</dt><dd class="cmt"><p>new position</p></dd></dl>
</div>
</li><li name="sims.dynamics.Body#rotation">
<h4 class="signature">
<span class="kind">def</span>
<span class="symbol">
<span class="name">rotation</span><span class="result">: <span class="extype" name="scala.Double">Double</span></span>
</span>
</h4>
<p class="shortcomment cmt">Returns the current rotation of this body</p><div class="fullcomment">
<div class="comment cmt"><p>Returns the current rotation of this body.</p></div>
</div>
</li><li name="sims.dynamics.Body#rotation_=">
<h4 class="signature">
<span class="kind">def</span>
<span class="symbol">
<span class="name">rotation_=</span><span class="params">(<span name="newRotation">newRotation: <span class="extype" name="scala.Double">Double</span></span>)</span><span class="result">: <span class="extype" name="scala.Unit">Unit</span></span>
</span>
</h4>
<p class="shortcomment cmt">Sets the rotation of this body</p><div class="fullcomment">
<div class="comment cmt"><p>Sets the rotation of this body. Position and rotation of shapes are modified accordingly.</p></div>
</div>
</li><li name="sims.dynamics.Body#shapes">
<h4 class="signature">
<span class="kind">val</span>
<span class="symbol">
<span class="name">shapes</span><span class="result">: <span class="extype" name="scala.collection.immutable.List">List</span>[<a href="Shape.html" class="extype" name="sims.dynamics.Shape">Shape</a>]</span>
</span>
</h4>
<p class="shortcomment cmt">Shapes that belong to this body</p><div class="fullcomment">
<div class="comment cmt"><p>Shapes that belong to this body.</p></div>
</div>
</li><li name="sims.dynamics.Body#toString">
<h4 class="signature">
<span class="kind">def</span>
<span class="symbol">
<span class="name">toString</span><span class="params">()</span><span class="result">: <span class="extype" name="java.lang.String">String</span></span>
</span>
</h4>
<p class="shortcomment cmt">Returns a string representation of the object</p><div class="fullcomment">
<div class="comment cmt"><p>Returns a string representation of the object.
<p>
The default representation is platform dependent.
</p></div>
</div>
</li><li name="sims.dynamics.Body#torque">
<h4 class="signature">
<span class="kind">var</span>
<span class="symbol">
<span class="name">torque</span><span class="result">: <span class="extype" name="scala.Double">Double</span></span>
</span>
</h4>
<p class="shortcomment cmt">Resulting torque on this body</p><div class="fullcomment">
<div class="comment cmt"><p>Resulting torque on this body.</p></div>
</div>
</li><li name="sims.dynamics.Body#uid">
<h4 class="signature">
<span class="kind">val</span>
<span class="symbol">
<span class="name">uid</span><span class="result">: <span class="extype" name="scala.Int">Int</span></span>
</span>
</h4>
<p class="shortcomment cmt">Unique identification number</p><div class="fullcomment">
<div class="comment cmt"><p>Unique identification number.</p></div>
</div>
</li><li name="sims.dynamics.Body#velocityOfPoint">
<h4 class="signature">
<span class="kind">def</span>
<span class="symbol">
<span class="name">velocityOfPoint</span><span class="params">(<span name="point">point: <a href="../geometry/Vector2D.html" class="extype" name="sims.geometry.Vector2D">Vector2D</a></span>)</span><span class="result">: <a href="../geometry/Vector2D.html" class="extype" name="sims.geometry.Vector2D">Vector2D</a></span>
</span>
</h4>
<p class="shortcomment cmt">Linear velocity of the given point on this body (in world coordinates)</p><div class="fullcomment">
<div class="comment cmt"><p>Linear velocity of the given point on this body (in world coordinates).</p></div>
</div>
</li><li name="sims.dynamics.Body#~">
<h4 class="signature">
<span class="kind">def</span>
<span class="symbol">
<span class="name">~</span><span class="params">(<span name="b">b: <a href="" class="extype" name="sims.dynamics.Body">Body</a></span>)</span><span class="result">: <a href="" class="extype" name="sims.dynamics.Body">Body</a></span>
</span>
</h4>
<p class="shortcomment cmt">Creates a new body containing this body's shapes and the shapes of another body <code>b</code></p><div class="fullcomment">
<div class="comment cmt"><p>Creates a new body containing this body's shapes and the shapes of another body <code>b</code>.</p></div>
<dl class="paramcmts block"><dt class="param">b</dt><dd class="cmt"><p>body with extra shapes</p></dd><dt>returns</dt><dd class="cmt"><p>new body</p></dd></dl>
</div>
</li><li name="sims.dynamics.Body#~">
<h4 class="signature">
<span class="kind">def</span>
<span class="symbol">
<span class="name">~</span><span class="params">(<span name="s">s: <a href="Shape.html" class="extype" name="sims.dynamics.Shape">Shape</a></span>)</span><span class="result">: <a href="" class="extype" name="sims.dynamics.Body">Body</a></span>
</span>
</h4>
<p class="shortcomment cmt">Creates a new body containing this body's shapes and the shape <code>s</code></p><div class="fullcomment">
<div class="comment cmt"><p>Creates a new body containing this body's shapes and the shape <code>s</code>.</p></div>
<dl class="paramcmts block"><dt class="param">s</dt><dd class="cmt"><p>new shape</p></dd><dt>returns</dt><dd class="cmt"><p>new body</p></dd></dl>
</div>
</li></ol>
</div>
<div class="members" id="constructors">
<h3>Instance constructors</h3>
<ol><li name="sims.dynamics.Body#this">
<h4 class="signature">
<span class="kind">new</span>
<span class="symbol">
<span class="name">Body</span><span class="params">(<span name="shps">shps: <a href="Shape.html" class="extype" name="sims.dynamics.Shape">Shape</a>*</span>)</span>
</span>
</h4>
</li><li name="scala.AnyRef#this">
<h4 class="signature">
<span class="kind">new</span>
<span class="symbol">
<span class="name">Body</span><span class="params">()</span>
</span>
</h4>
</li></ol>
</div>
</div>
</body>
</html>
|
