World.cpp

Go to the documentation of this file.

/*+-------------------------------------------------------------------------+
  |                       MultiVehicle simulator (libmvsim)                 |
  |                                                                         |
  | Copyright (C) 2014  Jose Luis Blanco Claraco (University of Almeria)    |
  | Copyright (C) 2017  Borys Tymchenko (Odessa Polytechnic University)     |
  | Distributed under GNU General Public License version 3                  |
  |   See <http://www.gnu.org/licenses/>                                    |
  +-------------------------------------------------------------------------+ */
#include <mvsim/World.h>

#include <mrpt/utils/utils_defs.h>  // mrpt::format()
#include <mrpt/system/filesystem.h>  // filePathSeparatorsToNative()

#include <iostream>  // for debugging
#include <algorithm>  // count()
#include <stdexcept>
#include <map>

using namespace mvsim;
using namespace std;

// Default ctor: inits empty world.
World::World()
        : m_gravity(9.81),
          m_simul_time(0.0),
          m_simul_timestep(0.010),
          m_b2d_vel_iters(6),
          m_b2d_pos_iters(3),
          m_base_path("."),
          m_box2d_world(NULL)
{
        this->clear_all();
}

// Dtor.
World::~World()
{
        this->clear_all();
        delete m_box2d_world;
        m_box2d_world = NULL;
}

// Resets the entire simulation environment to an empty world.
void World::clear_all(bool acquire_mt_lock)
{
        try
        {
                if (acquire_mt_lock) m_world_cs.lock();

                // Reset params:
                m_simul_time = 0.0;

                // (B2D) World contents:
                // ---------------------------------------------
                delete m_box2d_world;
                m_box2d_world = new b2World(b2Vec2_zero);

                // Define the ground body.
                b2BodyDef groundBodyDef;
                m_b2_ground_body = m_box2d_world->CreateBody(&groundBodyDef);

                // Clear lists of objs:
                // ---------------------------------------------
                for (TListVehicles::iterator it = m_vehicles.begin();
                         it != m_vehicles.end(); ++it)
                        delete it->second;
                m_vehicles.clear();

                for (std::list<WorldElementBase*>::iterator it =
                                 m_world_elements.begin();
                         it != m_world_elements.end(); ++it)
                        delete *it;
                m_world_elements.clear();

                for (TListBlocks::iterator it = m_blocks.begin(); it != m_blocks.end();
                         ++it)
                        delete it->second;
                m_blocks.clear();

                if (acquire_mt_lock) m_world_cs.unlock();
        }
        catch (std::exception&)
        {
                if (acquire_mt_lock) m_world_cs.unlock();
                throw;  // re-throw
        }
}

void World::run_simulation(double dt)
{
        m_timlogger.registerUserMeasure("run_simulation.dt", dt);

        // sanity checks:
        ASSERT_(dt > 0)
        ASSERT_(m_simul_timestep > 0)

        // Run in time steps:
        const double end_time = m_simul_time + dt;
        const double timetol =
                1e-6;  // tolerance for rounding errors summing time steps
        while (m_simul_time < (end_time - timetol))
        {
                // Timestep: always "simul_step" for the sake of repeatibility
                internal_one_timestep(m_simul_timestep);
        }
}

void World::internal_one_timestep(double dt)
{
        m_timer_iteration.Tic();

        TSimulContext context;
        context.b2_world = m_box2d_world;
        context.simul_time = m_simul_time;
        context.dt = dt;

        // 1) Pre-step
        {
                mrpt::utils::CTimeLoggerEntry tle(m_timlogger, "timestep.0.prestep");
                for (TListVehicles::iterator it = m_vehicles.begin();
                         it != m_vehicles.end(); ++it)
                        it->second->simul_pre_timestep(context);

                for (TListVehicles::iterator it = m_vehicles.begin();
                         it != m_vehicles.end(); ++it)
                {
                        VehicleBase::TListSensors& sensors = it->second->getSensors();
                        for (VehicleBase::TListSensors::iterator itSen = sensors.begin();
                                 itSen != sensors.end(); ++itSen)
                        {
                                (*itSen)->simul_pre_timestep(context);
                        }
                }

                for (TListBlocks::iterator it = m_blocks.begin(); it != m_blocks.end();
                         ++it)
                        it->second->simul_pre_timestep(context);

                for (std::list<WorldElementBase*>::iterator it =
                                 m_world_elements.begin();
                         it != m_world_elements.end(); ++it)
                        (*it)->simul_pre_timestep(context);
        }

        // 2) Run dynamics
        {
                mrpt::utils::CTimeLoggerEntry tle(
                        m_timlogger, "timestep.1.dynamics_integrator");

                m_box2d_world->Step(dt, m_b2d_vel_iters, m_b2d_pos_iters);
                m_simul_time += dt;  // Avance time
        }

        // 3) Save dynamical state into vehicles classes
        {
                mrpt::utils::CTimeLoggerEntry tle(
                        m_timlogger, "timestep.3.save_dynstate");

                context.simul_time = m_simul_time;
                for (TListVehicles::iterator it = m_vehicles.begin();
                         it != m_vehicles.end(); ++it)
                {
                        it->second->simul_post_timestep_common(context);
                        it->second->simul_post_timestep(context);
                }
                for (TListBlocks::iterator it = m_blocks.begin(); it != m_blocks.end();
                         ++it)
                {
                        it->second->simul_post_timestep_common(context);
                        it->second->simul_post_timestep(context);
                }
        }

        // 4) Post-step:
        {
                mrpt::utils::CTimeLoggerEntry tle(m_timlogger, "timestep.4.poststep");
                for (TListVehicles::iterator it = m_vehicles.begin();
                         it != m_vehicles.end(); ++it)
                        it->second->simul_post_timestep(context);

                for (TListVehicles::iterator it = m_vehicles.begin();
                         it != m_vehicles.end(); ++it)
                {
                        VehicleBase::TListSensors& sensors = it->second->getSensors();
                        for (VehicleBase::TListSensors::iterator itSen = sensors.begin();
                                 itSen != sensors.end(); ++itSen)
                        {
                                (*itSen)->simul_post_timestep(context);
                        }
                }

                for (TListBlocks::iterator it = m_blocks.begin(); it != m_blocks.end();
                         ++it)
                        it->second->simul_post_timestep(context);

                for (std::list<WorldElementBase*>::iterator it =
                                 m_world_elements.begin();
                         it != m_world_elements.end(); ++it)
                        (*it)->simul_post_timestep(context);
        }

        const double ts = m_timer_iteration.Tac();
        m_timlogger.registerUserMeasure(
                (ts > dt ? "timestep_too_slow_alert" : "timestep"), ts);
}

std::string World::resolvePath(const std::string& s_in) const
{
        std::string ret;
        const std::string s = mrpt::system::trim(s_in);

        // Relative path? It's not if:
        // "X:\*", "/*"
        // -------------------
        bool is_relative = true;
        if (s.size() > 2 && s[1] == ':' && (s[2] == '/' || s[2] == '\\'))
                is_relative = false;
        if (s.size() > 0 && (s[0] == '/' || s[0] == '\\')) is_relative = false;
        if (is_relative)
        {
                ret = m_base_path;
                if (!ret.empty() && ret[ret.size() - 1] != '/' &&
                        ret[ret.size() - 1] != '\\')
                        ret += string("/");
                ret += s;
        }
        else
                ret = s;

        // Expand macros: (TODO)
        // -------------------

        return mrpt::system::filePathSeparatorsToNative(ret);
}

void World::runVisitorOnVehicles(VehicleVisitorBase& v)
{
        for (TListVehicles::iterator it = m_vehicles.begin();
                 it != m_vehicles.end(); ++it)
                v.visit(it->second);
}

void World::runVisitorOnWorldElements(WorldElementVisitorBase& v)
{
        for (std::list<WorldElementBase*>::iterator it = m_world_elements.begin();
                 it != m_world_elements.end(); ++it)
                v.visit(*it);
}