Hummer car robot
================

.. image:: ../../../media/robots/hummer.png
  :align: center
  :width: 600


This is a generic car like robot. It is driven using steering, power
and braking as provided by the :doc:`steer/force actuator
<../actuators/steer_force>`.  This vehicle uses the Blender `vehicle
wrapper
<http://www.blender.org/documentation/blender_python_api_2_59_0/bge.types.html#bge.types.KX_VehicleWrapper>`_
constraint, to give it a realistic behaviour, including the
interaction of the wheels with the ground and suspension.


.. cssclass:: properties morse-section

Configuration parameters for hummer car robot
---------------------------------------------


You can :

- set the mass of the robot using the builder method :py:meth:`morse.builder.morsebuilder.Robot.set_mass()`
- set the friction coefficient of the robot using the builder method :py:meth:`morse.builder.morsebuilder.Robot.set_friction()`


You can set these properties in your scripts with ``<component>.properties(<property1>=..., <property2>=...)``.

- ``NoGravity`` (bool, default: ``False``)
	Indicate if we want to consider the gravity for this                 robot If true, the behaviour is less realistic as the                 simulator will automatically compensate it. This setting                 is useful for non-realistic model flying or submarine                 robot 
- ``GroundRobot`` (bool, default: ``False``)
	Indicate if the robot is a ground robot, i.e.                   basically if it has no way to control its position on the                   Z axis
- ``friction`` (double, default: ``200.0``)
	Wheel's friction to the ground. Determines how fast                  the robot can accelerate from a standstill.  Also                     affects steering wheel's ability to turn the vehicle.                 A value of ``0`` gives very low acceleration. Higher                  values permit a higher acceleration.  


.. cssclass:: services morse-section

Services for Hummer car robot
-----------------------------

- ``get_properties()`` (blocking)
    Returns the properties of a component.
    
    
  - Return value

    a dictionary of the current component's properties  

- ``get_configurations()`` (blocking)
    Returns the configurations of a component (parsed from the properties).
    
    
  - Return value

    a dictionary of the current component's configurations  



.. cssclass:: examples morse-section

Examples
--------


The following examples show how to use this component in a *Builder* script:

.. code-block:: python


    from morse.builder import *
    
    # creates a new instance of the robot
    hummer = Hummer()

    # place your component at the correct location
    hummer.translate(<x>, <y>, <z>)
    hummer.rotate(<rx>, <ry>, <rz>)
    
    # define one or several communication interface, like 'socket'
    hummer.add_interface(<interface>)

    env = Environment('empty')
    

.. cssclass:: files morse-section

Other sources of examples
+++++++++++++++++++++++++

- `Source code <../../_modules/morse/robots/hummer.html>`_
- `Unit-test <../../_modules/base/hummer_testing.html>`_




*(This page has been auto-generated from MORSE module morse.robots.hummer.)*
