:py:mod:`rofunc.simulator.src.terrain_creation`
===============================================

.. py:module:: rofunc.simulator.src.terrain_creation

.. autodoc2-docstring:: rofunc.simulator.src.terrain_creation
   :allowtitles:

Module Contents
---------------

Functions
~~~~~~~~~

.. list-table::
   :class: autosummary longtable
   :align: left

   * - :py:obj:`new_sub_terrain <rofunc.simulator.src.terrain_creation.new_sub_terrain>`
     - .. autodoc2-docstring:: rofunc.simulator.src.terrain_creation.new_sub_terrain
          :summary:

Data
~~~~

.. list-table::
   :class: autosummary longtable
   :align: left

   * - :py:obj:`gym <rofunc.simulator.src.terrain_creation.gym>`
     - .. autodoc2-docstring:: rofunc.simulator.src.terrain_creation.gym
          :summary:
   * - :py:obj:`args <rofunc.simulator.src.terrain_creation.args>`
     - .. autodoc2-docstring:: rofunc.simulator.src.terrain_creation.args
          :summary:
   * - :py:obj:`sim_params <rofunc.simulator.src.terrain_creation.sim_params>`
     - .. autodoc2-docstring:: rofunc.simulator.src.terrain_creation.sim_params
          :summary:
   * - :py:obj:`sim <rofunc.simulator.src.terrain_creation.sim>`
     - .. autodoc2-docstring:: rofunc.simulator.src.terrain_creation.sim
          :summary:
   * - :py:obj:`asset_root <rofunc.simulator.src.terrain_creation.asset_root>`
     - .. autodoc2-docstring:: rofunc.simulator.src.terrain_creation.asset_root
          :summary:
   * - :py:obj:`asset_file <rofunc.simulator.src.terrain_creation.asset_file>`
     - .. autodoc2-docstring:: rofunc.simulator.src.terrain_creation.asset_file
          :summary:
   * - :py:obj:`asset <rofunc.simulator.src.terrain_creation.asset>`
     - .. autodoc2-docstring:: rofunc.simulator.src.terrain_creation.asset
          :summary:
   * - :py:obj:`num_envs <rofunc.simulator.src.terrain_creation.num_envs>`
     - .. autodoc2-docstring:: rofunc.simulator.src.terrain_creation.num_envs
          :summary:
   * - :py:obj:`num_per_row <rofunc.simulator.src.terrain_creation.num_per_row>`
     - .. autodoc2-docstring:: rofunc.simulator.src.terrain_creation.num_per_row
          :summary:
   * - :py:obj:`env_spacing <rofunc.simulator.src.terrain_creation.env_spacing>`
     - .. autodoc2-docstring:: rofunc.simulator.src.terrain_creation.env_spacing
          :summary:
   * - :py:obj:`env_lower <rofunc.simulator.src.terrain_creation.env_lower>`
     - .. autodoc2-docstring:: rofunc.simulator.src.terrain_creation.env_lower
          :summary:
   * - :py:obj:`env_upper <rofunc.simulator.src.terrain_creation.env_upper>`
     - .. autodoc2-docstring:: rofunc.simulator.src.terrain_creation.env_upper
          :summary:
   * - :py:obj:`pose <rofunc.simulator.src.terrain_creation.pose>`
     - .. autodoc2-docstring:: rofunc.simulator.src.terrain_creation.pose
          :summary:
   * - :py:obj:`envs <rofunc.simulator.src.terrain_creation.envs>`
     - .. autodoc2-docstring:: rofunc.simulator.src.terrain_creation.envs
          :summary:
   * - :py:obj:`initial_state <rofunc.simulator.src.terrain_creation.initial_state>`
     - .. autodoc2-docstring:: rofunc.simulator.src.terrain_creation.initial_state
          :summary:
   * - :py:obj:`num_terains <rofunc.simulator.src.terrain_creation.num_terains>`
     - .. autodoc2-docstring:: rofunc.simulator.src.terrain_creation.num_terains
          :summary:
   * - :py:obj:`terrain_width <rofunc.simulator.src.terrain_creation.terrain_width>`
     - .. autodoc2-docstring:: rofunc.simulator.src.terrain_creation.terrain_width
          :summary:
   * - :py:obj:`terrain_length <rofunc.simulator.src.terrain_creation.terrain_length>`
     - .. autodoc2-docstring:: rofunc.simulator.src.terrain_creation.terrain_length
          :summary:
   * - :py:obj:`horizontal_scale <rofunc.simulator.src.terrain_creation.horizontal_scale>`
     - .. autodoc2-docstring:: rofunc.simulator.src.terrain_creation.horizontal_scale
          :summary:
   * - :py:obj:`vertical_scale <rofunc.simulator.src.terrain_creation.vertical_scale>`
     - .. autodoc2-docstring:: rofunc.simulator.src.terrain_creation.vertical_scale
          :summary:
   * - :py:obj:`num_rows <rofunc.simulator.src.terrain_creation.num_rows>`
     - .. autodoc2-docstring:: rofunc.simulator.src.terrain_creation.num_rows
          :summary:
   * - :py:obj:`num_cols <rofunc.simulator.src.terrain_creation.num_cols>`
     - .. autodoc2-docstring:: rofunc.simulator.src.terrain_creation.num_cols
          :summary:
   * - :py:obj:`heightfield <rofunc.simulator.src.terrain_creation.heightfield>`
     - .. autodoc2-docstring:: rofunc.simulator.src.terrain_creation.heightfield
          :summary:
   * - :py:obj:`tm_params <rofunc.simulator.src.terrain_creation.tm_params>`
     - .. autodoc2-docstring:: rofunc.simulator.src.terrain_creation.tm_params
          :summary:
   * - :py:obj:`viewer <rofunc.simulator.src.terrain_creation.viewer>`
     - .. autodoc2-docstring:: rofunc.simulator.src.terrain_creation.viewer
          :summary:
   * - :py:obj:`cam_pos <rofunc.simulator.src.terrain_creation.cam_pos>`
     - .. autodoc2-docstring:: rofunc.simulator.src.terrain_creation.cam_pos
          :summary:
   * - :py:obj:`cam_target <rofunc.simulator.src.terrain_creation.cam_target>`
     - .. autodoc2-docstring:: rofunc.simulator.src.terrain_creation.cam_target
          :summary:

API
~~~

.. py:data:: gym
   :canonical: rofunc.simulator.src.terrain_creation.gym
   :value: None

   .. autodoc2-docstring:: rofunc.simulator.src.terrain_creation.gym

.. py:data:: args
   :canonical: rofunc.simulator.src.terrain_creation.args
   :value: None

   .. autodoc2-docstring:: rofunc.simulator.src.terrain_creation.args

.. py:data:: sim_params
   :canonical: rofunc.simulator.src.terrain_creation.sim_params
   :value: None

   .. autodoc2-docstring:: rofunc.simulator.src.terrain_creation.sim_params

.. py:data:: sim
   :canonical: rofunc.simulator.src.terrain_creation.sim
   :value: None

   .. autodoc2-docstring:: rofunc.simulator.src.terrain_creation.sim

.. py:data:: asset_root
   :canonical: rofunc.simulator.src.terrain_creation.asset_root
   :value: None

   .. autodoc2-docstring:: rofunc.simulator.src.terrain_creation.asset_root

.. py:data:: asset_file
   :canonical: rofunc.simulator.src.terrain_creation.asset_file
   :value: 'simulator/assets/urdf/ball.urdf'

   .. autodoc2-docstring:: rofunc.simulator.src.terrain_creation.asset_file

.. py:data:: asset
   :canonical: rofunc.simulator.src.terrain_creation.asset
   :value: None

   .. autodoc2-docstring:: rofunc.simulator.src.terrain_creation.asset

.. py:data:: num_envs
   :canonical: rofunc.simulator.src.terrain_creation.num_envs
   :value: 800

   .. autodoc2-docstring:: rofunc.simulator.src.terrain_creation.num_envs

.. py:data:: num_per_row
   :canonical: rofunc.simulator.src.terrain_creation.num_per_row
   :value: 80

   .. autodoc2-docstring:: rofunc.simulator.src.terrain_creation.num_per_row

.. py:data:: env_spacing
   :canonical: rofunc.simulator.src.terrain_creation.env_spacing
   :value: 0.56

   .. autodoc2-docstring:: rofunc.simulator.src.terrain_creation.env_spacing

.. py:data:: env_lower
   :canonical: rofunc.simulator.src.terrain_creation.env_lower
   :value: None

   .. autodoc2-docstring:: rofunc.simulator.src.terrain_creation.env_lower

.. py:data:: env_upper
   :canonical: rofunc.simulator.src.terrain_creation.env_upper
   :value: None

   .. autodoc2-docstring:: rofunc.simulator.src.terrain_creation.env_upper

.. py:data:: pose
   :canonical: rofunc.simulator.src.terrain_creation.pose
   :value: None

   .. autodoc2-docstring:: rofunc.simulator.src.terrain_creation.pose

.. py:data:: envs
   :canonical: rofunc.simulator.src.terrain_creation.envs
   :value: []

   .. autodoc2-docstring:: rofunc.simulator.src.terrain_creation.envs

.. py:data:: initial_state
   :canonical: rofunc.simulator.src.terrain_creation.initial_state
   :value: None

   .. autodoc2-docstring:: rofunc.simulator.src.terrain_creation.initial_state

.. py:data:: num_terains
   :canonical: rofunc.simulator.src.terrain_creation.num_terains
   :value: 8

   .. autodoc2-docstring:: rofunc.simulator.src.terrain_creation.num_terains

.. py:data:: terrain_width
   :canonical: rofunc.simulator.src.terrain_creation.terrain_width
   :value: 12.0

   .. autodoc2-docstring:: rofunc.simulator.src.terrain_creation.terrain_width

.. py:data:: terrain_length
   :canonical: rofunc.simulator.src.terrain_creation.terrain_length
   :value: 12.0

   .. autodoc2-docstring:: rofunc.simulator.src.terrain_creation.terrain_length

.. py:data:: horizontal_scale
   :canonical: rofunc.simulator.src.terrain_creation.horizontal_scale
   :value: 0.25

   .. autodoc2-docstring:: rofunc.simulator.src.terrain_creation.horizontal_scale

.. py:data:: vertical_scale
   :canonical: rofunc.simulator.src.terrain_creation.vertical_scale
   :value: 0.005

   .. autodoc2-docstring:: rofunc.simulator.src.terrain_creation.vertical_scale

.. py:data:: num_rows
   :canonical: rofunc.simulator.src.terrain_creation.num_rows
   :value: None

   .. autodoc2-docstring:: rofunc.simulator.src.terrain_creation.num_rows

.. py:data:: num_cols
   :canonical: rofunc.simulator.src.terrain_creation.num_cols
   :value: None

   .. autodoc2-docstring:: rofunc.simulator.src.terrain_creation.num_cols

.. py:data:: heightfield
   :canonical: rofunc.simulator.src.terrain_creation.heightfield
   :value: None

   .. autodoc2-docstring:: rofunc.simulator.src.terrain_creation.heightfield

.. py:function:: new_sub_terrain()
   :canonical: rofunc.simulator.src.terrain_creation.new_sub_terrain

   .. autodoc2-docstring:: rofunc.simulator.src.terrain_creation.new_sub_terrain

.. py:data:: tm_params
   :canonical: rofunc.simulator.src.terrain_creation.tm_params
   :value: None

   .. autodoc2-docstring:: rofunc.simulator.src.terrain_creation.tm_params

.. py:data:: viewer
   :canonical: rofunc.simulator.src.terrain_creation.viewer
   :value: None

   .. autodoc2-docstring:: rofunc.simulator.src.terrain_creation.viewer

.. py:data:: cam_pos
   :canonical: rofunc.simulator.src.terrain_creation.cam_pos
   :value: None

   .. autodoc2-docstring:: rofunc.simulator.src.terrain_creation.cam_pos

.. py:data:: cam_target
   :canonical: rofunc.simulator.src.terrain_creation.cam_target
   :value: None

   .. autodoc2-docstring:: rofunc.simulator.src.terrain_creation.cam_target
