Defining the simulation world

Simulation happens inside an mvsim::World object. This is the central class for usage from user code, running the simulation, loading XML models, managing GUI visualization, etc. The ROS node acts as a bridge between this class and the ROS subsystem, and the standalone mvsim cli tool is just a thin wrapper loading a world model and running it.

Simulated worlds are described via configuration XML files called “world” files, which describes both, the environment itself and the vehicles or robots that move in it. By means of includes, robots, sensors, or environment objects can be defined in their own files for the sake of reusability.

Note

Many examples can be found in the mvsim_tutorial directory. Look for the *.world.xml files.

Demo “warehouse” world.

The next pages cover the main different parts of a world file, so you can understand the provided examples, modify them, or create your own worlds and robots.

Global settings

First, we have global definitions on the simulation itself, the GUI, and the lights and shadows:

• Top-level and global simulation settings
• GUI and visualization options
• Georeference options
• Light and shadows configuration
  • Light control
  • Shadows control

World contents

Then we have to populate the world. MVSim defines three kinds of objects:

1. Elements (like walls, the ground, etc.) which normally do not move,

2. Blocks: most normally, obstacles, furniture, etc. Any object that may move or not, but which is not a controllable robot/vehicle; and

3. Vehicles: the robots/vehicles/agents themselves.

Both, blocks and vehicles share two common APIs or interfaces: Simulable and VisualObject, hence the properties of such interfaces are explained below in independent pages:

• World elements
• World blocks
• Definition of vehicles
  • Vehicle kinematic and dynamics
  • Common
  • Motion controllers
  • Ackermann-drivetrain model
  • Friction
• Vehicle instances
• Logging
• World XML definition of Simulable entities
  • Related to topic publication
• World XML definition of VisualObject
  • Related to visual aspect

Advanced features

Other key features of MVSim world files are summarized next:

• Including other XML files
  • Limitations
• World XML files parser
  • Variables
  • Special variables
  • Environment variables
  • Output of an external program
  • Mathematical expressions
• Remote resources notation
• World XML files flow control
  • For loops
  • Conditional parsing
• Parameters entries and expected formatting

Simulation execution

Simulation executes step-by-step with user-defined \(\Delta t\) time between steps. Each step comprises:

• Before time step - sets actions, updates models, etc.

• Actual time step - updates dynamics

• After time step - everything needed to be done with updated state

Simulation limitations

• A limitation of box2d is that no element can be thinner than 0.05 units, or the following assert will be raised while loading the world model:

Box2D/Box2D/Collision/Shapes/b2PolygonShape.cpp:158: void b2PolygonShape::Set(const b2Vec2*, int32): Assertion `false' failed.