TerrainEditor.cpp

Go to the documentation of this file.

/*
    This source file is part of Rigs of Rods
    Copyright 2005-2012 Pierre-Michel Ricordel
    Copyright 2007-2012 Thomas Fischer
    Copyright 2013-2020 Petr Ohlidal
 
    For more information, see http://www.rigsofrods.org/
 
    Rigs of Rods is free software: you can redistribute it and/or modify
    it under the terms of the GNU General Public License version 3, as
    published by the Free Software Foundation.
 
    Rigs of Rods is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
    GNU General Public License for more details.
 
    You should have received a copy of the GNU General Public License
    along with Rigs of Rods. If not, see <http://www.gnu.org/licenses/>.
*/
 
#include "TerrainEditor.h"
 
#include "AppContext.h"
#include "Actor.h"
#include "CameraManager.h"
#include "Console.h"
#include "ContentManager.h"
#include "GameContext.h"
#include "GfxScene.h"
#include "InputEngine.h"
#include "OgreImGui.h"
#include "Terrain.h"
#include "TerrainObjectManager.h"
#include "TObjFileFormat.h"
#include "PlatformUtils.h"
 
using namespace RoR;
using namespace Ogre;
 
const TerrainEditorObjectPtr TerrainEditor::TERRAINEDITOROBJECTPTR_NULL; // Dummy value to be returned as const reference.
 
void TerrainEditor::UpdateInputEvents(float dt)
{
    auto& object_list = App::GetGameContext()->GetTerrain()->getObjectManager()->GetEditorObjects();
 
    if (ImGui::IsMouseClicked(2)) // Middle button
    {
        ImVec2 mouse_screen = ImGui::GetIO().MousePos / ImGui::GetIO().DisplaySize;
        Ogre::Ray terrain_editor_mouse_ray = App::GetCameraManager()->GetCamera()->getCameraToViewportRay(mouse_screen.x, mouse_screen.y);
 
        float min_dist = std::numeric_limits<float>::max();
        Vector3 origin = terrain_editor_mouse_ray.getOrigin();
        Vector3 direction = terrain_editor_mouse_ray.getDirection();
        for (int i = 0; i < (int)object_list.size(); i++)
        {
            Real ray_object_distance = direction.crossProduct(object_list[i]->getPosition() - origin).length();
            if (ray_object_distance < min_dist)
            {
                min_dist = ray_object_distance;
                this->SetSelectedObjectByID(i);
            }
        }
    }
    if (m_selected_object_id != -1)
    {
        m_last_object_name = object_list[m_selected_object_id]->name;
    }
    if (App::GetInputEngine()->getEventBoolValueBounce(EV_COMMON_ENTER_OR_EXIT_TRUCK))
    {
        if (m_selected_object_id == -1)
        {
            // Select nearest object
            Vector3 ref_pos = App::GetCameraManager()->GetCurrentBehavior() == CameraManager::CAMERA_BEHAVIOR_FREE 
                              ? App::GetCameraManager()->GetCameraNode()->getPosition()
                              : App::GetGameContext()->GetPlayerCharacter()->getPosition();
            float min_dist = std::numeric_limits<float>::max();
            for (int i = 0; i < (int)object_list.size(); i++)
            {
                float dist = ref_pos.squaredDistance(object_list[i]->getPosition());
                if (dist < min_dist)
                {
                    this->SetSelectedObjectByID(i);
                    min_dist = dist;
                }
            }
        }
        else
        {
            m_selected_object_id = -1;
        }
    }
    else if (App::GetInputEngine()->getEventBoolValueBounce(EV_COMMON_RESPAWN_LAST_TRUCK) &&
            m_last_object_name != "")
    {
        Vector3 pos = App::GetGameContext()->GetPlayerCharacter()->getPosition();
 
        try
        {
            App::GetGameContext()->GetTerrain()->getObjectManager()->LoadTerrainObject(m_last_object_name, pos, Vector3::ZERO, "Console", "");
 
            App::GetConsole()->putMessage(Console::CONSOLE_MSGTYPE_INFO, Console::CONSOLE_SYSTEM_REPLY, _L("Spawned object at position: ") + String("x: ") + TOSTRING(pos.x) + String("z: ") + TOSTRING(pos.z), "world.png");
        }
        catch (std::exception& e)
        {
            App::GetConsole()->putMessage(Console::CONSOLE_MSGTYPE_INFO, Console::CONSOLE_SYSTEM_ERROR, e.what(), "error.png");
        }
    }
    else if (App::GetInputEngine()->getEventBoolValueBounce(EV_COMMON_ENTER_NEXT_TRUCK, 0.25f))
    {
        if (object_list.size() > 0)
        {
            TerrainEditorObjectID_t i = (m_selected_object_id + 1 + (int)object_list.size()) % object_list.size();
            this->SetSelectedObjectByID(i);
        }
    }
    else if (App::GetInputEngine()->getEventBoolValueBounce(EV_COMMON_ENTER_PREVIOUS_TRUCK, 0.25f))
    {
        if (object_list.size() > 0)
        {
            TerrainEditorObjectID_t i = (m_selected_object_id - 1 + (int)object_list.size()) % object_list.size();
            this->SetSelectedObjectByID(i);
        }
    }
    if (App::GetInputEngine()->getEventBoolValueBounce(EV_COMMON_RESCUE_TRUCK))
    {
        std::string axis = _L("ry");
        if (m_rotation_axis == 0)
        {
            axis = _L("ry");
            m_rotation_axis = 1;
        }
        else if (m_rotation_axis == 1)
        {
            axis = _L("rz");
            m_rotation_axis = 2;
        }
        else if (m_rotation_axis == 2)
        {
            axis = _L("rx");
            m_rotation_axis = 0;
        }
        std::string ssmsg = _L("Rotating: ") + axis;
        App::GetConsole()->putMessage(Console::CONSOLE_MSGTYPE_INFO, Console::CONSOLE_SYSTEM_NOTICE, ssmsg, "information.png");
    }
    if (App::GetInputEngine()->isKeyDownValueBounce(OIS::KC_SPACE))
    {
        m_object_tracking = !m_object_tracking;
        std::string ssmsg = m_object_tracking ? _L("Enabled object tracking") : _L("Disabled object tracking");
        App::GetConsole()->putMessage(Console::CONSOLE_MSGTYPE_INFO, Console::CONSOLE_SYSTEM_NOTICE, ssmsg, "information.png");
    }
    if (m_selected_object_id != -1 && App::GetInputEngine()->getEventBoolValueBounce(EV_COMMON_RESET_TRUCK))
    {
        object_list[m_selected_object_id]->setPosition(object_list[m_selected_object_id]->initial_position);
        object_list[m_selected_object_id]->setRotation(object_list[m_selected_object_id]->initial_rotation);
    }
    if (m_selected_object_id != -1 && App::GetCameraManager()->GetCurrentBehavior() != CameraManager::CAMERA_BEHAVIOR_FREE)
    {
        Vector3 translation = Vector3::ZERO;
        float rotation = 0.0f;
 
        if (App::GetInputEngine()->getEventBoolValue(EV_TRUCK_STEER_LEFT))
        {
            rotation += 2.0f;
        }
        else if (App::GetInputEngine()->getEventBoolValue(EV_TRUCK_STEER_RIGHT))
        {
            rotation -= 2.0f;
        }
        if (App::GetInputEngine()->getEventBoolValue(EV_TRUCK_ACCELERATE))
        {
            translation.y += 0.5f;
        }
        else if (App::GetInputEngine()->getEventBoolValue(EV_TRUCK_BRAKE))
        {
            translation.y -= 0.5f;
        }
        if (App::GetInputEngine()->getEventBoolValue(EV_CHARACTER_FORWARD))
        {
            translation.x += 0.5f;
        }
        else if (App::GetInputEngine()->getEventBoolValue(EV_CHARACTER_BACKWARDS))
        {
            translation.x -= 0.5f;
        }
        if (App::GetInputEngine()->getEventBoolValue(EV_CHARACTER_SIDESTEP_RIGHT))
        {
            translation.z += 0.5f;
        }
        else if (App::GetInputEngine()->getEventBoolValue(EV_CHARACTER_SIDESTEP_LEFT))
        {
            translation.z -= 0.5f;
        }
 
        if (translation != Vector3::ZERO || rotation != 0.0f)
        {
            float scale = App::GetInputEngine()->isKeyDown(OIS::KC_LMENU) ? 0.1f : 1.0f;
            scale *= App::GetInputEngine()->isKeyDown(OIS::KC_LSHIFT) ? 3.0f : 1.0f;
            scale *= App::GetInputEngine()->isKeyDown(OIS::KC_LCONTROL) ? 10.0f : 1.0f;
 
            Ogre::Vector3 new_position = object_list[m_selected_object_id]->getPosition();
            new_position += translation * scale * dt;
            object_list[m_selected_object_id]->setPosition(new_position);
 
            Ogre::Vector3 new_rotation = object_list[m_selected_object_id]->getRotation();
            new_rotation[m_rotation_axis] += rotation * scale * dt;
            object_list[m_selected_object_id]->setRotation(new_rotation);
 
            if (m_object_tracking)
            {
                App::GetGameContext()->GetPlayerCharacter()->setPosition(new_position);
            }
        }
        else if (m_object_tracking && App::GetGameContext()->GetPlayerCharacter()->getPosition() != object_list[m_selected_object_id]->getPosition())
        {
            object_list[m_selected_object_id]->setPosition(App::GetGameContext()->GetPlayerCharacter()->getPosition());
        }
        if (App::GetInputEngine()->getEventBoolValue(EV_COMMON_REMOVE_CURRENT_TRUCK))
        {
            App::GetGameContext()->GetTerrain()->getObjectManager()->destroyObject(object_list[m_selected_object_id]->instance_name);
        }
    }
    else
    {
        App::GetGameContext()->GetCharacterFactory()->Update(dt);
    }    
 
    if (App::GetInputEngine()->getEventBoolValueBounce(EV_COMMON_TOGGLE_TERRAIN_EDITOR))
    {
        App::GetGameContext()->PushMessage(MSG_EDI_LEAVE_TERRN_EDITOR_REQUESTED);
    }
}
void TerrainEditor::UpdateInputEvents(float dt) {…}
 
void TerrainEditor::WriteSeparateOutputFile()
{
    // FIXME: This code was originally removed in favor of `TObjFileFormat::WriteToStream()`
    //  but later brought back due to bugs - there is duplication.
    // ====================================================================================
 
 
    const char* filename = "editor_out.log";
    std::string editor_logpath = PathCombine(App::sys_logs_dir->getStr(), filename);
    try
    {
        Ogre::DataStreamPtr stream
            = Ogre::ResourceGroupManager::getSingleton().createResource(
                editor_logpath, RGN_CONFIG, /*overwrite=*/true);
 
        for (auto object : App::GetGameContext()->GetTerrain()->getObjectManager()->GetEditorObjects())
        {
            SceneNode* sn = object->static_object_node;
            if (sn != nullptr)
            {
                String pos = StringUtil::format("%8.3f, %8.3f, %8.3f", object->position.x, object->position.y, object->position.z);
                String rot = StringUtil::format("% 6.1f, % 6.1f, % 6.1f", object->rotation.x, object->rotation.y, object->rotation.z);
 
                String line = pos + ", " + rot + ", " + object->name + "\n";
                stream->write(line.c_str(), line.length());
            }
        }
 
        // Export procedural roads
        int num_roads = App::GetGameContext()->GetTerrain()->getProceduralManager()->getNumObjects();
        for (int i = 0; i < num_roads; i++)
        {
            ProceduralObjectPtr obj = App::GetGameContext()->GetTerrain()->getProceduralManager()->getObject(i);
            int num_points = obj->getNumPoints();
            if (num_points > 0)
            {
                stream->write("\nbegin_procedural_roads\n", 24);
                for (int j = 0; j < num_points; j++)
                {
                    ProceduralPointPtr point = obj->getPoint(j);
                    std::string type_str;
                    switch (point->type)
                    {
                    case RoadType::ROAD_AUTOMATIC: type_str = "auto"; break;
                    case RoadType::ROAD_FLAT: type_str = "flat"; break;
                    case RoadType::ROAD_LEFT: type_str = "left"; break;
                    case RoadType::ROAD_RIGHT: type_str = "right"; break;
                    case RoadType::ROAD_BOTH: type_str = "both"; break;
                    case RoadType::ROAD_BRIDGE: type_str = (point->pillartype == 1) ? "bridge" : "bridge_no_pillars"; break;
                    case RoadType::ROAD_MONORAIL: type_str = (point->pillartype == 2) ? "monorail" : "monorail2"; break;
                    }
 
                    Ogre::Matrix3 point_rot_matrix;
                    point->rotation.ToRotationMatrix(point_rot_matrix);
                    Ogre::Radian yaw, pitch, roll;
                    point_rot_matrix.ToEulerAnglesYXZ(yaw, pitch, roll);
 
                    std::string line = fmt::format(
                        "\t{:13f}, {:13f}, {:13f}, 0, {:13f}, 0, {:13f}, {:13f}, {:13f}, {}\n",
                        point->position.x, point->position.y, point->position.z,
                        yaw.valueDegrees(),
                        point->width, point->bwidth, point->bheight, type_str);
                    stream->write(line.c_str(), line.length());
                }
                stream->write("end_procedural_roads\n", 21);
            }
        }
    }
    catch (std::exception& e)
    {
        RoR::LogFormat("[RoR|MapEditor]"
            "Error saving file '%s' (resource group '%s'), message: '%s'",
            filename, RGN_CONFIG, e.what());
    }
}
void TerrainEditor::WriteSeparateOutputFile() {…}
 
void TerrainEditor::WriteEditsToTobjFiles()
{
    TerrainPtr terrain = App::GetGameContext()->GetTerrain();
 
    // Assert on Debug, minimize harm on Release
    ROR_ASSERT(terrain);
    if (!terrain)
    {
        return;
    }
 
    // If not a project (unzipped), do nothing
    if (terrain->getCacheEntry()->resource_bundle_type != "FileSystem")
    {
        App::GetConsole()->putMessage(Console::CONSOLE_MSGTYPE_TERRN, Console::CONSOLE_SYSTEM_WARNING,
            fmt::format("Cannot export terrain editor changes - terrain is not a project"));
        return;
    }
 
    // Loop over TOBJ files in cache, update editable elements and serialize.
    for (size_t i = 0; i < terrain->getObjectManager()->GetTobjCache().size(); i++)
    {
        // Dump original elements and rebuild them from live data.
        TObjDocumentPtr tobj = terrain->getObjectManager()->GetTobjCache()[i];
        tobj->objects.clear();
        tobj->vehicles.clear();
        for (TerrainEditorObjectPtr& src : terrain->getObjectManager()->GetEditorObjects())
        {
            if (src->tobj_cache_id == i)
            {
                if (src->special_object_type == TObjSpecialObject::NONE)
                {
                    TObjEntry dst;
                    strncpy(dst.odef_name, src->name.c_str(), TObj::STR_LEN);
                    strncpy(dst.instance_name, src->instance_name.c_str(), TObj::STR_LEN);
                    strncpy(dst.type, src->type.c_str(), TObj::STR_LEN);
                    // TBD: reconstruct 'set_default_rendering_distance'.
                    dst.position = src->position;
                    dst.rotation = src->rotation;
                    dst.comments = src->tobj_comments;
 
                    tobj->objects.push_back(dst);
                }
                else
                {
                    TObjVehicle dst;
                    strncpy(dst.name, src->name.c_str(), TObj::STR_LEN);
                    dst.position = src->position;
                    dst.tobj_rotation = src->rotation;
                    dst.type = src->special_object_type;
 
                    tobj->vehicles.push_back(dst);
                }
            }
        }
 
        try
        {
            Ogre::DataStreamPtr stream
                = Ogre::ResourceGroupManager::getSingleton().createResource(
                    tobj->document_name, terrain->getTerrainFileResourceGroup(), /*overwrite=*/true);
            TObj::WriteToStream(tobj, stream);
        }
        catch (...)
        {
            RoR::HandleGenericException(
                fmt::format("Error saving file '{}' to resource group '{}'",
                    tobj->document_name, terrain->getTerrainFileResourceGroup()), HANDLEGENERICEXCEPTION_CONSOLE);
        }
    }
}
void TerrainEditor::WriteEditsToTobjFiles() {…}
 
void TerrainEditor::ClearSelectedObject()
{
    this->SetSelectedObjectByID(TERRAINEDITOROBJECTID_INVALID);
}
void TerrainEditor::ClearSelectedObject() {…}
 
void TerrainEditor::SetSelectedObjectByID(TerrainEditorObjectID_t id)
{
    // Do nothing if already selected.
    if (id == m_selected_object_id)
    {
        return;
    }
 
    m_selected_object_id = id;
 
    if (id == TERRAINEDITOROBJECTID_INVALID)
    {
        return; // Nothing more to do.
    }
 
    // Notify user
    auto& object_list = App::GetGameContext()->GetTerrain()->getObjectManager()->GetEditorObjects();
    String ssmsg = _L("Selected object: [") + TOSTRING(m_selected_object_id) + "/" + TOSTRING(object_list.size()) + "] (" + object_list[m_selected_object_id]->name + ")";
    App::GetConsole()->putMessage(Console::CONSOLE_MSGTYPE_INFO, Console::CONSOLE_SYSTEM_NOTICE, ssmsg, "information.png");
    if (m_object_tracking)
    {
        App::GetGameContext()->GetPlayerCharacter()->setPosition(object_list[m_selected_object_id]->getPosition());
    }
 
    // If setting special object, make sure the actor instance exists, otherwise spawn it again.
    const TerrainEditorObjectPtr object = this->FetchSelectedObject();
    ROR_ASSERT(object != TERRAINEDITOROBJECTPTR_NULL);
    if (object != TERRAINEDITOROBJECTPTR_NULL && object->special_object_type != TObjSpecialObject::NONE)
    {
        App::GetGameContext()->GetTerrain()->getObjectManager()->SpawnSinglePredefinedActor(object);
    }
}
void TerrainEditor::SetSelectedObjectByID(TerrainEditorObjectID_t id) {…}
 
TerrainEditorObjectID_t TerrainEditor::GetSelectedObjectID() const
{ 
    return m_selected_object_id; 
}
TerrainEditorObjectID_t TerrainEditor::GetSelectedObjectID() const {…}
 
const TerrainEditorObjectPtr& TerrainEditor::FetchSelectedObject()
{
    if (m_selected_object_id == TERRAINEDITOROBJECTID_INVALID)
    {
        return TERRAINEDITOROBJECTPTR_NULL;
    }
 
    auto& object_list = App::GetGameContext()->GetTerrain()->getObjectManager()->GetEditorObjects();
    ROR_ASSERT(m_selected_object_id < (int)object_list.size());
    if (m_selected_object_id >= (int)object_list.size())
    {
        LOG(fmt::format("[RoR|TerrainEditor] INTERNAL ERROR - `m_selected_object_id` '{}' >= `(int)object_list.size()` '{}'",
            m_selected_object_id, (int)object_list.size()));
        return TERRAINEDITOROBJECTPTR_NULL;
    }
 
    return object_list[m_selected_object_id];
}
const TerrainEditorObjectPtr& TerrainEditor::FetchSelectedObject() {…}
 
// -------------------
// TerrainEditorObject
 
Ogre::Vector3 const& TerrainEditorObject::getPosition()
{
    return position;
}
Ogre::Vector3 const& TerrainEditorObject::getPosition() {…}
 
Ogre::Vector3 const& TerrainEditorObject::getRotation()
{
    return rotation;
}
Ogre::Vector3 const& TerrainEditorObject::getRotation() {…}
 
void TerrainEditorObjectRefreshActorVisual(TerrainEditorObjectPtr obj)
{
    ROR_ASSERT(obj->actor_instance_id != ACTORINSTANCEID_INVALID);
    const ActorPtr& actor = App::GetGameContext()->GetActorManager()->GetActorById(obj->actor_instance_id);
    ROR_ASSERT(actor != ActorManager::ACTORPTR_NULL);
    if (actor != ActorManager::ACTORPTR_NULL)
    {
        const bool rot_yxz = App::GetGameContext()->GetTerrain()->getObjectManager()->GetEditorObjectFlagRotYXZ(obj);
 
        ActorModifyRequest* req = new ActorModifyRequest();
        req->amr_type = ActorModifyRequest::Type::SOFT_RESPAWN;
        req->amr_actor = actor->ar_instance_id;
        req->amr_softrespawn_position = obj->position;
        req->amr_softrespawn_rotation = TObjParser::CalcRotation(obj->rotation, rot_yxz);
        App::GetGameContext()->PushMessage(Message(MSG_SIM_MODIFY_ACTOR_REQUESTED, (void*)req));
        req = nullptr;
 
        ActorModifyRequest* fxreq = new ActorModifyRequest();
        fxreq->amr_type = ActorModifyRequest::Type::REFRESH_VISUALS;
        fxreq->amr_actor = actor->ar_instance_id;
        App::GetGameContext()->PushMessage(Message(MSG_SIM_MODIFY_ACTOR_REQUESTED, (void*)fxreq));
        fxreq = nullptr;
    }
}
void TerrainEditorObjectRefreshActorVisual(TerrainEditorObjectPtr obj) {…}
 
void TerrainEditorObject::setPosition(Ogre::Vector3 const& pos)
{
    position = pos;
    if (static_object_node)
    {
        static_object_node->setPosition(pos);
    }
    else if (special_object_type != TObjSpecialObject::NONE)
    {
        TerrainEditorObjectRefreshActorVisual(this);
    }
}
void TerrainEditorObject::setPosition(Ogre::Vector3 const& pos) {…}
 
void TerrainEditorObject::setRotation(Ogre::Vector3 const& rot)
{
    rotation = rot;
    if (static_object_node)
    {
        static_object_node->setOrientation(Quaternion(Degree(rot.x), Vector3::UNIT_X) * Quaternion(Degree(rot.y), Vector3::UNIT_Y) * Quaternion(Degree(rot.z), Vector3::UNIT_Z));
        static_object_node->pitch(Degree(-90));
    }
    else if (special_object_type != TObjSpecialObject::NONE)
    {
        TerrainEditorObjectRefreshActorVisual(this);
    }
}
void TerrainEditorObject::setRotation(Ogre::Vector3 const& rot) {…}
 
std::string const& TerrainEditorObject::getName()
{
    return name;
}
std::string const& TerrainEditorObject::getName() {…}
 
std::string const& TerrainEditorObject::getInstanceName()
{
    return instance_name;
}
std::string const& TerrainEditorObject::getInstanceName() {…}
 
std::string const& TerrainEditorObject::getType()
{
    return type;
}
std::string const& TerrainEditorObject::getType() {…}
 
TObjSpecialObject TerrainEditorObject::getSpecialObjectType()
{
    return special_object_type;
}
TObjSpecialObject TerrainEditorObject::getSpecialObjectType() {…}
 
void TerrainEditorObject::setSpecialObjectType(TObjSpecialObject type)
{
    special_object_type = type;
}
void TerrainEditorObject::setSpecialObjectType(TObjSpecialObject type) {…}
 
ActorInstanceID_t TerrainEditorObject::getActorInstanceId()
{
    return actor_instance_id;
}
ActorInstanceID_t TerrainEditorObject::getActorInstanceId() {…}
 
void TerrainEditorObject::setActorInstanceId(ActorInstanceID_t instance_id)
{
    actor_instance_id = instance_id;
}
void TerrainEditorObject::setActorInstanceId(ActorInstanceID_t instance_id) {…}