AddonPartFileFormat.h

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-2023 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/>.
*/
 
#pragma once
 
#include "Application.h"
#include "GenericFileFormat.h"
#include "RefCountingObject.h"
#include "RigDef_File.h" // Document
 
#include <OgreResourceManager.h>
 
#include <memory>
#include <string>
#include <unordered_set>
#include <vector>
 
namespace RoR {
 
struct AddonPartConflict 
{
    CacheEntryPtr   atc_addonpart1;
    CacheEntryPtr   atc_addonpart2;
    std::string     atc_keyword;
    int             atc_element_id = -1;
 
    AddonPartConflict(CacheEntryPtr addonpart1, CacheEntryPtr addonpart2, std::string keyword, int element_id):
        atc_addonpart1(addonpart1),
        atc_addonpart2(addonpart2),
        atc_keyword(keyword),
        atc_element_id(element_id)
    {}
};
 
typedef std::vector<AddonPartConflict> AddonPartConflictVec;
 
class AddonPartUtility
{
public:
    AddonPartUtility(bool silent_mode = false);
    ~AddonPartUtility();
 
    std::shared_ptr<RigDef::Document::Module> TransformToRigDefModule(CacheEntryPtr& addonpart_entry);
 
    void ResolveUnwantedAndTweakedElements(TuneupDefPtr& tuneup, CacheEntryPtr& addonpart_entry);
 
    static void ResetUnwantedAndTweakedElements(TuneupDefPtr& tuneup);
 
    static void RecordAddonpartConflicts(CacheEntryPtr addonpart1, CacheEntryPtr addonpart2, AddonPartConflictVec& conflicts);
 
    static bool CheckForAddonpartConflict(CacheEntryPtr addonpart1, CacheEntryPtr addonpart2, AddonPartConflictVec& conflicts);
 
    static bool DoubleCheckForAddonpartConflict(ActorPtr target_actor, CacheEntryPtr addonpart_entry);
 
private:
    // Helpers of `TransformToRigDefModule()`, they expect `m_context` to be in position:
    void ProcessManagedMaterial();
    void ProcessDirectiveSetManagedMaterialsOptions();
    void ProcessProp();
    void ProcessFlexbody();
    void ProcessFlare();
    void ProcessFlare2();
 
    // Helpers of `ResolveUnwantedAndTweakedElements()`, they expect `m_context` to be in position:
    void ProcessTweakWheel();
    void ProcessTweakNode();
    void ProcessTweakFlexbody();
    void ProcessTweakProp();
    void ProcessTweakManagedMat();
    void ProcessUnwantedProp();
    void ProcessUnwantedFlexbody();
    void ProcessUnwantedFlare();
    void ProcessUnwantedExhaust();
    void ProcessUnwantedManagedMat();
 
    void Log(const std::string& text);
 
    // Shared state:
    GenericDocumentPtr m_document;
    GenericDocContextPtr m_context;
    CacheEntryPtr m_addonpart_entry;
    // TransformToRigDefModule() state:
    std::shared_ptr<RigDef::Document::Module> m_module;
    RigDef::ManagedMaterialsOptions m_managedmaterials_options;
    // ResolveUnwantedAndTweakedElements() state:
    TuneupDefPtr m_tuneup;
    bool m_silent_mode = false; 
};
 
}; // namespace RoR