Skip to content

Commit 1edb235

Browse files
1 parent 32cd10f commit 1edb235

26 files changed

+4557
-4579
lines changed

doxygen_cxx/classdrake_1_1multibody_1_1meshcat_1_1_joint_sliders-members.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -388,7 +388,7 @@
388388
<tr class="even"><td class="entry"><a class="el" href="classdrake_1_1systems_1_1_system_base.html#ae0773c5cc1799bd669111705a476b052">IsObviouslyNotInputDependent</a>(DependencyTicket dependency_ticket) const</td><td class="entry"><a class="el" href="classdrake_1_1systems_1_1_system_base.html">SystemBase</a></td><td class="entry"><span class="mlabel">protected</span></td></tr>
389389
<tr><td class="entry"><a class="el" href="classdrake_1_1multibody_1_1meshcat_1_1_joint_sliders.html#a9fc78a729b6fdd395e1cb7b6b2db3047">JointSliders</a>(const JointSliders &amp;)=delete</td><td class="entry"><a class="el" href="classdrake_1_1multibody_1_1meshcat_1_1_joint_sliders.html">JointSliders&lt; T &gt;</a></td><td class="entry"></td></tr>
390390
<tr class="even"><td class="entry"><a class="el" href="classdrake_1_1multibody_1_1meshcat_1_1_joint_sliders.html#ab4cae2915765bb20ab1fec015246ab59">JointSliders</a>(JointSliders &amp;&amp;)=delete</td><td class="entry"><a class="el" href="classdrake_1_1multibody_1_1meshcat_1_1_joint_sliders.html">JointSliders&lt; T &gt;</a></td><td class="entry"></td></tr>
391-
<tr><td class="entry"><a class="el" href="classdrake_1_1multibody_1_1meshcat_1_1_joint_sliders.html#a86ebb1951c6fc9e753c7452c13f6dade">JointSliders</a>(std::shared_ptr&lt; geometry::Meshcat &gt; meshcat, const MultibodyPlant&lt; T &gt; *plant, std::optional&lt; Eigen::VectorXd &gt; initial_value={}, std::variant&lt; std::monostate, double, Eigen::VectorXd &gt; lower_limit={}, std::variant&lt; std::monostate, double, Eigen::VectorXd &gt; upper_limit={}, std::variant&lt; std::monostate, double, Eigen::VectorXd &gt; step={}, std::vector&lt; std::string &gt; decrement_keycodes={}, std::vector&lt; std::string &gt; increment_keycodes={})</td><td class="entry"><a class="el" href="classdrake_1_1multibody_1_1meshcat_1_1_joint_sliders.html">JointSliders&lt; T &gt;</a></td><td class="entry"></td></tr>
391+
<tr><td class="entry"><a class="el" href="classdrake_1_1multibody_1_1meshcat_1_1_joint_sliders.html#a8d06bab24040ad6f5b74cea2cfc62817">JointSliders</a>(std::shared_ptr&lt; geometry::Meshcat &gt; meshcat, const MultibodyPlant&lt; T &gt; *plant, const std::optional&lt; Eigen::VectorXd &gt; &amp;initial_value={}, const std::variant&lt; std::monostate, double, Eigen::VectorXd &gt; &amp;lower_limit={}, const std::variant&lt; std::monostate, double, Eigen::VectorXd &gt; &amp;upper_limit={}, const std::variant&lt; std::monostate, double, Eigen::VectorXd &gt; &amp;step={}, std::vector&lt; std::string &gt; decrement_keycodes={}, std::vector&lt; std::string &gt; increment_keycodes={})</td><td class="entry"><a class="el" href="classdrake_1_1multibody_1_1meshcat_1_1_joint_sliders.html">JointSliders&lt; T &gt;</a></td><td class="entry"></td></tr>
392392
<tr class="even"><td class="entry"><a class="el" href="classdrake_1_1systems_1_1_system.html#a66e1d9af27119011a497b78df6907b1a">ke_ticket</a>()</td><td class="entry"><a class="el" href="classdrake_1_1systems_1_1_system.html">System&lt; T &gt;</a></td><td class="entry"><span class="mlabel">static</span></td></tr>
393393
<tr><td class="entry"><a class="el" href="classdrake_1_1systems_1_1_system_base.html#a66e1d9af27119011a497b78df6907b1a">drake::systems::SystemBase::ke_ticket</a>()</td><td class="entry"><a class="el" href="classdrake_1_1systems_1_1_system_base.html">SystemBase</a></td><td class="entry"><span class="mlabel">static</span></td></tr>
394394
<tr class="even"><td class="entry"><a class="el" href="classdrake_1_1systems_1_1_system.html#a1291b5091aa55dbd03c9b5944dbced09">kinematics_ticket</a>()</td><td class="entry"><a class="el" href="classdrake_1_1systems_1_1_system.html">System&lt; T &gt;</a></td><td class="entry"><span class="mlabel">static</span></td></tr>

doxygen_cxx/classdrake_1_1multibody_1_1meshcat_1_1_joint_sliders.html

Lines changed: 12 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -182,7 +182,6 @@
182182
</td></tr>
183183
</table>
184184
<p>The output port is of size <code>plant.num_positions()</code>, and the order of its elements matches <code>plant.GetPositions()</code>.</p>
185-
<p>Only positions associated with joints get sliders. All other positions are fixed at nominal values.</p>
186185
<p>Beware that the output port of this system always provides the sliders' current values, even if evaluated by multiple different downstream input ports during a single computation. If you need to have a synchronized view of the slider data, place a <a class="el" href="classdrake_1_1systems_1_1_zero_order_hold.html" title="A zero order hold block with input u, which may be vector-valued (discrete or continuous) or abstract...">systems::ZeroOrderHold</a> system between the sliders and downstream calculations.</p>
187186
<dl class="tparams"><dt>Template Parameters</dt><dd>
188187
<table class="tparams">
@@ -195,9 +194,9 @@
195194
<table class="memberdecls">
196195
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
197196
Public Member Functions</h2></td></tr>
198-
<tr class="memitem:a86ebb1951c6fc9e753c7452c13f6dade"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdrake_1_1multibody_1_1meshcat_1_1_joint_sliders.html#a86ebb1951c6fc9e753c7452c13f6dade">JointSliders</a> (std::shared_ptr&lt; <a class="el" href="classdrake_1_1geometry_1_1_meshcat.html">geometry::Meshcat</a> &gt; meshcat, const <a class="el" href="classdrake_1_1multibody_1_1_multibody_plant.html">MultibodyPlant</a>&lt; T &gt; *plant, std::optional&lt; Eigen::VectorXd &gt; initial_value={}, std::variant&lt; std::monostate, <a class="el" href="classdouble.html">double</a>, Eigen::VectorXd &gt; lower_limit={}, std::variant&lt; std::monostate, <a class="el" href="classdouble.html">double</a>, Eigen::VectorXd &gt; upper_limit={}, std::variant&lt; std::monostate, <a class="el" href="classdouble.html">double</a>, Eigen::VectorXd &gt; step={}, std::vector&lt; std::string &gt; decrement_keycodes={}, std::vector&lt; std::string &gt; increment_keycodes={})</td></tr>
199-
<tr class="memdesc:a86ebb1951c6fc9e753c7452c13f6dade"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates a meshcat slider for each joint in the given plant. <a href="#a86ebb1951c6fc9e753c7452c13f6dade">More...</a><br /></td></tr>
200-
<tr class="separator:a86ebb1951c6fc9e753c7452c13f6dade"><td class="memSeparator" colspan="2">&#160;</td></tr>
197+
<tr class="memitem:a8d06bab24040ad6f5b74cea2cfc62817"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdrake_1_1multibody_1_1meshcat_1_1_joint_sliders.html#a8d06bab24040ad6f5b74cea2cfc62817">JointSliders</a> (std::shared_ptr&lt; <a class="el" href="classdrake_1_1geometry_1_1_meshcat.html">geometry::Meshcat</a> &gt; meshcat, const <a class="el" href="classdrake_1_1multibody_1_1_multibody_plant.html">MultibodyPlant</a>&lt; T &gt; *plant, const std::optional&lt; Eigen::VectorXd &gt; &amp;initial_value={}, const std::variant&lt; std::monostate, <a class="el" href="classdouble.html">double</a>, Eigen::VectorXd &gt; &amp;lower_limit={}, const std::variant&lt; std::monostate, <a class="el" href="classdouble.html">double</a>, Eigen::VectorXd &gt; &amp;upper_limit={}, const std::variant&lt; std::monostate, <a class="el" href="classdouble.html">double</a>, Eigen::VectorXd &gt; &amp;step={}, std::vector&lt; std::string &gt; decrement_keycodes={}, std::vector&lt; std::string &gt; increment_keycodes={})</td></tr>
198+
<tr class="memdesc:a8d06bab24040ad6f5b74cea2cfc62817"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates a meshcat slider for each joint in the given plant. <a href="#a8d06bab24040ad6f5b74cea2cfc62817">More...</a><br /></td></tr>
199+
<tr class="separator:a8d06bab24040ad6f5b74cea2cfc62817"><td class="memSeparator" colspan="2">&#160;</td></tr>
201200
<tr class="memitem:ac2e5aab0612d67400354a4fe71278a21"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdrake_1_1multibody_1_1meshcat_1_1_joint_sliders.html#ac2e5aab0612d67400354a4fe71278a21">Delete</a> ()</td></tr>
202201
<tr class="memdesc:ac2e5aab0612d67400354a4fe71278a21"><td class="mdescLeft">&#160;</td><td class="mdescRight">Removes our sliders from the associated meshcat instance. <a href="#ac2e5aab0612d67400354a4fe71278a21">More...</a><br /></td></tr>
203202
<tr class="separator:ac2e5aab0612d67400354a4fe71278a21"><td class="memSeparator" colspan="2">&#160;</td></tr>
@@ -208,7 +207,7 @@
208207
<tr class="memdesc:a1039b0af2a065af9a3cd392e774e0c19"><td class="mdescLeft">&#160;</td><td class="mdescRight">Publishes the given Diagram (typically, to cause it to be visualized) whenever our sliders' values change. <a href="#a1039b0af2a065af9a3cd392e774e0c19">More...</a><br /></td></tr>
209208
<tr class="separator:a1039b0af2a065af9a3cd392e774e0c19"><td class="memSeparator" colspan="2">&#160;</td></tr>
210209
<tr class="memitem:abf0ba4dc73d12957c13ae22e2a2ef939"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdrake_1_1multibody_1_1meshcat_1_1_joint_sliders.html#abf0ba4dc73d12957c13ae22e2a2ef939">SetPositions</a> (const Eigen::VectorXd &amp;q)</td></tr>
211-
<tr class="memdesc:abf0ba4dc73d12957c13ae22e2a2ef939"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets all robot positions (corresponding to joint positions and potentially positions not associated with any joint) to the values in <code>q</code>. <a href="#abf0ba4dc73d12957c13ae22e2a2ef939">More...</a><br /></td></tr>
210+
<tr class="memdesc:abf0ba4dc73d12957c13ae22e2a2ef939"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets our meshcat sliders to the values in <code>q</code>. <a href="#abf0ba4dc73d12957c13ae22e2a2ef939">More...</a><br /></td></tr>
212211
<tr class="separator:abf0ba4dc73d12957c13ae22e2a2ef939"><td class="memSeparator" colspan="2">&#160;</td></tr>
213212
<tr><td colspan="2"><div class="groupHeader">Does not allow copy, move, or assignment</div></td></tr>
214213
<tr class="memitem:a9fc78a729b6fdd395e1cb7b6b2db3047"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdrake_1_1multibody_1_1meshcat_1_1_joint_sliders.html#a9fc78a729b6fdd395e1cb7b6b2db3047">JointSliders</a> (const <a class="el" href="classdrake_1_1multibody_1_1meshcat_1_1_joint_sliders.html">JointSliders</a> &amp;)=delete</td></tr>
@@ -1325,8 +1324,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#ab4cae2915765bb20ab1fec01
13251324

13261325
</div>
13271326
</div>
1328-
<a id="a86ebb1951c6fc9e753c7452c13f6dade"></a>
1329-
<h2 class="memtitle"><span class="permalink"><a href="#a86ebb1951c6fc9e753c7452c13f6dade">&#9670;&nbsp;</a></span>JointSliders() <span class="overload">[3/3]</span></h2>
1327+
<a id="a8d06bab24040ad6f5b74cea2cfc62817"></a>
1328+
<h2 class="memtitle"><span class="permalink"><a href="#a8d06bab24040ad6f5b74cea2cfc62817">&#9670;&nbsp;</a></span>JointSliders() <span class="overload">[3/3]</span></h2>
13301329

13311330
<div class="memitem">
13321331
<div class="memproto">
@@ -1346,25 +1345,25 @@ <h2 class="memtitle"><span class="permalink"><a href="#a86ebb1951c6fc9e753c7452c
13461345
<tr>
13471346
<td class="paramkey"></td>
13481347
<td></td>
1349-
<td class="paramtype">std::optional&lt; Eigen::VectorXd &gt;&#160;</td>
1348+
<td class="paramtype">const std::optional&lt; Eigen::VectorXd &gt; &amp;&#160;</td>
13501349
<td class="paramname"><em>initial_value</em> = <code>{}</code>, </td>
13511350
</tr>
13521351
<tr>
13531352
<td class="paramkey"></td>
13541353
<td></td>
1355-
<td class="paramtype">std::variant&lt; std::monostate, <a class="el" href="classdouble.html">double</a>, Eigen::VectorXd &gt;&#160;</td>
1354+
<td class="paramtype">const std::variant&lt; std::monostate, <a class="el" href="classdouble.html">double</a>, Eigen::VectorXd &gt; &amp;&#160;</td>
13561355
<td class="paramname"><em>lower_limit</em> = <code>{}</code>, </td>
13571356
</tr>
13581357
<tr>
13591358
<td class="paramkey"></td>
13601359
<td></td>
1361-
<td class="paramtype">std::variant&lt; std::monostate, <a class="el" href="classdouble.html">double</a>, Eigen::VectorXd &gt;&#160;</td>
1360+
<td class="paramtype">const std::variant&lt; std::monostate, <a class="el" href="classdouble.html">double</a>, Eigen::VectorXd &gt; &amp;&#160;</td>
13621361
<td class="paramname"><em>upper_limit</em> = <code>{}</code>, </td>
13631362
</tr>
13641363
<tr>
13651364
<td class="paramkey"></td>
13661365
<td></td>
1367-
<td class="paramtype">std::variant&lt; std::monostate, <a class="el" href="classdouble.html">double</a>, Eigen::VectorXd &gt;&#160;</td>
1366+
<td class="paramtype">const std::variant&lt; std::monostate, <a class="el" href="classdouble.html">double</a>, Eigen::VectorXd &gt; &amp;&#160;</td>
13681367
<td class="paramname"><em>step</em> = <code>{}</code>, </td>
13691368
</tr>
13701369
<tr>
@@ -1572,8 +1571,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#abf0ba4dc73d12957c13ae22e
15721571
</table>
15731572
</div><div class="memdoc">
15741573

1575-
<p>Sets all robot positions (corresponding to joint positions and potentially positions not associated with any joint) to the values in <code>q</code>. </p>
1576-
<p>The meshcat sliders associated with any joint positions described by <code>q</code> will have their value updated. Additionally, the "initial state" vector of positions tracked by this instance will be updated to the values in <code>q</code>. This "initial state" vector update will persist even if sliders are removed (e.g., via Delete).</p>
1574+
<p>Sets our meshcat sliders to the values in <code>q</code>. </p>
1575+
<p>Additionally, the "initial state" vector of positions tracked by this instance will be updated to the values in <code>q</code>. This "initial state" vector update will persist even if sliders are removed (e.g., via Delete).</p>
15771576
<dl class="params"><dt>Parameters</dt><dd>
15781577
<table class="params">
15791578
<tr><td class="paramname">q</td><td>A vector whose length is equal to the associated <a class="el" href="classdrake_1_1multibody_1_1_multibody_plant.html#aba2887f0ca1fbbdfb49cf6b0ee21e553" title="Returns the size of the generalized position vector q for this model.">MultibodyPlant::num_positions()</a>. </td></tr>

doxygen_cxx/classdrake_1_1multibody_1_1meshcat_1_1_joint_sliders.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ var classdrake_1_1multibody_1_1meshcat_1_1_joint_sliders =
22
[
33
[ "JointSliders", "classdrake_1_1multibody_1_1meshcat_1_1_joint_sliders.html#a9fc78a729b6fdd395e1cb7b6b2db3047", null ],
44
[ "JointSliders", "classdrake_1_1multibody_1_1meshcat_1_1_joint_sliders.html#ab4cae2915765bb20ab1fec015246ab59", null ],
5-
[ "JointSliders", "classdrake_1_1multibody_1_1meshcat_1_1_joint_sliders.html#a86ebb1951c6fc9e753c7452c13f6dade", null ],
5+
[ "JointSliders", "classdrake_1_1multibody_1_1meshcat_1_1_joint_sliders.html#a8d06bab24040ad6f5b74cea2cfc62817", null ],
66
[ "~JointSliders", "classdrake_1_1multibody_1_1meshcat_1_1_joint_sliders.html#a0bef86c00f2afad929304ad1866d1c33", null ],
77
[ "Delete", "classdrake_1_1multibody_1_1meshcat_1_1_joint_sliders.html#ac2e5aab0612d67400354a4fe71278a21", null ],
88
[ "operator=", "classdrake_1_1multibody_1_1meshcat_1_1_joint_sliders.html#ae46167a57acc0c6fa6019e49e6e6f011", null ],

0 commit comments

Comments
 (0)