ActorSpawner.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-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/>.
*/
 
 
 
#pragma once
 
#include "Application.h"
#include "RigDef_Parser.h"
#include "SimData.h"
#include "FlexFactory.h"
#include "FlexObj.h"
 
#include <OgreString.h>
#include <string>
 
namespace RoR {
 
 
class ActorSpawner
{
    friend class RoR::FlexFactory; // Needs to use `ComposeName()` and `SetupNewEntity()`
 
public:
 
    struct ActorMemoryRequirements
    {
        size_t num_nodes     = 0;
        size_t num_beams     = 0;
        size_t num_shocks    = 0;
        size_t num_rotators  = 0;
        size_t num_wings     = 0;
        size_t num_airbrakes = 0;
        size_t num_fixes     = 0;
        // ... more to come ...
    };
 
    enum struct Message
    {
        TYPE_INFO,
        TYPE_WARNING,
        TYPE_ERROR,
    };
 
    void                           ConfigureSections(Ogre::String const & sectionconfig, RigDef::DocumentPtr def);
    void                           ConfigureAddonParts(TuneupDefPtr& tuneup_def);
    void                           ConfigureAssetPacks(ActorPtr actor, RigDef::DocumentPtr def);
    void                           ProcessNewActor(ActorPtr actor, ActorSpawnRequest rq, RigDef::DocumentPtr def);
    static void                    SetupDefaultSoundSources(ActorPtr const& actor);
 
    ActorPtr                       GetActor() { return m_actor; }
    ActorMemoryRequirements const& GetMemoryRequirements() { return m_memory_requirements; }
    std::string                    GetSubmeshGroundmodelName();
 
private:
 
    struct CustomMaterial
    {
        enum class MirrorPropType
        {
            MPROP_NONE,
            MPROP_LEFT,
            MPROP_RIGHT,
        };
 
        CustomMaterial():
            material_flare_def(nullptr),
            video_camera_def(nullptr),
            mirror_prop_type(MirrorPropType::MPROP_NONE),
            mirror_prop_scenenode(nullptr)
        {}
 
        CustomMaterial(Ogre::MaterialPtr& mat):
            material(mat),
            material_flare_def(nullptr),
            video_camera_def(nullptr),
            mirror_prop_type(MirrorPropType::MPROP_NONE),
            mirror_prop_scenenode(nullptr)
        {}
 
        Ogre::MaterialPtr              material;
        RigDef::MaterialFlareBinding*  material_flare_def;
        RigDef::VideoCamera*           video_camera_def;
        MirrorPropType                 mirror_prop_type;
        Ogre::SceneNode*               mirror_prop_scenenode;
    };
 
    struct Exception: public std::runtime_error
    {
        Exception(Ogre::String const & message):runtime_error(message) {}
    };
 
    // PLEASE maintain alphabetical order
    void ProcessAirbrake(RigDef::Airbrake & def);
    void ProcessAnimator(RigDef::Animator & def);
    void ProcessAntiLockBrakes(RigDef::AntiLockBrakes & def);
    void ProcessAuthor(RigDef::Author & def);
    void ProcessAxle(RigDef::Axle & def);
    void ProcessBeam(RigDef::Beam & def);
    void ProcessBrakes(RigDef::Brakes & def);
    void ProcessCameraRail(RigDef::CameraRail & def);
    void ProcessCamera(RigDef::Camera & def);
    void ProcessCinecam(RigDef::Cinecam & def);
    void ProcessCollisionBox(RigDef::CollisionBox & def);
    void ProcessCollisionRange(RigDef::CollisionRange & def);
    void ProcessCommand(RigDef::Command2 & def);
    void ProcessContacter(RigDef::Node::Ref & node_ref);
    void ProcessCruiseControl(RigDef::CruiseControl & def);
    void ProcessDescription(Ogre::String const& line);
    void ProcessEngine(RigDef::Engine & def);
    void ProcessEngoption(RigDef::Engoption & def);
    void ProcessEngturbo(RigDef::Engturbo & def);
    void ProcessExhaust(RigDef::Exhaust & def);
    void ProcessExtCamera(RigDef::ExtCamera & def);
    void ProcessFixedNode(RigDef::Node::Ref node_ref); // 'fixes'
    void ProcessFlare2(RigDef::Flare2 & def);
    void ProcessFlare3(RigDef::Flare3 & def);
    void ProcessFlexbody(RigDef::Flexbody& def);
    void ProcessFlexBodyWheel(RigDef::FlexBodyWheel & def);
    void ProcessFusedrag(RigDef::Fusedrag & def);
    void ProcessGlobals(RigDef::Globals & def);
    void ProcessGuiSettings(RigDef::GuiSettings & def);
    void ProcessHelp(RigDef::Help & def);
    void ProcessHook(RigDef::Hook & def);
    void ProcessHydro(RigDef::Hydro & def);
    void ProcessInterAxle(RigDef::InterAxle & def);
    void ProcessLockgroup(RigDef::Lockgroup & lockgroup);
    void ProcessManagedMaterial(RigDef::ManagedMaterial & def);
    void ProcessMeshWheel(RigDef::MeshWheel & def);
    void ProcessMeshWheel2(RigDef::MeshWheel2 & def);
    void ProcessMinimass(RigDef::Minimass & def);
    void ProcessNode(RigDef::Node & def);
    void ProcessParticle(RigDef::Particle & def);
    void ProcessPistonprop(RigDef::Pistonprop & def);
    void ProcessProp(RigDef::Prop & def); 
    void ProcessRailGroup(RigDef::RailGroup & def);
    void ProcessRopable(RigDef::Ropable & def);
    void ProcessRope(RigDef::Rope & def);
    void ProcessRotator(RigDef::Rotator & def);
    void ProcessRotator2(RigDef::Rotator2 & def);
    void ProcessScrewprop(RigDef::Screwprop & def);
    void ProcessShock(RigDef::Shock & def);
    void ProcessShock2(RigDef::Shock2 & def);
    void ProcessShock3(RigDef::Shock3 & def);
    void ProcessSlidenode(RigDef::SlideNode & def);
    void ProcessSoundSource(RigDef::SoundSource & def);
    void ProcessSoundSource2(RigDef::SoundSource2 & def); 
    void ProcessSpeedLimiter(RigDef::SpeedLimiter& def);
    void ProcessSubmesh(RigDef::Submesh & def);
    void ProcessTie(RigDef::Tie & def);
    void ProcessTorqueCurve(RigDef::TorqueCurve & def);
    void ProcessTractionControl(RigDef::TractionControl & def);
    void ProcessTransferCase(RigDef::TransferCase & def);
    void ProcessTrigger(RigDef::Trigger & def);
    void ProcessTurbojet(RigDef::Turbojet & def);
    void ProcessTurboprop2(RigDef::Turboprop2 & def);
    void ProcessWheelDetacher(RigDef::WheelDetacher & def);
    void ProcessWheel(RigDef::Wheel & def);
    void ProcessWheel2(RigDef::Wheel2 & def);
    void ProcessWing(RigDef::Wing & def);
 
 
    void BuildAeroEngine(
        NodeNum_t ref_node_index,
        NodeNum_t back_node_index,
        NodeNum_t blade_1_node_index,
        NodeNum_t blade_2_node_index,
        NodeNum_t blade_3_node_index,
        NodeNum_t blade_4_node_index,
        NodeNum_t couplenode_index,
        bool is_turboprops,
        Ogre::String const & airfoil,
        float power,
        float pitch);
 
    void _ProcessSimpleInertia(RigDef::Inertia & def, RoR::SimpleInertia& obj);
 
    void _ProcessKeyInertia(
        RigDef::Inertia & inertia, 
        RigDef::Inertia & inertia_defaults, 
        RoR::CmdKeyInertia& contract_key, 
        RoR::CmdKeyInertia& extend_key);
 
    void BuildWheelBeams(
        unsigned int num_rays,
        NodeNum_t base_node_index,
        node_t *axis_node_1,
        node_t *axis_node_2,
        float tyre_spring,
        float tyre_damping,
        float rim_spring,
        float rim_damping,
        std::shared_ptr<RigDef::BeamDefaults> beam_defaults,
        RigDef::Node::Ref const & rigidity_node_id,
        float max_extension = 0.f);
 
    unsigned int AddWheelBeam(
        node_t *node_1,
        node_t *node_2,
        float spring,
        float damping,
        std::shared_ptr<RigDef::BeamDefaults> beam_defaults,
        float max_contraction = -1.f,
        float max_extension = -1.f,
        BeamType type = BEAM_NORMAL);
 
    void BuildWheelObjectAndNodes(
        WheelID_t wheel_id,
        unsigned int num_rays,
        node_t *axis_node_1,
        node_t *axis_node_2,
        node_t *reference_arm_node,
        unsigned int reserve_nodes,
        unsigned int reserve_beams,
        float wheel_radius,
        RigDef::WheelPropulsion propulsion,
        RigDef::WheelBraking braking,
        std::shared_ptr<RigDef::NodeDefaults> node_defaults,
        float wheel_mass,
        float wheel_width = -1.f);
 
    std::pair<unsigned int, bool> AddNode(RigDef::Node::Id & id);
    void                          InitNode(node_t & node, Ogre::Vector3 const & position);
    void                          InitNode(unsigned int node_index, Ogre::Vector3 const & position);
    void                          InitNode(node_t & node, Ogre::Vector3 const & position, std::shared_ptr<RigDef::NodeDefaults> node_defaults);
    beam_t&                       AddBeam(node_t & node_1, node_t & node_2, std::shared_ptr<RigDef::BeamDefaults> & defaults, int detacher_group);
    unsigned int                  AddWheelRimBeam(RigDef::Wheel2 & wheel_2_def, node_t *node_1, node_t *node_2);
    unsigned int                  AddTyreBeam(RigDef::Wheel2 & wheel_2_def, node_t *node_1, node_t *node_2);
    unsigned int                  _SectionWheels2AddBeam(RigDef::Wheel2 & wheel_2_def, node_t *node_1, node_t *node_2);
    WheelID_t                     AddWheel(RigDef::Wheel & wheel);
    WheelID_t                     AddWheel2(RigDef::Wheel2 & wheel_2_def); // 'wheels2'
    void                          GetWheelAxisNodes(RigDef::BaseWheel& def, node_t*& out_node_1, node_t*& out_node_2);
    void                          AddExhaust(NodeNum_t emitter_node_idx, NodeNum_t direction_node_idx);
    RailGroup*                    CreateRail(std::vector<RigDef::Node::Range> & node_ranges);
    void                          InitializeRig();
    void                          FinalizeRig();
 
    void                          CalcMemoryRequirements(ActorMemoryRequirements& req, RigDef::Document::Module* module_def);    
    void                          UpdateCollcabContacterNodes();
    wheel_t::BrakeCombo           TranslateBrakingDef(RigDef::WheelBraking def);
    void                          WashCalculator();
    void                          AdjustNodeBuoyancy(node_t & node, RigDef::Node & node_def, std::shared_ptr<RigDef::NodeDefaults> defaults); 
    void                          AdjustNodeBuoyancy(node_t & node, std::shared_ptr<RigDef::NodeDefaults> defaults); 
    void                          InitBeam(beam_t & beam, node_t *node_1, node_t *node_2);
    void                          CalculateBeamLength(beam_t & beam);
    void                          SetBeamStrength(beam_t & beam, float strength);
    void                          SetBeamSpring(beam_t & beam, float spring);
    void                          SetBeamDamping(beam_t & beam, float damping);
    void                          SetBeamDeformationThreshold(beam_t & beam, std::shared_ptr<RigDef::BeamDefaults> beam_defaults);
    void                          ValidateRotator(int id, int axis1, int axis2, NodeNum_t *nodes1, NodeNum_t *nodes2);
 
    std::string                   ComposeName(const std::string& object, int number = -1);
 
    bool                          AssignWheelToAxle(int & _out_axle_wheel, node_t *axis_node_1, node_t *axis_node_2);
 
    // GetFree*(): Gets a free slot; checks limits, sets it's array position and updates 'free_node' index.
    node_t&                       GetFreeNode();
    beam_t&                       GetFreeBeam();
    node_t&                       GetAndInitFreeNode(Ogre::Vector3 const & position);
    beam_t&                       GetAndInitFreeBeam(node_t & node_1, node_t & node_2);
    shock_t&                      GetFreeShock();
 
    float ComputeWingArea(
        Ogre::Vector3 const & ref, 
        Ogre::Vector3 const & x, 
        Ogre::Vector3 const & y, 
        Ogre::Vector3 const & aref);
 
    bool CollectNodesFromRanges(
        std::vector<RigDef::Node::Range> & node_ranges,
        std::vector<NodeNum_t> & out_node_indices);
 
    node_t*                       GetBeamNodePointer(RigDef::Node::Ref const & node_ref);
    NodeNum_t                     FindNodeIndex(RigDef::Node::Ref & node_ref, bool silent = false);
    NodeNum_t                     ResolveNodeRef(RigDef::Node::Ref const & node_ref);
    node_t*                       GetNodePointer(RigDef::Node::Ref const & node_ref);
    node_t*                       GetNodePointerOrThrow(RigDef::Node::Ref const & node_ref);
    beam_t&                       GetBeam(unsigned int index);
    beam_t*                       FindBeamInRig(NodeNum_t node_a, NodeNum_t node_b);
    NodeNum_t                     GetNodeIndexOrThrow(RigDef::Node::Ref const & id);
 
    bool                          CheckParticleLimit(unsigned int count);
    bool                          CheckAxleLimit(unsigned int count);
    bool                          CheckSubmeshLimit(unsigned int count);
    bool                          CheckTexcoordLimit(unsigned int count);
    bool                          CheckCabLimit(unsigned int count);
    bool                          CheckCameraRailLimit(unsigned int count);
    static bool                   CheckSoundScriptLimit(ActorPtr const& vehicle, unsigned int count);
    bool                          CheckAeroEngineLimit(unsigned int count);
    bool                          CheckScrewpropLimit(unsigned int count);
 
    void                          CreateBeamVisuals(beam_t const& beam, int beam_index, bool visible, std::shared_ptr<RigDef::BeamDefaults> const& beam_defaults, std::string material_override="");
    void                          CreateWheelSkidmarks(WheelID_t wheel_index);
    void                          FinalizeGfxSetup();
    Ogre::MaterialPtr             FindOrCreateCustomizedMaterial(const std::string& mat_lookup_name, const std::string& mat_lookup_rg);
    Ogre::MaterialPtr             CreateSimpleMaterial(Ogre::ColourValue color);
    Ogre::ParticleSystem*         CreateParticleSystem(std::string const & name, std::string const & template_name);
    RigDef::MaterialFlareBinding* FindFlareBindingForMaterial(std::string const & material_name); 
    RigDef::VideoCamera*          FindVideoCameraByMaterial(std::string const & material_name); 
    void                          CreateVideoCamera(RigDef::VideoCamera* def);
    void                          CreateMirrorPropVideoCam(Ogre::MaterialPtr custom_mat, CustomMaterial::MirrorPropType type, Ogre::SceneNode* prop_scenenode);
    void                          SetupNewEntity(Ogre::Entity* e, Ogre::ColourValue simple_color); 
    Ogre::MaterialPtr             InstantiateManagedMaterial(Ogre::String const & rg_name, Ogre::String const & source_name, Ogre::String const & clone_name);
    void                          CreateCabVisual();
    void                          CreateMaterialFlare(int flare_index, Ogre::MaterialPtr mat);
    std::string                   GetCurrentElementMediaRG(); 
    void                          AssignManagedMaterialTexture(Ogre::TextureUnitState* tus, const std::string & mm_name, int media_id, const std::string& tex_name); 
 
    void CreateWheelVisuals(
        WheelID_t wheel_id, 
        NodeNum_t node_base_index,
        unsigned int def_num_rays,
        Ogre::String const& face_material_name,
        Ogre::String const& face_material_rg,
        Ogre::String const& band_material_name,
        Ogre::String const& band_material_rg,
        bool separate_rim,
        float rim_ratio = 1.f
    );
 
    void CreateFlexBodyWheelVisuals(
        WheelID_t wheel_id, 
        NodeNum_t node_base_index,
        NodeNum_t axis_node_1,
        NodeNum_t axis_node_2,
        int num_rays,
        float radius,
        WheelSide side,
        std::string rim_mesh_name,
        std::string rim_mesh_rg,
        std::string tire_mesh_name,
        std::string tire_mesh_rg);
 
    void CreateMeshWheelVisuals(
        WheelID_t wheel_id,
        NodeNum_t base_node_index,
        NodeNum_t axis_node_1_index,
        NodeNum_t axis_node_2_index,
        unsigned int num_rays,
        WheelSide side,
        Ogre::String mesh_name,
        Ogre::String mesh_rg,
        Ogre::String material_name,
        Ogre::String material_rg,
        float rim_radius);
 
    static void                   AddSoundSource(ActorPtr const& vehicle, SoundScriptInstancePtr sound_script, NodeNum_t node_index, int type = -2);
    static void                   AddSoundSourceInstance(ActorPtr const& vehicle, Ogre::String const & sound_script_name, int node_index, int type = -2);
 
    void                          AddMessage(Message type, Ogre::String const & text);
    void                          SetCurrentKeyword(RigDef::Keyword keyword) { m_current_keyword = keyword; }
    void                          HandleException();
 
    struct ActorSpawnState
    {
        // Minimum node mass
        float       global_minimass = DEFAULT_MINIMASS;   
    };
 
    ActorPtr                 m_actor;
    RigDef::DocumentPtr      m_file;
    std::list<std::shared_ptr<RigDef::Document::Module>>
                             m_selected_modules;
    Ogre::Vector3            m_spawn_position;
    bool                     m_apply_simple_materials;
    std::string              m_custom_resource_group;
    bool                     m_generate_wing_position_lights;
    ActorMemoryRequirements  m_memory_requirements;
 
    ActorSpawnState                m_state;
    std::string                    m_cab_material_name; 
    std::string                    m_help_material_name;
    float                          m_wing_area;
    int                            m_airplane_left_light;
    int                            m_airplane_right_light;
    float                          m_fuse_z_min;
    float                          m_fuse_z_max;
    float                          m_fuse_y_min;
    float                          m_fuse_y_max;    
    int                            m_first_wing_index;
    std::vector<CabTexcoord>       m_oldstyle_cab_texcoords;
    std::vector<CabSubmesh>        m_oldstyle_cab_submeshes;    
    RigDef::Keyword                m_current_keyword = RigDef::Keyword::INVALID; 
    std::shared_ptr<RigDef::Document::Module> m_current_module; 
    std::map<Ogre::String, unsigned int> m_named_nodes;
 
    RoR::FlexFactory                          m_flex_factory;
    std::map<std::string, CustomMaterial>     m_material_substitutions; 
    std::map<std::string, Ogre::MaterialPtr>  m_managed_materials;
    Ogre::MaterialPtr                         m_managedmat_placeholder_template; 
    Ogre::MaterialPtr                         m_cab_trans_material;
    Ogre::MaterialPtr                         m_simple_material_base;
    RoR::Renderdash*                          m_oldstyle_renderdash;
    CustomMaterial::MirrorPropType            m_curr_mirror_prop_type;
    Ogre::SceneNode*                          m_curr_mirror_prop_scenenode;
    // Grouping nodes for diagnostics:
    Ogre::SceneNode*                          m_actor_grouping_scenenode = nullptr; 
    Ogre::SceneNode*                          m_wheels_parent_scenenode = nullptr; 
    Ogre::SceneNode*                          m_props_parent_scenenode = nullptr; 
    Ogre::SceneNode*                          m_flexbodies_parent_scenenode = nullptr; 
    Ogre::SceneNode*                          m_flares_parent_scenenode = nullptr; 
    Ogre::SceneNode*                          m_particles_parent_scenenode = nullptr; 
};
 
 
} // namespace RoR