CVar.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 "BitFlags.h"
 
#include <Ogre.h>
#include <string>
 
namespace RoR {
 
 
enum CVarFlags
{
    CVAR_TYPE_BOOL    = BITMASK(1),
    CVAR_TYPE_INT     = BITMASK(2),
    CVAR_TYPE_FLOAT   = BITMASK(3),
    CVAR_ARCHIVE      = BITMASK(4),    
    CVAR_NO_LOG       = BITMASK(5)     
};
 
class CVar
{
public:
 
    CVar(std::string const& name, std::string const& long_name, int flags):
        m_name(name),
        m_long_name(long_name),
        m_flags(flags),
        m_value_num(0.f)
    {
        // Initialize string representation
        if (this->hasFlag(CVAR_TYPE_BOOL | CVAR_TYPE_INT | CVAR_TYPE_FLOAT))
        {
            m_value_str = this->convertStr(m_value_num);
        }
    }
 
    // Data setters
 
    template <typename T>
    void setVal(T val)
    {
        if ((T)m_value_num != val)
        {
            std::string str = this->convertStr((float)val);
            this->logUpdate(str);
            m_value_num = (float)val;
            m_value_str = str;
        }
    }
 
    void setStr(std::string const& str)
    {
        if (m_value_str != str)
        {
            this->logUpdate(str);
            m_value_num = 0;
            m_value_str = str;
        }
    }
 
    // Data getters
 
    std::string const&      getStr() const   { return m_value_str; }
    float                   getFloat() const { return m_value_num; }
    int                     getInt() const   { return (int)m_value_num; }
    bool                    getBool() const  { return (bool)m_value_num; }
    template<typename T> T  getEnum() const  { return (T)this->getInt(); }
 
    // Info getters
 
    std::string const&      getName() const       { return m_name; }
    std::string const&      getLongName() const   { return m_long_name; }
    bool                    hasFlag(int f) const  { return m_flags & f; }
 
private:
    void                    logUpdate(std::string const& new_val);
    std::string             convertStr(float val);
 
    // Variables
 
    std::string        m_name;
    std::string        m_long_name;
                       
    std::string        m_value_str;
    float              m_value_num;
    int                m_flags;
};
 
 
} // namespace RoR