Submarine robot
===============

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


A generic submarine robot. The robot has no mass and its physics is
set to "NoCollision".


.. cssclass:: properties morse-section

Configuration parameters for submarine 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()`

*No configurable parameter.*

.. cssclass:: services morse-section

Services for Submarine robot
----------------------------

*This component does not expose any service.*

.. cssclass:: examples morse-section

Examples
--------


The following example shows how to use this component in a *Builder* script:

.. code-block:: python


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

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

    env = Environment('empty')
    

.. cssclass:: files morse-section

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

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




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