hal.h

Go to the documentation of this file.

/*
        Skyscraper 2.0 - Hardware Abstraction Layer
        Copyright (C)2004-2024 Ryan Thoryk
        https://www.skyscrapersim.net
        https://sourceforge.net/projects/skyscraper/
        Contact - ryan@skyscrapersim.net
 
        This program is free software; you can redistribute it and/or
        modify it under the terms of the GNU General Public License
        as published by the Free Software Foundation; either version 2
        of the License, or (at your option) any later version.
 
        This program 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 this program; if not, write to the Free Software
        Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
*/
 
#ifndef HAL_H
#define HAL_H
 
#include <OgrePrerequisites.h>
#include <OgreCommon.h>
#include <Ogre.h>
#include <OgreLog.h>
#include <OgreTrays.h>
#ifndef DISABLE_SOUND
        #include <fmod.hpp>
#endif
#include "vm.h"
 
namespace Ogre {
        class SceneNode;
        class Rectangle2D;
        class ConfigFile;
        class OverlaySystem;
}
 
namespace FMOD {
        class System;
        class Sound;
        class Channel;
}
 
namespace Skyscraper {
 
class VMIMPEXP HAL : public Ogre::LogListener
{
public:
    HAL(VM *vm);
    ~HAL();
        bool Initialize(const std::string &data_path, Ogre::Root *root = 0, Ogre::OverlaySystem *overlay = 0);
        bool Render();
        void ClickedObject(bool left, bool shift, bool ctrl, bool alt, bool right, Real scale, bool center_only);
        void UnclickedObject();
        int GetConfigInt(Ogre::ConfigFile *file, const std::string &key, int default_value);
        std::string GetConfigString(Ogre::ConfigFile *file, const std::string &key, const std::string &default_value);
        bool GetConfigBool(Ogre::ConfigFile *file, const std::string &key, bool default_value);
        Real GetConfigFloat(Ogre::ConfigFile *file, const std::string &key, Real default_value);
        bool PlaySound(const std::string &filename, Real volume = 1.0);
        void StopSound();
        void ClearScene();
        void ToggleStats();
        void EnableStats(bool value);
        FMOD::System* GetSoundSystem();
        Ogre::RenderWindow* GetRenderWindow();
        void Clear();
        Ogre::SceneManager* GetSceneManager();
        Ogre::RenderWindow* CreateRenderWindow(const std::string &name, int width, int height, const Ogre::NameValuePairList &params);
        void DestroyRenderWindow();
        void RefreshViewport();
    void UpdateOpenXR();
        void ReInit();
        void Report(const std::string &message, const std::string &prompt);
        bool ReportError(const std::string &message, const std::string &prompt);
        bool ReportFatalError(const std::string &message, const std::string &prompt);
        void LoadConfiguration(const std::string data_path, bool show_console);
        bool LoadSystem(const std::string &data_path, Ogre::RenderWindow *renderwindow);
        void ConsoleOut(const std::string &message, const std::string &color = "white");
        std::string GetColors(const std::string &color);
        unsigned long GetCurrentTime();
 
        bool RTSS;
        std::string Renderer;
        bool DisableSound;
        std::vector<Ogre::Camera*> mCameras;
        Ogre::Root* mRoot;
        Ogre::RenderWindow* mRenderWindow;
        std::vector<Ogre::Viewport*> mViewports;
        bool DX11;
 
        //config files
        Ogre::ConfigFile *configfile;
        Ogre::ConfigFile *keyconfigfile;
        Ogre::ConfigFile *joyconfigfile;
 
private:
 
        //OGRE engine data
        Ogre::SceneManager* mSceneMgr;
        Ogre::OverlaySystem* mOverlaySystem;
 
    //OGRE log manager
        Ogre::LogManager* logger;
        Ogre::Log* log;
 
        //sound data
        FMOD::System *soundsys;
        FMOD::Sound *sound;
        FMOD::Channel *channel;
 
    //reporting functions
        void Report(const std::string &message);
        bool ReportError(const std::string &message);
        bool ReportFatalError(const std::string &message);
        Ogre::ConfigFile* ConfigLoad(const std::string &filename, bool delete_after_use = false);
        void messageLogged(const std::string &message, Ogre::LogMessageLevel lml, bool maskDebug, const std::string &logName, bool &skipThisMessage);
 
    //stats
        OgreBites::TrayManager* mTrayMgr;
        int show_stats;
 
        //Ogre timer
        Ogre::Timer *timer;
 
    VM *vm;
};
 
}
 
#endif