GfxData.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 2016-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/>.
*/
 
/*
    @file
    @brief  Constants and data structures dedicated exclusively to visualization.
            For simulation-related data structures, see 'physics/SimData.h'
*/
 
#pragma once
 
#include "MeshObject.h"
#include "SimConstants.h"
 
#include <Ogre.h>
#include <stdint.h>
#include <string>
 
namespace RoR {
 
 
typedef BitMask64_t PropAnimFlag_t;
 
const PropAnimFlag_t PROP_ANIM_FLAG_AIRSPEED      = BITMASK64(1);
const PropAnimFlag_t PROP_ANIM_FLAG_VVI           = BITMASK64(2);
const PropAnimFlag_t PROP_ANIM_FLAG_ALTIMETER     = BITMASK64(3);
const PropAnimFlag_t PROP_ANIM_FLAG_AOA           = BITMASK64(4);
const PropAnimFlag_t PROP_ANIM_FLAG_FLAP          = BITMASK64(5);
const PropAnimFlag_t PROP_ANIM_FLAG_AIRBRAKE      = BITMASK64(6);
const PropAnimFlag_t PROP_ANIM_FLAG_ROLL          = BITMASK64(7);
const PropAnimFlag_t PROP_ANIM_FLAG_PITCH         = BITMASK64(8);
const PropAnimFlag_t PROP_ANIM_FLAG_THROTTLE      = BITMASK64(9);
const PropAnimFlag_t PROP_ANIM_FLAG_RPM           = BITMASK64(10);
const PropAnimFlag_t PROP_ANIM_FLAG_ACCEL         = BITMASK64(11);
const PropAnimFlag_t PROP_ANIM_FLAG_BRAKE         = BITMASK64(12);
const PropAnimFlag_t PROP_ANIM_FLAG_CLUTCH        = BITMASK64(13);
const PropAnimFlag_t PROP_ANIM_FLAG_TACHO         = BITMASK64(14);
const PropAnimFlag_t PROP_ANIM_FLAG_SPEEDO        = BITMASK64(15);
const PropAnimFlag_t PROP_ANIM_FLAG_PBRAKE        = BITMASK64(16);
const PropAnimFlag_t PROP_ANIM_FLAG_TURBO         = BITMASK64(17);
const PropAnimFlag_t PROP_ANIM_FLAG_SHIFTER       = BITMASK64(18); 
const PropAnimFlag_t PROP_ANIM_FLAG_AETORQUE      = BITMASK64(19);
const PropAnimFlag_t PROP_ANIM_FLAG_AEPITCH       = BITMASK64(20);
const PropAnimFlag_t PROP_ANIM_FLAG_AESTATUS      = BITMASK64(21);
const PropAnimFlag_t PROP_ANIM_FLAG_TORQUE        = BITMASK64(22);
const PropAnimFlag_t PROP_ANIM_FLAG_HEADING       = BITMASK64(23);
const PropAnimFlag_t PROP_ANIM_FLAG_DIFFLOCK      = BITMASK64(24);
const PropAnimFlag_t PROP_ANIM_FLAG_STEERING      = BITMASK64(25);
const PropAnimFlag_t PROP_ANIM_FLAG_EVENT         = BITMASK64(26);
const PropAnimFlag_t PROP_ANIM_FLAG_AILERONS      = BITMASK64(27);
const PropAnimFlag_t PROP_ANIM_FLAG_ARUDDER       = BITMASK64(28);
const PropAnimFlag_t PROP_ANIM_FLAG_BRUDDER       = BITMASK64(29);
const PropAnimFlag_t PROP_ANIM_FLAG_BTHROTTLE     = BITMASK64(30);
const PropAnimFlag_t PROP_ANIM_FLAG_PERMANENT     = BITMASK64(31);
const PropAnimFlag_t PROP_ANIM_FLAG_ELEVATORS     = BITMASK64(32);
const PropAnimFlag_t PROP_ANIM_FLAG_DASHBOARD     = BITMASK64(33); 
const PropAnimFlag_t PROP_ANIM_FLAG_SIGNALSTALK   = BITMASK64(34); 
const PropAnimFlag_t PROP_ANIM_FLAG_GEAR          = BITMASK64(35); 
 
typedef BitMask_t PropAnimMode_t;
 
const PropAnimMode_t PROP_ANIM_MODE_ROTA_X        = BITMASK(1);
const PropAnimMode_t PROP_ANIM_MODE_ROTA_Y        = BITMASK(2);
const PropAnimMode_t PROP_ANIM_MODE_ROTA_Z        = BITMASK(3);
const PropAnimMode_t PROP_ANIM_MODE_OFFSET_X      = BITMASK(4);
const PropAnimMode_t PROP_ANIM_MODE_OFFSET_Y      = BITMASK(5);
const PropAnimMode_t PROP_ANIM_MODE_OFFSET_Z      = BITMASK(6);
const PropAnimMode_t PROP_ANIM_MODE_AUTOANIMATE   = BITMASK(7);
const PropAnimMode_t PROP_ANIM_MODE_NOFLIP        = BITMASK(8);
const PropAnimMode_t PROP_ANIM_MODE_BOUNCE        = BITMASK(9);
 
 
enum class VideoCamState
{
    VCSTATE_INVALID,
    VCSTATE_DISABLED,
    VCSTATE_ENABLED_OFFLINE,
    VCSTATE_ENABLED_ONLINE,
};
 
enum class DebugViewType
{
    DEBUGVIEW_NONE,
    DEBUGVIEW_SKELETON,
    DEBUGVIEW_NODES,
    DEBUGVIEW_BEAMS,
    DEBUGVIEW_WHEELS,
    DEBUGVIEW_SHOCKS,
    DEBUGVIEW_ROTATORS,
    DEBUGVIEW_SLIDENODES,
    DEBUGVIEW_SUBMESH,
    DEBUGVIEW_BUOYANCY,
};
constexpr DebugViewType DEBUGVIEWTYPE_FIRST = DebugViewType::DEBUGVIEW_SKELETON;
constexpr DebugViewType DEBUGVIEWTYPE_LAST = DebugViewType::DEBUGVIEW_BUOYANCY;
inline DebugViewType NextDebugViewType(DebugViewType dv)
{
    return (dv == DEBUGVIEWTYPE_LAST) ? DEBUGVIEWTYPE_FIRST : static_cast<DebugViewType>(static_cast<int>(dv) + 1);
}
 
enum ShifterPropAnim 
{
    SHIFTER_INVALID = 0,
    SHIFTERMAN1 = 1,
    SHIFTERMAN2 = 2,
    SHIFTERSEQ = 3,
    SHIFTERLIN = 4,
    AUTOSHIFTERLIN = 5
};
 
struct PropAnim
{
    float          animratio    = 0;  
    PropAnimFlag_t animFlags    = 0;
    PropAnimMode_t animMode     = 0;
 
    float        animOpt3     = 0;
    float        animOpt5     = 0;
    float        lower_limit  = 0;  
    float        upper_limit  = 0;  
 
    // Only for SHIFTER
    float        shifterSmooth = 0.f;
    float        shifterStep = 0.f;
    float        shifterTarget = 0.f;
};
 
struct Prop
{
    PropID_t              pp_id                   = PROPID_INVALID;
    NodeNum_t             pp_node_ref             = NODENUM_INVALID;
    NodeNum_t             pp_node_x               = NODENUM_INVALID;
    NodeNum_t             pp_node_y               = NODENUM_INVALID;
    Ogre::Vector3         pp_offset               = Ogre::Vector3::ZERO;
    Ogre::Vector3         pp_offset_orig          = Ogre::Vector3::ZERO; 
    Ogre::Vector3         pp_rota                 = Ogre::Vector3::ZERO;
    Ogre::Quaternion      pp_rot                  = Ogre::Quaternion::IDENTITY;
    Ogre::SceneNode*      pp_scene_node           = nullptr;             
    MeshObject*           pp_mesh_obj             = nullptr;             
    std::string           pp_media[2];                                   
    std::vector<PropAnim> pp_animations;
 
    CameraMode_t          pp_camera_mode_active = CAMERA_MODE_ALWAYS_VISIBLE; 
    CameraMode_t          pp_camera_mode_orig = CAMERA_MODE_ALWAYS_VISIBLE;   
 
    // Special prop - steering wheel
    MeshObject*           pp_wheel_mesh_obj       = nullptr;
    Ogre::Vector3         pp_wheel_pos            = Ogre::Vector3::ZERO;
    Ogre::SceneNode*      pp_wheel_scene_node     = nullptr;
    float                 pp_wheel_rot_degree     = 0;
    
    // Special prop - beacon
    char                  pp_beacon_type          = 0;                   
    Ogre::BillboardSet*   pp_beacon_bbs[4]        = {};
    Ogre::SceneNode*      pp_beacon_scene_node[4] = {};
    Ogre::Light*          pp_beacon_light[4]      = {};
    float                 pp_beacon_rot_rate[4]   = {};                  
    float                 pp_beacon_rot_angle[4]  = {};                  
    
    // Special prop - aero engine
    int                   pp_aero_engine_idx      = -1;                  
    bool                  pp_aero_propeller_blade = false;               
    bool                  pp_aero_propeller_spin  = false;               
 
    void setPropMeshesVisible(bool visible)
    {
        if (pp_mesh_obj)
            pp_mesh_obj->setVisible(visible);
        if (pp_wheel_mesh_obj)
            pp_wheel_mesh_obj->setVisible(visible);
        if (pp_beacon_scene_node[0])
            pp_beacon_scene_node[0]->setVisible(visible);
        if (pp_beacon_scene_node[1])
            pp_beacon_scene_node[1]->setVisible(visible);
        if (pp_beacon_scene_node[2])
            pp_beacon_scene_node[2]->setVisible(visible);
        if (pp_beacon_scene_node[3])
            pp_beacon_scene_node[3]->setVisible(visible);
    }
};
 
struct VideoCamera
{
    VideoCamRole         vcam_role           = VCAM_ROLE_INVALID;
    NodeNum_t            vcam_node_center    = NODENUM_INVALID;
    NodeNum_t            vcam_node_dir_y     = NODENUM_INVALID;
    NodeNum_t            vcam_node_dir_z     = NODENUM_INVALID;
    NodeNum_t            vcam_node_alt_pos   = NODENUM_INVALID;
    NodeNum_t            vcam_node_lookat    = NODENUM_INVALID; 
    Ogre::Quaternion     vcam_rotation;
    Ogre::Vector3        vcam_pos_offset     = Ogre::Vector3::ZERO;
    std::string          vcam_mat_name_orig;                        
    Ogre::MaterialPtr    vcam_material;
    std::string          vcam_off_tex_name;                         
    Ogre::Camera*        vcam_ogre_camera    = nullptr;
    Ogre::RenderTexture* vcam_render_target  = nullptr;
    Ogre::TexturePtr     vcam_render_tex;
    Ogre::SceneNode*     vcam_debug_node     = nullptr;
    Ogre::RenderWindow*  vcam_render_window  = nullptr;
    Ogre::SceneNode*     vcam_prop_scenenode = nullptr;             
};
 
struct NodeGfx
{
    NodeGfx(NodeNum_t node_idx):
        nx_node_idx(node_idx),
        nx_no_particles(false), // Bitfields can't be initialized in-class :(
        nx_may_get_wet(false),
        nx_is_hot(false),
        nx_no_sparks(true),
        nx_under_water_prev(false)
    {}
 
    float      nx_wet_time_sec = -1; 
    NodeNum_t  nx_node_idx = NODENUM_INVALID;
 
    // Bit flags
    bool       nx_no_particles:1;     
    bool       nx_may_get_wet:1;      
    bool       nx_is_hot:1;           
    bool       nx_under_water_prev:1; 
    bool       nx_no_sparks:1;        
 
};
 
struct BeamGfx
{
    BeamGfx();
    ~BeamGfx();
 
    // We don't keep pointer to the Ogre::Entity - we rely on the SceneNode keeping it attached all the time.
    Ogre::SceneNode* rod_scenenode       = nullptr;
    uint16_t         rod_beam_index      = 0;
    float            rod_diameter        = 0.f;                    
 
    NodeNum_t        rod_node1           = NODENUM_INVALID;  
    NodeNum_t        rod_node2           = NODENUM_INVALID;  
    ActorPtr         rod_target_actor;
    bool             rod_is_visible      = false;
};
 
struct FreeBeamGfx
{
    FreeBeamGfxID_t  fbx_id = FREEBEAMGFXID_INVALID; 
 
    FreeForceID_t    fbx_freeforce_primary = FREEFORCEID_INVALID; 
    FreeForceID_t    fbx_freeforce_secondary = FREEFORCEID_INVALID; 
 
    // We don't keep pointer to the Ogre::Entity - we rely on the SceneNode keeping it attached all the time.
    Ogre::SceneNode* fbx_scenenode = nullptr;
    float            fbx_diameter = DEFAULT_BEAM_DIAMETER; 
    bool             fbx_is_visible = false;
};
 
struct FreeBeamGfxRequest
{
    // AngelScript `dictionary` converts all primitives to `double` or `int64`, see 'scriptdictionary.cpp', function `Set()`
 
    /*FreeBeamGfxID_t*/int64_t  fbr_id = FREEBEAMGFXID_INVALID; 
 
    /*FreeForceID_t*/ int64_t   fbr_freeforce_primary = FREEFORCEID_INVALID; 
    /*FreeForceID_t*/ int64_t   fbr_freeforce_secondary = FREEFORCEID_INVALID; 
 
    std::string       fbr_mesh_name = "beam.mesh";
    std::string       fbr_material_name = "tracks/beam";
    double            fbr_diameter = DEFAULT_BEAM_DIAMETER; 
};
 
struct WheelGfx
{
    WheelID_t          wx_wheel_id         = WHEELID_INVALID;
    Flexable*          wx_flex_mesh        = nullptr;
    Ogre::SceneNode*   wx_scenenode        = nullptr;
    WheelSide          wx_side             = WheelSide::INVALID;
    std::string        wx_rim_mesh_name;                         
};
 
struct AirbrakeGfx
{
    Ogre::MeshPtr    abx_mesh;
    Ogre::SceneNode* abx_scenenode;
    Ogre::Entity*    abx_entity;
    Ogre::Vector3    abx_offset;
    NodeNum_t        abx_ref_node = NODENUM_INVALID;
    NodeNum_t        abx_x_node   = NODENUM_INVALID;
    NodeNum_t        abx_y_node   = NODENUM_INVALID;
};
 
struct FlareMaterial // materialflares
{
    int               flare_index;
    Ogre::MaterialPtr mat_instance;
    Ogre::ColourValue emissive_color;
};
 
struct Exhaust
{
    NodeNum_t emitterNode   = NODENUM_INVALID;
    NodeNum_t directionNode = NODENUM_INVALID;
    Ogre::SceneNode *smokeNode = nullptr;
    Ogre::ParticleSystem* smoker = nullptr; 
    std::string particleSystemName; 
};
 
struct CParticle
{
    NodeNum_t emitterNode   = NODENUM_INVALID;
    NodeNum_t directionNode = NODENUM_INVALID;
    Ogre::SceneNode *snode = nullptr;
    Ogre::ParticleSystem* psys = nullptr;
};
 
 
} // namespace RoR