mjlab/docs/source/api/terrains.rst
Upstream Snapshot 32a241c28f
Some checks failed
nightly / Test against latest dependencies (py3.10) (push) Has been cancelled
nightly / Test against latest dependencies (py3.13) (push) Has been cancelled
tests / tests (3.13, locked) (push) Has been cancelled
tests / tests (3.13, unlocked) (push) Has been cancelled
tests / pyright (3.10) (push) Has been cancelled
tests / lint-format (push) Has been cancelled
tests / tests (3.10, locked) (push) Has been cancelled
tests / tests (3.11, locked) (push) Has been cancelled
tests / tests (3.12, locked) (push) Has been cancelled
tests / pyright (3.11) (push) Has been cancelled
tests / pyright (3.12) (push) Has been cancelled
tests / pyright (3.13) (push) Has been cancelled
tests / ty-check (3.10) (push) Has been cancelled
tests / ty-check (3.11) (push) Has been cancelled
tests / ty-check (3.12) (push) Has been cancelled
tests / ty-check (3.13) (push) Has been cancelled
tests / stubs (push) Has been cancelled
tests / smoke-test (push) Has been cancelled
Docker / check_paths (push) Has been cancelled
docs / build (push) Has been cancelled
Docker / build (push) Has been cancelled
Import upstream snapshot c19f713c415a699a79d71cd96aa13c3104a05047
Upstream: https://github.com/michaelgillett/mjlab
Upstream-Commit: c19f713c415a699a79d71cd96aa13c3104a05047
Upstream-Branch: main
2026-08-28 15:42:17 +08:00

168 lines
3.4 KiB
ReStructuredText

mjlab.terrains
==============
.. automodule:: mjlab.terrains
.. rubric:: Classes
.. hlist::
:columns: 3
- :class:`TerrainEntity`
- :class:`TerrainEntityCfg`
- :class:`TerrainGenerator`
- :class:`TerrainGeneratorCfg`
- :class:`SubTerrainCfg`
- :class:`FlatPatchSamplingCfg`
- :class:`HfDiscreteObstaclesTerrainCfg`
- :class:`HfPerlinNoiseTerrainCfg`
- :class:`HfPyramidSlopedTerrainCfg`
- :class:`HfRandomUniformTerrainCfg`
- :class:`HfWaveTerrainCfg`
- :class:`BoxFlatTerrainCfg`
- :class:`BoxInvertedPyramidStairsTerrainCfg`
- :class:`BoxNarrowBeamsTerrainCfg`
- :class:`BoxNestedRingsTerrainCfg`
- :class:`BoxOpenStairsTerrainCfg`
- :class:`BoxPyramidStairsTerrainCfg`
- :class:`BoxRandomGridTerrainCfg`
- :class:`BoxRandomSpreadTerrainCfg`
- :class:`BoxRandomStairsTerrainCfg`
- :class:`BoxSteppingStonesTerrainCfg`
- :class:`BoxTiltedGridTerrainCfg`
Core
----
.. autoclass:: TerrainEntity
:members:
:show-inheritance:
.. autoclass:: TerrainEntityCfg
:members:
:exclude-members: __init__
:undoc-members:
.. autoclass:: TerrainGenerator
:members:
.. autoclass:: TerrainGeneratorCfg
:members:
:exclude-members: __init__
:undoc-members:
.. autoclass:: SubTerrainCfg
:members:
:exclude-members: __init__
:undoc-members:
.. autoclass:: FlatPatchSamplingCfg
:members:
:exclude-members: __init__
:undoc-members:
Heightfield Terrains
--------------------
.. autoclass:: HfDiscreteObstaclesTerrainCfg
:members:
:exclude-members: __init__
:undoc-members:
:show-inheritance:
.. autoclass:: HfPerlinNoiseTerrainCfg
:members:
:exclude-members: __init__
:undoc-members:
:show-inheritance:
.. autoclass:: HfRandomUniformTerrainCfg
:members:
:exclude-members: __init__
:undoc-members:
:show-inheritance:
.. autoclass:: HfPyramidSlopedTerrainCfg
:members:
:exclude-members: __init__
:undoc-members:
:show-inheritance:
.. autoclass:: HfWaveTerrainCfg
:members:
:exclude-members: __init__
:undoc-members:
:show-inheritance:
Primitive (Box) Terrains
------------------------
.. autoclass:: BoxFlatTerrainCfg
:members:
:exclude-members: __init__
:undoc-members:
:show-inheritance:
.. autoclass:: BoxInvertedPyramidStairsTerrainCfg
:members:
:exclude-members: __init__
:undoc-members:
:show-inheritance:
.. autoclass:: BoxNarrowBeamsTerrainCfg
:members:
:exclude-members: __init__
:undoc-members:
:show-inheritance:
.. autoclass:: BoxNestedRingsTerrainCfg
:members:
:exclude-members: __init__
:undoc-members:
:show-inheritance:
.. autoclass:: BoxOpenStairsTerrainCfg
:members:
:exclude-members: __init__
:undoc-members:
:show-inheritance:
.. autoclass:: BoxPyramidStairsTerrainCfg
:members:
:exclude-members: __init__
:undoc-members:
:show-inheritance:
.. autoclass:: BoxRandomGridTerrainCfg
:members:
:exclude-members: __init__
:undoc-members:
:show-inheritance:
.. autoclass:: BoxRandomSpreadTerrainCfg
:members:
:exclude-members: __init__
:undoc-members:
:show-inheritance:
.. autoclass:: BoxRandomStairsTerrainCfg
:members:
:exclude-members: __init__
:undoc-members:
:show-inheritance:
.. autoclass:: BoxSteppingStonesTerrainCfg
:members:
:exclude-members: __init__
:undoc-members:
:show-inheritance:
.. autoclass:: BoxTiltedGridTerrainCfg
:members:
:exclude-members: __init__
:undoc-members:
:show-inheritance: