irsim.config.world_param
========================

.. py:module:: irsim.config.world_param

.. autoapi-nested-parse::

   World parameters.

   .. attribute:: time

      time elapse of the simulation

   .. attribute:: control_mode

      'auto' (robot controlled automatically) or 'keyboard' (robot controlled by keyboard)

   .. attribute:: collision_mode

      'stop' (default, all objects stop on collision), 'unobstructed' (no collision check),
      or 'unobstructed_obstacles' (only obstacles pass through each other)

   .. attribute:: step_time

      time of the simulation step, default is 0.1

   .. attribute:: count

      count of the simulation, time = count * step_time



Classes
-------

.. autoapisummary::

   irsim.config.world_param.WorldParam


Functions
---------

.. autoapisummary::

   irsim.config.world_param.bind


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

.. py:class:: WorldParam

   .. py:attribute:: time
      :type:  float
      :value: 0.0



   .. py:attribute:: control_mode
      :type:  str
      :value: 'auto'



   .. py:attribute:: collision_mode
      :type:  str
      :value: 'stop'



   .. py:attribute:: step_time
      :type:  float
      :value: 0.1



   .. py:attribute:: count
      :type:  int
      :value: 0



.. py:function:: bind(instance: WorldParam) -> None

   Bind instance to default index 0 and update current alias.