Skip to content

Commit 341bcdf

Browse files
committed
updated regularApi.xml and propertiesReference.htm mainly
1 parent d3b208a commit 341bcdf

8 files changed

+121
-34
lines changed

en/apiConstants.htm

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -119,10 +119,12 @@ <h1>regular API constants</h1>
119119
<div class=tab>scene was switched (react to this message in a similar way as you would react to a full scene content change)</div>
120120
<div class=tab>auxData[0]: do not use</div>
121121
<div class=tab>auxData[1]=current scene unique ID</div>
122+
<div class=tab>auxData[2]=previous scene unique ID</div>
122123
<div>sim_message_eventcallback_instanceabouttoswitch</div>
123124
<div class=tab>we are about to switch to a different scene</div>
124125
<div class=tab>auxData[0]: do not use</div>
125126
<div class=tab>auxData[1]=next scene unique ID</div>
127+
<div class=tab>auxData[2]=current scene unique ID</div>
126128

127129
<div>sim_message_eventcallback_scriptstateabouttobedestroyed</div>
128130
<div class=tab>The specified script state is about to be destroyed</div>

en/designingDynamicSimulations.htm

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -56,8 +56,9 @@ <h2>
5656
<p class=imageLabel>[Static/non-static, respondable/non-respondable shape behaviors and interactions]</p>
5757
<br>
5858

59-
<p>Two respondable shapes will always produce a collision reaction, unless their respective collision masks don't overlap. Static/non-static, respondable/non-respondable shape properties, as well as collision masks can be set in the <a href="shapeDynamicsProperties.htm">shape dynamics dialog</a>.<br>
60-
</p>
59+
<p>Two respondable shapes will always produce a collision reaction, unless their respective collision masks don't overlap. Static/non-static, respondable/non-respondable shape properties, as well as collision masks can be set in the <a href="shapeDynamicsProperties.htm">shape dynamics dialog</a>.</p>
60+
61+
<p>Note: in MuJoCo, static shapes (<em>mocap</em> bodies) do not transmit friction forces. For that reason will static shapes in MuJoCo always be represented as a <em>mocap</em> body linked to a non-static free body via a <em>weld</em> constraint (unless the static shape's <a href="propertiesReference.htm#kinematic">kinematic</a> property is set to false).</p>
6162

6263
<br>
6364

@@ -95,6 +96,7 @@ <h2>
9596
<p class=imageLabel>[Dynamic overlap constraint, that rigidly binds two shapes]</p>
9697
<br>
9798

99+
<p>Note: in MuJoCo, loop closures are handled via <em>weld</em> constraints that can appear soft or wobbly, depending on the setup. Stiffness/rigidity of the related <em>weld</em> constraint can be adjusted via the <a href="propertiesReference.htm#mujoco.overlapConstrSolref">mujoco.overlapConstrSolref</a>, <a href="propertiesReference.htm#mujoco.overlapConstrSolimp">mujoco.overlapConstrSolimp</a> and <a href="propertiesReference.htm#mujoco.overlapConstrTorquescale">mujoco.overlapConstrTorquescale</a> dummy properties (the average values are taken between both dummy properties).</p>
98100

99101
<h2>
100102
<a name="rigidCompounds"></a>Rigid compounds

en/propertiesReference.htm

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -173,6 +173,9 @@ <h2><a name="scene"></a>Scene properties <span style="font-size: 60%;">(target i
173173
<dt><div class="mujoco.kinematicBodiesInertia"><a name="mujoco.kinematicBodiesInertia"></a><strong>mujoco.kinematicBodiesInertia</strong> (double):</div></dt><dd>Refer to engine's documentation</dd>
174174
<dt><div class="mujoco.kinematicBodiesMass"><a name="mujoco.kinematicBodiesMass"></a><strong>mujoco.kinematicBodiesMass</strong> (double):</div></dt><dd>Refer to engine's documentation</dd>
175175
<dt><div class="mujoco.kinematicBodiesOverrideFlags"><a name="mujoco.kinematicBodiesOverrideFlags"></a><strong>mujoco.kinematicBodiesOverrideFlags</strong> (int):</div></dt><dd>Refer to engine's documentation</dd>
176+
<dt><div class="mujoco.kinematicWeldSolimp"><a name="mujoco.kinematicWeldSolimp"></a><strong>mujoco.kinematicWeldSolimp</strong> (double[]):</div></dt><dd>Refer to engine's documentation</dd>
177+
<dt><div class="mujoco.kinematicWeldSolref"><a name="mujoco.kinematicWeldSolref"></a><strong>mujoco.kinematicWeldSolref</strong> (double[]):</div></dt><dd>Refer to engine's documentation</dd>
178+
<dt><div class="mujoco.kinematicWeldTorquescale"><a name="mujoco.kinematicWeldTorquescale"></a><strong>mujoco.kinematicWeldTorquescale</strong> (double):</div></dt><dd>Refer to engine's documentation</dd>
176179
<dt><div class="mujoco.limitEnable"><a name="mujoco.limitEnable"></a><strong>mujoco.limitEnable</strong> (bool):</div></dt><dd>Refer to engine's documentation</dd>
177180
<dt><div class="mujoco.ls_iterations"><a name="mujoco.ls_iterations"></a><strong>mujoco.ls_iterations</strong> (int):</div></dt><dd>Refer to engine's documentation</dd>
178181
<dt><div class="mujoco.ls_tolerance"><a name="mujoco.ls_tolerance"></a><strong>mujoco.ls_tolerance</strong> (double):</div></dt><dd>Refer to engine's documentation</dd>
@@ -323,6 +326,10 @@ <h2><a name="object"></a>Scene object common properties <span style="font-size:
323326
<h2><a name="shape"></a>Shape properties <span style="font-size: 60%;">(target is a shape)</span></h2>
324327
<div class="constList">
325328
<dl class="grid-list">
329+
<dt><div class="applyColor.diffuse"><a name="applyColor.diffuse"></a><strong>applyColor.diffuse</strong> (color (float[3]), not readable):</div></dt><dd>Applies the diffuse color component to all contained meshes</dd>
330+
<dt><div class="applyColor.emission"><a name="applyColor.emission"></a><strong>applyColor.emission</strong> (color (float[3]), not readable):</div></dt><dd>Applies the emission color component to all contained meshes</dd>
331+
<dt><div class="applyColor.specular"><a name="applyColor.specular"></a><strong>applyColor.specular</strong> (color (float[3]), not readable):</div></dt><dd>Applies the specular color component to all contained meshes</dd>
332+
<dt><div class="applyColor.transparency"><a name="applyColor.transparency"></a><strong>applyColor.transparency</strong> (double, not readable):</div></dt><dd>Applies transparency to all contained meshes</dd>
326333
<dt><div class="applyCulling"><a name="applyCulling"></a><strong>applyCulling</strong> (bool, not readable):</div></dt><dd>Enables/disables culling for all contained meshes</dd>
327334
<dt><div class="applyShadingAngle"><a name="applyShadingAngle"></a><strong>applyShadingAngle</strong> (double, not readable):</div></dt><dd>Applies a shading angle to all contained meshes</dd>
328335
<dt><div class="applyShowEdges"><a name="applyShowEdges"></a><strong>applyShowEdges</strong> (bool, not readable):</div></dt><dd>Enables/disables edges for all contained meshes</dd>
@@ -338,6 +345,7 @@ <h2><a name="shape"></a>Shape properties <span style="font-size: 60%;">(target i
338345
<dt><div class="bullet.restitution"><a name="bullet.restitution"></a><strong>bullet.restitution</strong> (double):</div></dt><dd>Refer to engine's documentation</dd>
339346
<dt><div class="bullet.stickyContact"><a name="bullet.stickyContact"></a><strong>bullet.stickyContact</strong> (bool):</div></dt><dd>Refer to engine's documentation</dd>
340347
<dt><div class="centerOfMass"><a name="centerOfMass"></a><strong>centerOfMass</strong> (vector[3]):</div></dt><dd>Center of mass, relative to the shape's reference frame</dd>
348+
<dt><div class="compound"><a name="compound"></a><strong>compound</strong> (bool, not writable):</div></dt><dd>Whether the shape is a compound</dd>
341349
<dt><div class="convex"><a name="convex"></a><strong>convex</strong> (bool, not writable):</div></dt><dd>Whether the shape's components are all convex or not</dd>
342350
<dt><div class="dynAngularVelocity"><a name="dynAngularVelocity"></a><strong>dynAngularVelocity</strong> (vector[3], not writable):</div></dt><dd>Rotational velocity, as transmitted by the physics engine</dd>
343351
<dt><div class="dynLinearVelocity"><a name="dynLinearVelocity"></a><strong>dynLinearVelocity</strong> (vector[3], not writable):</div></dt><dd>Linear velocity, as transmitted by the physics engine</dd>
@@ -378,6 +386,7 @@ <h2><a name="shape"></a>Shape properties <span style="font-size: 60%;">(target i
378386
<dt><div class="ode.softCfm"><a name="ode.softCfm"></a><strong>ode.softCfm</strong> (double):</div></dt><dd>Refer to engine's documentation</dd>
379387
<dt><div class="ode.softErp"><a name="ode.softErp"></a><strong>ode.softErp</strong> (double):</div></dt><dd>Refer to engine's documentation</dd>
380388
<dt><div class="pmiQuaternion"><a name="pmiQuaternion"></a><strong>pmiQuaternion</strong> (<a href="positionOrientationTransformation.htm#quaternion">quaternion</a>, not writable):</div></dt><dd>Quaternion of the principal moment of inertia, relative to the shape's reference frame</dd>
389+
<dt><div class="primitive"><a name="primitive"></a><strong>primitive</strong> (bool, not writable):</div></dt><dd>Whether the shape's components are all primitives</dd>
381390
<dt><div class="principalMomentOfInertia"><a name="principalMomentOfInertia"></a><strong>principalMomentOfInertia</strong> (double[], not writable):</div></dt><dd>Principal moment of inertia, relative to pmiQuaternion</dd>
382391
<dt><div class="respondable"><a name="respondable"></a><strong>respondable</strong> (bool):</div></dt><dd>Shape will transmit a collision force</dd>
383392
<dt><div class="respondableMask"><a name="respondableMask"></a><strong>respondableMask</strong> (int):</div></dt><dd>Respondable mask</dd>
@@ -568,6 +577,9 @@ <h2><a name="dummy"></a>Dummy properties <span style="font-size: 60%;">(target i
568577
<dt><div class="mujoco.limitsSolimp"><a name="mujoco.limitsSolimp"></a><strong>mujoco.limitsSolimp</strong> (double[]):</div></dt><dd>Refer to engine's documentation</dd>
569578
<dt><div class="mujoco.limitsSolref"><a name="mujoco.limitsSolref"></a><strong>mujoco.limitsSolref</strong> (double[]):</div></dt><dd>Refer to engine's documentation</dd>
570579
<dt><div class="mujoco.margin"><a name="mujoco.margin"></a><strong>mujoco.margin</strong> (double):</div></dt><dd>Refer to engine's documentation</dd>
580+
<dt><div class="mujoco.overlapConstrSolimp"><a name="mujoco.overlapConstrSolimp"></a><strong>mujoco.overlapConstrSolimp</strong> (double[]):</div></dt><dd>Refer to engine's documentation</dd>
581+
<dt><div class="mujoco.overlapConstrSolref"><a name="mujoco.overlapConstrSolref"></a><strong>mujoco.overlapConstrSolref</strong> (double[]):</div></dt><dd>Refer to engine's documentation</dd>
582+
<dt><div class="mujoco.overlapConstrTorquescale"><a name="mujoco.overlapConstrTorquescale"></a><strong>mujoco.overlapConstrTorquescale</strong> (double):</div></dt><dd>Refer to engine's documentation</dd>
571583
<dt><div class="mujoco.springDamping"><a name="mujoco.springDamping"></a><strong>mujoco.springDamping</strong> (double):</div></dt><dd>Refer to engine's documentation</dd>
572584
<dt><div class="mujoco.springLength"><a name="mujoco.springLength"></a><strong>mujoco.springLength</strong> (double):</div></dt><dd>Refer to engine's documentation</dd>
573585
<dt><div class="mujoco.springStiffness"><a name="mujoco.springStiffness"></a><strong>mujoco.springStiffness</strong> (double):</div></dt><dd>Refer to engine's documentation</dd>

en/simMujoco.htm

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@
3030
<a href="?#simMujoco.composite">simMujoco.composite</a>
3131
<a href="?#simMujoco.getCompositeInfo">simMujoco.getCompositeInfo</a>
3232
<a href="?#simMujoco.getFlexcompInfo">simMujoco.getFlexcompInfo</a>
33-
<a href="?#simMujoco.geInfo">simMujoco.getInfo</a>
33+
<a href="?#simMujoco.getInfo">simMujoco.getInfo</a>
3434
<a href="?#simMujoco.addInjection">simMujoco.addInjection</a>
3535
<a href="?#simMujoco.removeInjection">simMujoco.removeInjection</a>
3636
</pre></td></tr>
@@ -211,7 +211,7 @@
211211
<tr class="apiTableTr">
212212
<td class="apiTableLeftLParam">Lua arguments</td>
213213
<td class="apiTableRightLParam">
214-
<div><strong>what</strong>: the information type. Currently only 'nameAndIds' is supported</div>
214+
<div><strong>what</strong>: the information type. Currently only 'nameAndIds' and 'bodies' is supported</div>
215215
</td>
216216
</tr>
217217
<tr class="apiTableTr">

0 commit comments

Comments
 (0)