-
Notifications
You must be signed in to change notification settings - Fork 902
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[Unity plugin] Reference the tutorial in the Unity plugin docs #2249
Changes from 2 commits
f54cc58
50bfbc9
f884316
364ab59
394cc61
203e9bc
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -10,6 +10,9 @@ runtime to use the MuJoCo physics engine. Users can import MJCF files and edit | |
relies on Unity for most aspects -- assets, game logic, simulation time -- but uses MuJoCo to determine how objects | ||
move, giving the designer access to MuJoCo's full API. | ||
|
||
An example project using MuJoCo's Unity plugin in a set of introductory tutorials is available at | ||
https://github.com/Balint-H/mj-unity-tutorial. | ||
|
||
.. _UInstallation: | ||
|
||
Installation instructions | ||
|
@@ -145,10 +148,6 @@ effects: | |
material assets for geom RGBA specification. | ||
- It allows the importer to handle :ref:`\<include\> <include>` elements without replicating MuJoCo’s file-system | ||
workflow. | ||
- The current version of MuJoCo generates MJCF files with explicit :ref:`\<inertial\> <body-inertial>` elements, even when | ||
the original model uses geoms for implicit definition of the body inertia. If you plan to change geom properties of | ||
an imported model, remove these auto-generated ``MjInertial`` components manually. We plan to address this in a | ||
future release of MuJoCo. | ||
|
||
In Unity, there is no equivalent to MJCF’s “cascading” :ref:`\<default\> <default>` clauses. Therefore, components in | ||
Unity reflect the corresponding elements’ state after applying all the relevant default classes, and the class structure | ||
|
@@ -177,9 +176,10 @@ Scene recreation maintains continuity of physics and state in the following way: | |
persisted. | ||
4. The MuJoCo state (for the joints that persisted) is set from the cache, and Unity transforms are synchronized. | ||
|
||
Because the MuJoCo library doesn’t (yet) expose an API for scene editing, adding and removing MuJoCo components causes | ||
complete scene recreation. This can be expensive for large models or if it happens frequently. We expect this | ||
performance limitation to be lifted in future versions of MuJoCo. | ||
MuJoCo has functionality for dynamic scene editing (through :ref:`mjSpec`), however, this is not yet | ||
supported in the Unity plugin. Therefore, adding and removing MuJoCo components causes complete scene recreation. This | ||
can be expensive for large models or if it happens frequently. We intend to lift this performance limitation to be in a | ||
future versions of the plugin. | ||
|
||
Global Settings | ||
_______________ | ||
|
@@ -323,6 +323,20 @@ The plug-in allows using arbitrary Unity meshes for MuJoCo collision. At model | |
<http://www.qhull.org/>`__ to create a convex hull of the mesh, and uses that for collisions. Currently the computed | ||
convex hull is not visible in Unity, but we intend to expose it in future versions. | ||
|
||
Height fields | ||
_____________ | ||
|
||
MuJoCo hfields are represented in Unity through terrain gameobjects. This allows the use of the terrain editing tools | ||
available in Unity to generate shapes for collisions with MuJoCo. When selecting hfield type in the Unity geom | ||
component, the right click context menu provides utility to add the corresponding Unity terrain to the scene. The data | ||
from the terrain is dynamically kept in sync with the simulation. | ||
|
||
MuJoCo plugins | ||
______________ | ||
|
||
The current version of the Unity package does not support loading MJCF scenes that use MuJoCo plugins such as | ||
``elasticity``. Adding basic functionality to do this will be part of an upcoming release. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Could you please take a look at the current state? I tried to include an RST link for the engine plugin page and a html link to the repo readme. I also added a warning as promised in #2261. |
||
|
||
Interaction with External Processes | ||
___________________________________ | ||
|
||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
please make this a proper RST link
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There are a couple other places in the original file that uses direct urls, should I swap those as well?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes please!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Better late than never, finally added the RST links.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can you remove the trailing whitespaces in unity.rst? There are 3, I believe
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
My bad, removed.