chenlin/Mujoco_WASM
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Remove mj_makeEmptyFileVFS and mj_findFileVFS from MuJoCo API.

Browse Source 
PiperOrigin-RevId: 645393666
Change-Id: Iabe939c88f60b80dce20f84c7ff9a6396717cc84
This commit is contained in:
Kyle Bayes
2024-06-21 08:11:48 -07:00
committed by Copybara-Service
parent 14fe527ea2
commit e66b9a36b2
9 changed files with 32 additions and 117 deletions
Download Patch File Download Diff File Expand all files Collapse all files
doc/APIreference/functions.rst
+2 -20
View File
@@ -1203,7 +1203,7 @@ mj_defaultVFS
.. mujoco-include:: mj_defaultVFS
Initialize VFS to empty (no deallocation).
Initialize an empty VFS, mj_deleteVFS must be called to deallocate the VFS.
.. _mj_addFileVFS:
@@ -1224,15 +1224,6 @@ mj_addBufferVFS
Add file to VFS from buffer, return 0: success, 1: full, 2: repeated name, -1: failed to load.
.. _mj_findFileVFS:
mj_findFileVFS
~~~~~~~~~~~~~~
.. mujoco-include:: mj_findFileVFS
Return file index in VFS, or -1 if not found in VFS.
.. _mj_deleteFileVFS:
mj_deleteFileVFS
@@ -1249,16 +1240,7 @@ mj_deleteVFS
.. mujoco-include:: mj_deleteVFS
Delete all files from VFS.
.. _mj_makeEmptyFileVFS:
mj_makeEmptyFileVFS
~~~~~~~~~~~~~~~~~~~
.. mujoco-include:: mj_makeEmptyFileVFS
deprecated: use mj_copyBufferVFS.
Delete all files from VFS and deallocates VFS internal memory.
.. _Initialization:
doc/changelog.rst
+23 -13
View File
@@ -7,7 +7,17 @@ Upcoming version (not yet released)
General
^^^^^^^
1. Added a new API for :doc:`procedural model manipulation<programming/modeledit>`. Fixes :github:issue:`364`.
.. admonition:: Breaking API changes
:class: attention
1. Removed deprecated ``mj_makeEmptyFileVFS`` and ``mj_findFileVFS`` functions.
**Migration:** Use ``mj_addBufferVFS`` to copy a buffer into a VFS file directly.
2. Calls to ``mj_defaultVFS`` may allocate memory inside VFS, and the corresponding
``mj_deleteVFS`` must be called to deallocate any internal allocated memory.
3. Added a new API for :doc:`procedural model manipulation<programming/modeledit>`. Fixes :github:issue:`364`.
Still missing:
- Detailed documentation.
@@ -17,15 +27,15 @@ General
:align: right
:width: 240px
2. Added support for orthographic cameras. This is available for both fixed cameras and the free camera, using the
4. Added support for orthographic cameras. This is available for both fixed cameras and the free camera, using the
:ref:`camera/orthographic<body-camera-orthographic>` and :ref:`global/orthographic<visual-global-orthographic>`
attributes, respectively.
3. Added :ref:`maxhullvert<asset-mesh-maxhullvert>`, the maximum number of vertices in a mesh's convex hull.
4. Added :ref:`mj_setKeyframe` for saving the current state into a model keyframe.
5. Added support for ``ball`` joints in the URDF parser ("spherical" in URDF).
6. Deprecated :ref:`mju_rotVecMat` and :ref:`mju_rotVecMatT` in favor of :ref:`mju_mulMatVec3` and
5. Added :ref:`maxhullvert<asset-mesh-maxhullvert>`, the maximum number of vertices in a mesh's convex hull.
6. Added :ref:`mj_setKeyframe` for saving the current state into a model keyframe.
7. Added support for ``ball`` joints in the URDF parser ("spherical" in URDF).
8. Deprecated :ref:`mju_rotVecMat` and :ref:`mju_rotVecMatT` in favor of :ref:`mju_mulMatVec3` and
:ref:`mju_mulMatTVec3`. These functions names and argument ordering are more consistent with the rest of the API.
7. Replaced ``mjUSEDOUBLE`` which was previously hard-coded in
9. Replaced ``mjUSEDOUBLE`` which was previously hard-coded in
`mjtnum.h <https://github.com/google-deepmind/mujoco/blob/main/include/mujoco/mjtnum.h>`__
with the build-time flag ``mjUSESINGLE``. If this symbol is not defined, MuJoCo will use double-precision floating
point, as usual. If ``mjUSESINGLE`` is defined, MuJoCo will use single-precision floating point. See :ref:`mjtNum`.
@@ -34,9 +44,9 @@ General
MJX
~~~
8. Added support for :ref:`elliptic friction cones<option-cone>`.
9. Fixed a bug that resulted in less-optimal linesearch solutions for some difficult constraint settings.
10. Fixed a bug in the Newton solver that sometimes resulted in less-optimal gradients.
10. Added support for :ref:`elliptic friction cones<option-cone>`.
11. Fixed a bug that resulted in less-optimal linesearch solutions for some difficult constraint settings.
12. Fixed a bug in the Newton solver that sometimes resulted in less-optimal gradients.
.. youtube:: P83tKA1iz2Y
@@ -45,14 +55,14 @@ MJX
Simulate
^^^^^^^^
11. Added improved tutorial video.
12. Improved the Brownian noise generator.
13. Added improved tutorial video.
14. Improved the Brownian noise generator.
|br| |br| |br| |br|
Python bindings
^^^^^^^^^^^^^^^
13. Fixed a memory leak when using ``copy.deepcopy()`` on a ``mujoco.MjData`` instance (:github:issue:`1572`).
15. Fixed a memory leak when using ``copy.deepcopy()`` on a ``mujoco.MjData`` instance (:github:issue:`1572`).
Version 3.1.6 (Jun 3, 2024)
---------------------------
doc/includes/references.h
-2
View File
@@ -3068,10 +3068,8 @@ typedef struct mjvSceneState_ mjvSceneState;
void mj_defaultVFS(mjVFS* vfs);
int mj_addFileVFS(mjVFS* vfs, const char* directory, const char* filename);
int mj_addBufferVFS(mjVFS* vfs, const char* name, const void* buffer, int nbuffer);
int mj_findFileVFS(const mjVFS* vfs, const char* filename);
int mj_deleteFileVFS(mjVFS* vfs, const char* filename);
void mj_deleteVFS(mjVFS* vfs);
int mj_makeEmptyFileVFS(mjVFS* vfs, const char* filename, int filesize);
mjModel* mj_loadXML(const char* filename, const mjVFS* vfs, char* error, int error_sz);
mjSpec* mj_parseXML(const char* filename, const mjVFS* vfs, char* error, int error_sz);
mjSpec* mj_parseXMLString(const char* xml, const mjVFS* vfs, char* error, int error_sz);