Environment virtual robot
=========================


This is a special case of component in MORSE. Since all sensors or actuators
must be attached to one robot, it would not normally be possible to use
"stand-alone" sensors in the environment.

If you need to use a sensor in this way, (*i.e.* for motion capture sensors,
or independent cameras) you should add an **environment virtual
robot** to the scene, and make it the parent of your stand-alone
sensors.

This robot has no visual representation, and consists of a single Blender
Empty. Its only purpose is to provide the base to attach sensors. A single
**environment virtual robot** should be the parent of as many
sensors as needed.


.. cssclass:: properties morse-section

Configuration parameters for environment virtual 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 Environment virtual 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
    environment = Environment()

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

    env = Environment('empty')
    

.. cssclass:: files morse-section

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

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




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