summaryrefslogtreecommitdiff
path: root/doc/sims/dynamics/joints$content.html
blob: 141c3e39009ec95a87a4b08c375b5bfcb4fc1386 (plain) (blame)
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
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html>
        <head><title>All classes and objects in sims.dynamics.joints</title>
        <meta http-equiv="content-type" content="text/html; charset=UTF8"></meta><meta content="scaladoc (version 2.7.5.final)" name="generator"></meta><link href="../../style.css" type="text/css" rel="stylesheet"></link><script type="text/javascript" src="../../script.js"></script>
        </head>
        <body onload="init()"><div class="page-title"><div>Simple Mechanics Simulator (SiMS) API</div></div><p><div>This document is the API specification for SiMS</div></p><table summary="" cellpadding="3" class="member">
        <tr><td class="title" colspan="2">Class Summary</td></tr>
        <tr>
      <td class="modifiers" valign="top"> 
        <code>case class</code>
      </td>
      <td class="signature">
        <em><a href="../../sims/dynamics/joints/DistanceJoint.html" target="_self">DistanceJoint</a></em>
        (<code>val </code><em>node1</em> : <a href="../../sims/dynamics/Body.html" target="_self">Body</a>, <code>val </code><em>anchor1</em> : <a href="../../sims/geometry/Vector2D.html" target="_self">Vector2D</a>, <code>val </code><em>node2</em> : <a href="../../sims/dynamics/Body.html" target="_self">Body</a>, <code>val </code><em>anchor2</em> : <a href="../../sims/geometry/Vector2D.html" target="_self">Vector2D</a>)<code> extends </code><a href="../../sims/dynamics/joints/Joint.html" target="_self">Joint</a><code> with </code><a href="" target="contentFrame" class="scala/Product">scala.Product</a>
        
        <div>DistanceJoints keep their connection points at a constant distance.</div>
      </td>
    </tr>
<tr>
      <td class="modifiers" valign="top"> 
        <code> trait</code>
      </td>
      <td class="signature">
        <em><a href="../../sims/dynamics/joints/ForceJoint.html" target="_self">ForceJoint</a></em>
        <code> extends </code><a href="http://www.scala-lang.org/docu/files/api/scala/AnyRef.html" target="_self">AnyRef</a>
        
        <div>A joint which can apply a force to its anchor bodies, thus adding or removing energy to the system.</div>
      </td>
    </tr>
<tr>
      <td class="modifiers" valign="top"> 
        <code>abstract class</code>
      </td>
      <td class="signature">
        <em><a href="../../sims/dynamics/joints/Joint.html" target="_self">Joint</a></em>
        <code> extends </code><a href="../../sims/dynamics/Constraint.html" target="_self">Constraint</a><code> with </code><a href="http://www.scala-lang.org/docu/files/api/scala/AnyRef.html" target="_self">AnyRef</a>
        
        <div>Joints constrain the movement of two bodies.
 Their implementation was inspired by Erin Catto's box2d.</div>
      </td>
    </tr>
<tr>
      <td class="modifiers" valign="top"> 
        <code>case class</code>
      </td>
      <td class="signature">
        <em><a href="../../sims/dynamics/joints/RevoluteJoint.html" target="_self">RevoluteJoint</a></em>
        (<code>val </code><em>node1</em> : <a href="../../sims/dynamics/Body.html" target="_self">Body</a>, <code>val </code><em>node2</em> : <a href="../../sims/dynamics/Body.html" target="_self">Body</a>, <code>val </code><em>anchor</em> : <a href="../../sims/geometry/Vector2D.html" target="_self">Vector2D</a>)<code> extends </code><a href="../../sims/dynamics/joints/Joint.html" target="_self">Joint</a><code> with </code><a href="" target="contentFrame" class="scala/Product">scala.Product</a>
        
        <div>A revolute joint that connects two bodies at a singe point. Inspired from JBox2D.
 <b>Warning:</b> there are still several bugs with revolute joints, if they are between two free
 bodies and not connected at their respective COMs.</div>
      </td>
    </tr>
<tr>
      <td class="modifiers" valign="top"> 
        <code>case class</code>
      </td>
      <td class="signature">
        <em><a href="../../sims/dynamics/joints/SpringJoint.html" target="_self">SpringJoint</a></em>
        (<code>val </code><em>node1</em> : <a href="../../sims/dynamics/Body.html" target="_self">Body</a>, <code>val </code><em>anchor1</em> : <a href="../../sims/geometry/Vector2D.html" target="_self">Vector2D</a>, <code>val </code><em>node2</em> : <a href="../../sims/dynamics/Body.html" target="_self">Body</a>, <code>val </code><em>anchor2</em> : <a href="../../sims/geometry/Vector2D.html" target="_self">Vector2D</a>, <code>val </code><em>springConstant</em> : <a href="http://www.scala-lang.org/docu/files/api/scala/Double.html" target="_self">Double</a>, <code>val </code><em>initialLength</em> : <a href="http://www.scala-lang.org/docu/files/api/scala/Double.html" target="_self">Double</a>)<code> extends </code><a href="../../sims/dynamics/joints/Joint.html" target="_self">Joint</a><code> with </code><a href="../../sims/dynamics/joints/ForceJoint.html" target="_self">ForceJoint</a><code> with </code><a href="" target="contentFrame" class="scala/Product">scala.Product</a>
        
        <div>A spring obeying Hooke's law.</div>
      </td>
    </tr>        
        </table>
<table summary="" cellpadding="3" class="member">
        <tr><td class="title" colspan="2">Object Summary</td></tr>
        <tr>
      <td class="modifiers" valign="top"> 
        <code> object</code>
      </td>
      <td class="signature">
        <em><a href="../../sims/dynamics/joints/DistanceJoint$object.html" target="_self">DistanceJoint</a></em>
        <code> extends </code>(<a href="../../sims/dynamics/Body.html" target="_self">Body</a>, <a href="../../sims/geometry/Vector2D.html" target="_self">Vector2D</a>, <a href="../../sims/dynamics/Body.html" target="_self">Body</a>, <a href="../../sims/geometry/Vector2D.html" target="_self">Vector2D</a>) =&gt; <a href="../../sims/dynamics/joints/DistanceJoint.html" target="_self">DistanceJoint</a>
        
        
      </td>
    </tr>
<tr>
      <td class="modifiers" valign="top"> 
        <code> object</code>
      </td>
      <td class="signature">
        <em><a href="../../sims/dynamics/joints/RevoluteJoint$object.html" target="_self">RevoluteJoint</a></em>
        <code> extends </code>(<a href="../../sims/dynamics/Body.html" target="_self">Body</a>, <a href="../../sims/dynamics/Body.html" target="_self">Body</a>, <a href="../../sims/geometry/Vector2D.html" target="_self">Vector2D</a>) =&gt; <a href="../../sims/dynamics/joints/RevoluteJoint.html" target="_self">RevoluteJoint</a>
        
        
      </td>
    </tr>
<tr>
      <td class="modifiers" valign="top"> 
        <code> object</code>
      </td>
      <td class="signature">
        <em><a href="../../sims/dynamics/joints/SpringJoint$object.html" target="_self">SpringJoint</a></em>
        <code> extends </code>(<a href="../../sims/dynamics/Body.html" target="_self">Body</a>, <a href="../../sims/geometry/Vector2D.html" target="_self">Vector2D</a>, <a href="../../sims/dynamics/Body.html" target="_self">Body</a>, <a href="../../sims/geometry/Vector2D.html" target="_self">Vector2D</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/Double.html" target="_self">Double</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/Double.html" target="_self">Double</a>) =&gt; <a href="../../sims/dynamics/joints/SpringJoint.html" target="_self">SpringJoint</a>
        
        
      </td>
    </tr>        
        </table></body>
      </html>