Tuning: added exhausts removal (_unwanted or UI)

To understand code changes, find previous commit which adds flares to the tuning system - it provides detailed checklist for making such change.

Author: ohlidalp

source/main/ForwardDeclarations.h

@@ -64,6 +64,9 @@ namespace RoR
     typedef int FlareID_t; //!< Index into `Actor::ar_flares`, use `RoR::FLAREID_INVALID` as empty value
     static const FlareID_t FLAREID_INVALID = -1;
 
+    typedef int ExhaustID_t; //!< Index into `Actor::exhausts`, use `RoR::EXHAUSTID_INVALID` as empty value
+    static const ExhaustID_t EXHAUSTID_INVALID = -1;
+
     class  Actor;
     class  ActorManager;
     class  ActorSpawner;

source/main/gui/panels/GUI_TopMenubar.cpp

@@ -1908,6 +1908,37 @@ void TopMenubar::Draw(float dt)
                         ImGui::PopID(); // flareid
                     }
                 }
+
+                // Draw exhausts
+                size_t total_exhausts = tuning_actor->exhausts.size();
+                std::string exhausts_title = fmt::format(_LC("Tuning", "Exhausts ({})"), total_exhausts);
+                if (ImGui::CollapsingHeader(exhausts_title.c_str()))
+                {
+                    // Draw all exhausts (those removed by addonparts are also present as placeholders)
+                    for (ExhaustID_t exhaustid = 0; exhaustid < (int)tuning_actor->exhausts.size(); exhaustid++)
+                    {
+                        ImGui::PushID(exhaustid);
+                        ImGui::AlignTextToFramePadding();
+
+                        this->DrawTuningBoxedSubjectIdInline(exhaustid);
+
+                        this->DrawTuningForceRemoveControls(
+                            exhaustid,
+                            tuning_actor->exhausts[exhaustid].particleSystemName,
+                            tuneup_def && tuneup_def->isExhaustUnwanted(exhaustid),
+                            tuneup_def && tuneup_def->isExhaustForceRemoved(exhaustid),
+                            ModifyProjectRequestType::TUNEUP_FORCEREMOVE_EXHAUST_SET,
+                            ModifyProjectRequestType::TUNEUP_FORCEREMOVE_EXHAUST_RESET);
+
+                        this->DrawTuningProtectedChkRightAligned(
+                            exhaustid,
+                            tuneup_def && tuneup_def->isExhaustProtected(exhaustid),
+                            ModifyProjectRequestType::TUNEUP_PROTECTED_EXHAUST_SET,
+                            ModifyProjectRequestType::TUNEUP_PROTECTED_EXHAUST_RESET);
+
+                        ImGui::PopID(); // exhaustid
+                    }
+                }
             }
 
             m_open_menu_hoverbox_min = menu_pos - MENU_HOVERBOX_PADDING;

source/main/physics/ActorSpawner.cpp

@@ -1282,32 +1282,37 @@ void ActorSpawner::ProcessExhaust(RigDef::Exhaust & def)
         return;
     }
 
+    const ExhaustID_t exhaust_id = (ExhaustID_t)m_actor->exhausts.size();
     exhaust_t exhaust;
     exhaust.emitterNode   = this->GetNodeIndexOrThrow(def.reference_node);
     exhaust.directionNode = this->GetNodeIndexOrThrow(def.direction_node);
 
     std::string template_name = def.particle_name;
-    if (template_name.empty() || template_name == "default")
+    if (template_name == "" || template_name == "default")
     {
         template_name = "tracks/Smoke"; // defined in `particles/smoke.particle`
     }
+    exhaust.particleSystemName = template_name;
 
-    std::string name = this->ComposeName(template_name.c_str(), (int)m_actor->exhausts.size());
-    exhaust.smoker = this->CreateParticleSystem(name, template_name);
-    if (exhaust.smoker == nullptr)
+    if (!TuneupUtil::isExhaustAnyhowRemoved(m_actor->getWorkingTuneupDef(), exhaust_id))
     {
-        std::stringstream msg;
-        msg << "Failed to create particle system '" << name << "' (template: '" << template_name <<"')";
-        AddMessage(Message::TYPE_ERROR, msg.str());
-        return;
-    }
+        std::string name = this->ComposeName(template_name.c_str(), (int)m_actor->exhausts.size());
+        exhaust.smoker = this->CreateParticleSystem(name, template_name);
+        if (exhaust.smoker == nullptr)
+        {
+            std::stringstream msg;
+            msg << "Failed to create particle system '" << name << "' (template: '" << template_name <<"')";
+            AddMessage(Message::TYPE_ERROR, msg.str());
+            return;
+        }
 
-    exhaust.smokeNode = m_particles_parent_scenenode->createChildSceneNode(this->ComposeName("exhaust", (int)m_actor->exhausts.size()));
-    exhaust.smokeNode->attachObject(exhaust.smoker);
-    exhaust.smokeNode->setPosition(m_actor->ar_nodes[exhaust.emitterNode].AbsPosition);
+        exhaust.smokeNode = m_particles_parent_scenenode->createChildSceneNode(this->ComposeName("exhaust", (int)m_actor->exhausts.size()));
+        exhaust.smokeNode->attachObject(exhaust.smoker);
+        exhaust.smokeNode->setPosition(m_actor->ar_nodes[exhaust.emitterNode].AbsPosition);
 
-    m_actor->m_gfx_actor->SetNodeHot(exhaust.emitterNode, true);
-    m_actor->m_gfx_actor->SetNodeHot(exhaust.directionNode, true);
+        m_actor->m_gfx_actor->SetNodeHot(exhaust.emitterNode, true);
+        m_actor->m_gfx_actor->SetNodeHot(exhaust.directionNode, true);
+    }
 
     m_actor->exhausts.push_back(exhaust);
 }

source/main/physics/SimData.h

@@ -650,8 +650,9 @@ struct exhaust_t
 {
     NodeNum_t emitterNode   = NODENUM_INVALID;
     NodeNum_t directionNode = NODENUM_INVALID;
-    Ogre::SceneNode *smokeNode;
-    Ogre::ParticleSystem* smoker;
+    Ogre::SceneNode *smokeNode = nullptr;
+    Ogre::ParticleSystem* smoker = nullptr; //!< This remains `nullptr` if removed via `addonpart_unwanted_exhaust` or Tuning UI.
+    std::string particleSystemName; //!< Name in .particle file ~ for display in Tuning UI.
 };
 
 

source/main/resources/CacheSystem.cpp

@@ -1827,6 +1827,16 @@ void CacheSystem::ModifyProject(ModifyProjectRequest* request)
         request->mpr_target_actor->getWorkingTuneupDef()->force_wheel_sides.erase(request->mpr_subject_id);
         break;
 
+    case ModifyProjectRequestType::TUNEUP_FORCEREMOVE_EXHAUST_SET:
+        request->mpr_target_actor->ensureWorkingTuneupDef();
+        request->mpr_target_actor->getWorkingTuneupDef()->force_remove_exhausts.insert(request->mpr_subject_id);
+        break;
+
+    case ModifyProjectRequestType::TUNEUP_FORCEREMOVE_EXHAUST_RESET:
+        request->mpr_target_actor->ensureWorkingTuneupDef();
+        request->mpr_target_actor->getWorkingTuneupDef()->force_remove_exhausts.erase(request->mpr_subject_id);
+        break;
+
     case ModifyProjectRequestType::TUNEUP_PROTECTED_PROP_SET:
         request->mpr_target_actor->ensureWorkingTuneupDef();
         request->mpr_target_actor->getWorkingTuneupDef()->protected_props.insert(request->mpr_subject_id);
@@ -1867,6 +1877,16 @@ void CacheSystem::ModifyProject(ModifyProjectRequest* request)
         request->mpr_target_actor->getWorkingTuneupDef()->protected_flares.erase(request->mpr_subject_id);
         break;
 
+    case ModifyProjectRequestType::TUNEUP_PROTECTED_EXHAUST_SET:
+        request->mpr_target_actor->ensureWorkingTuneupDef();
+        request->mpr_target_actor->getWorkingTuneupDef()->protected_exhausts.insert(request->mpr_subject_id);
+        break;
+
+    case ModifyProjectRequestType::TUNEUP_PROTECTED_EXHAUST_RESET:
+        request->mpr_target_actor->ensureWorkingTuneupDef();
+        request->mpr_target_actor->getWorkingTuneupDef()->protected_exhausts.erase(request->mpr_subject_id);
+        break;
+
     case ModifyProjectRequestType::PROJECT_LOAD_TUNEUP:
     {
         // Instead of loading with the saved tuneup directly, keep the autogenerated and sync it with the save.

source/main/resources/CacheSystem.h

@@ -237,8 +237,10 @@ enum class ModifyProjectRequestType
     TUNEUP_FORCEREMOVE_FLEXBODY_RESET, //!< 'subject_id' is flexbody ID.
     TUNEUP_FORCED_WHEEL_SIDE_SET,      //!< 'subject_id' is wheel ID, 'value_int' is RoR::WheelSide
     TUNEUP_FORCED_WHEEL_SIDE_RESET,    //!< 'subject_id' is wheel ID.
-    TUNEUP_FORCEREMOVE_FLARE_SET,       //!< 'subject_id' is flare ID.
-    TUNEUP_FORCEREMOVE_FLARE_RESET,     //!< 'subject_id' is flare ID.
+    TUNEUP_FORCEREMOVE_FLARE_SET,      //!< 'subject_id' is flare ID.
+    TUNEUP_FORCEREMOVE_FLARE_RESET,    //!< 'subject_id' is flare ID.
+    TUNEUP_FORCEREMOVE_EXHAUST_SET,    //!< 'subject_id' is exhaust ID.
+    TUNEUP_FORCEREMOVE_EXHAUST_RESET,  //!< 'subject_id' is exhaust ID.
     TUNEUP_PROTECTED_PROP_SET,         //!< 'subject_id' is prop ID.
     TUNEUP_PROTECTED_PROP_RESET,       //!< 'subject_id' is prop ID.
     TUNEUP_PROTECTED_FLEXBODY_SET,     //!< 'subject_id' is flexbody ID.
@@ -247,6 +249,8 @@ enum class ModifyProjectRequestType
     TUNEUP_PROTECTED_WHEEL_RESET,      //!< 'subject_id' is wheel ID.
     TUNEUP_PROTECTED_FLARE_SET,        //!< 'subject_id' is flare ID.
     TUNEUP_PROTECTED_FLARE_RESET,      //!< 'subject_id' is flare ID.
+    TUNEUP_PROTECTED_EXHAUST_SET,      //!< 'subject_id' is exhaust ID.
+    TUNEUP_PROTECTED_EXHAUST_RESET,    //!< 'subject_id' is exhaust ID.
     PROJECT_LOAD_TUNEUP,               //!< 'subject' is tuneup filename. This overwrites the auto-generated tuneup with the save.
     PROJECT_RESET_TUNEUP,              //!< 'subject' is empty. This resets the auto-generated tuneup to orig. values.
 };

source/main/resources/addonpart_fileformat/AddonPartFileFormat.cpp

@@ -153,6 +153,8 @@ void AddonPartUtility::ResolveUnwantedAndTweakedElements(TuneupDefPtr& tuneup, C
                     this->ProcessUnwantedFlexbody();
                 else if (m_context->getTokKeyword() == "addonpart_unwanted_flare" )
                     this->ProcessUnwantedFlare();
+                else if (m_context->getTokKeyword() == "addonpart_unwanted_exhaust" )
+                    this->ProcessUnwantedExhaust();
                 else if (m_context->getTokKeyword() == "addonpart_tweak_wheel")
                     this->ProcessTweakWheel();
                 else if (m_context->getTokKeyword() == "addonpart_tweak_node")
@@ -470,6 +472,30 @@ void AddonPartUtility::ProcessUnwantedFlare()
     }
 }
 
+void AddonPartUtility::ProcessUnwantedExhaust()
+{
+    ROR_ASSERT(m_context->getTokKeyword() == "addonpart_unwanted_exhaust"); // also asserts !EOF and TokenType::KEYWORD
+
+    if (m_context->isTokFloat(1))
+    {
+        if (!m_tuneup->isExhaustProtected((ExhaustID_t)m_context->getTokFloat(1)))
+        {
+            m_tuneup->unwanted_exhausts.insert((ExhaustID_t)m_context->getTokFloat(1));
+            this->Log(fmt::format("[RoR|Addonpart] INFO: file '{}', directive '{}': marking exhaust '{}' as UNWANTED",
+                m_addonpart_entry->fname, m_context->getTokKeyword(), (int)m_context->getTokFloat(1)));
+        }
+        else
+        {
+            this->Log(fmt::format("[RoR|Addonpart] INFO: file '{}', directive '{}': skipping exhaust '{}' because it's marked PROTECTED",
+                m_addonpart_entry->fname, m_context->getTokKeyword(), m_context->getTokString(1)));
+        }
+    }
+    else
+    {
+        this->Log(fmt::format("[RoR|Addonpart] WARNING: file '{}', directive '{}': bad arguments", m_addonpart_entry->fname, m_context->getTokKeyword()));
+    }
+}
+
 void AddonPartUtility::ProcessTweakWheel()
 {
     ROR_ASSERT(m_context->getTokKeyword() == "addonpart_tweak_wheel"); // also asserts !EOF and TokenType::KEYWORD

source/main/resources/addonpart_fileformat/AddonPartFileFormat.h

@@ -74,7 +74,6 @@ class AddonPartUtility
     void ProcessFlexbody();
     void ProcessFlare();
     void ProcessFlare2();
-    void ProcessFlare3();
     void ProcessTweakWheel();
     void ProcessTweakNode();
     void ProcessTweakFlexbody();
@@ -84,6 +83,7 @@ class AddonPartUtility
     void ProcessUnwantedProp();
     void ProcessUnwantedFlexbody();
     void ProcessUnwantedFlare();
+    void ProcessUnwantedExhaust();
 
     void Log(const std::string& text);
 

source/main/resources/tuneup_fileformat/TuneupFileFormat.cpp

@@ -452,6 +452,13 @@ bool RoR::TuneupUtil::isFlareAnyhowRemoved(TuneupDefPtr& tuneup_def, FlareID_t f
         && (tuneup_def->isFlareUnwanted(flare_id) || tuneup_def->isFlareForceRemoved(flare_id));   
 }
 
+// > exhaust
+bool RoR::TuneupUtil::isExhaustAnyhowRemoved(TuneupDefPtr& tuneup_def, ExhaustID_t exhaust_id)
+{    
+    return tuneup_def 
+        && (tuneup_def->isExhaustUnwanted(exhaust_id) || tuneup_def->isExhaustForceRemoved(exhaust_id));   
+}
+
 bool RoR::TuneupUtil::isAddonPartUsed(TuneupDefPtr& tuneup_entry, const std::string& filename)
 {
     return tuneup_entry

source/main/resources/tuneup_fileformat/TuneupFileFormat.h

@@ -106,6 +106,7 @@ struct TuneupDef: public RefCountingObject<TuneupDef>
     std::set<PropID_t>                            unwanted_props;          //!< 'addonpart_unwanted_prop' directives.
     std::set<FlexbodyID_t>                        unwanted_flexbodies;     //!< 'addonpart_unwanted_flexbody' directives.
     std::set<FlareID_t>                           unwanted_flares;         //!< 'addonpart_unwanted_flare' directives.
+    std::set<ExhaustID_t>                         unwanted_exhausts;       //!< 'addonpart_unwanted_exhaust' directives.
     /// @}
 
     /// @name UI-controlled forced changes (override addonparts)
@@ -114,6 +115,7 @@ struct TuneupDef: public RefCountingObject<TuneupDef>
     std::set<FlexbodyID_t>                        force_remove_flexbodies; //!< UI overrides
     std::map<WheelID_t, WheelSide>                force_wheel_sides;       //!< UI overrides
     std::set<FlareID_t>                           force_remove_flares;     //!< User unticked an UI checkbox in Tuning menu, section Flares.
+    std::set<ExhaustID_t>                         force_remove_exhausts;   //!< User unticked an UI checkbox in Tuning menu, section Exhausts.
     /// @}
 
     /// @name UI-controlled protection from addonpart tweaks
@@ -123,6 +125,7 @@ struct TuneupDef: public RefCountingObject<TuneupDef>
     std::set<PropID_t>                            protected_props;       //!< Props which cannot be altered via 'addonpart_tweak_prop' or 'addonpart_unwanted_prop' directive.
     std::set<FlexbodyID_t>                        protected_flexbodies;  //!< Flexbodies which cannot be altered via 'addonpart_tweak_flexbody' or 'addonpart_unwanted_flexbody' directive.
     std::set<FlareID_t>                           protected_flares;      //!< Flares which cannot be altered via 'addonpart_unwanted_flare' directive.
+    std::set<ExhaustID_t>                         protected_exhausts;    //!< Exhausts which cannot be altered via 'addonpart_unwanted_exhaust' directive.
     /// @}
 
     TuneupDefPtr clone();
@@ -135,13 +138,15 @@ struct TuneupDef: public RefCountingObject<TuneupDef>
     bool         isWheelProtected(WheelID_t wheelid) const { return protected_wheels.find(wheelid) != protected_wheels.end(); }
     bool         isNodeProtected(NodeNum_t nodenum) const { return protected_nodes.find(nodenum) != protected_nodes.end(); }
     bool         isFlareProtected(FlareID_t flareid) const { return protected_flares.find(flareid) != protected_flares.end(); }
+    bool         isExhaustProtected(ExhaustID_t exhaustid) const { return protected_exhausts.find(exhaustid) != protected_exhausts.end(); }
     /// @}
 
     /// @name Unwanted-state helpers
     /// @{
     bool         isPropUnwanted(PropID_t propid) { return unwanted_props.find(propid) != unwanted_props.end(); }
     bool         isFlexbodyUnwanted(FlexbodyID_t flexbodyid) { return unwanted_flexbodies.find(flexbodyid) != unwanted_flexbodies.end(); }
     bool         isFlareUnwanted(FlareID_t flareid) { return unwanted_flares.find(flareid) != unwanted_flares.end(); }
+    bool         isExhaustUnwanted(ExhaustID_t exhaustid) { return unwanted_exhausts.find(exhaustid) != unwanted_exhausts.end(); }
     /// @}
 
     /// @name Forced-state helpers
@@ -150,6 +155,7 @@ struct TuneupDef: public RefCountingObject<TuneupDef>
     bool         isFlexbodyForceRemoved(FlexbodyID_t flexbodyid) { return force_remove_flexbodies.find(flexbodyid) != force_remove_flexbodies.end(); }
     bool         isWheelSideForced(WheelID_t wheelid, WheelSide& out_val) const;
     bool         isFlareForceRemoved(FlareID_t flareid) { return force_remove_flares.find(flareid) != force_remove_flares.end(); }
+    bool         isExhaustForceRemoved(ExhaustID_t exhaustid) { return force_remove_exhausts.find(exhaustid) != force_remove_exhausts.end(); }
     /// @}
 };
 
@@ -206,6 +212,11 @@ class TuneupUtil
     static bool               isFlareAnyhowRemoved(TuneupDefPtr& tuneup_def, FlareID_t flare_id);
     /// @}
 
+    /// @name Exhaust helpers
+    /// @{
+    static bool               isExhaustAnyhowRemoved(TuneupDefPtr& tuneup_def, ExhaustID_t exhaust_id);
+    /// @}
+
 private:
 
     static void ParseTuneupAttribute(const std::string& line, TuneupDefPtr& tuneup_def);