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

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

.. autoapi-nested-parse::

   world parameters:
       time: time elapse of the simulation
       control_mode:
           - auto: robot will be controlled automatically
           - keyboard: robot will be controlled by keyboard

       collision_mode:
           - stop (default): All Objects stop when collision,
           - unobstructed: No collision check
           - unobstructed_obstacles: Only allows obstacles to pass through each other without consideration of any collision. The robots will stop when they are in collision with the obstacles.

       step_time: time of the simulation step, default is 0.1
       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.