text: /*****************************************************************************************
   *                                                                                       *
   * OpenSpace                                                                             *
   *                                                                                       *
   * Copyright (c) 2014-2019                                                               *
   *                                                                                       *
   * Permission is hereby granted, free of charge, to any person obtaining a copy of this  *
   * software and associated documentation files (the "Software"), to deal in the Software *
   * without restriction, including without limitation the rights to use, copy, modify,    *
   * merge, publish, distribute, sublicense, and/or sell copies of the Software, and to    *
   * permit persons to whom the Software is furnished to do so, subject to the following   *
   * conditions:                                                                           *
   *                                                                                       *
   * The above copyright notice and this permission notice shall be included in all copies *
   * or substantial portions of the Software.                                              *
   *                                                                                       *
   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,   *
   * INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A         *
   * PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT    *
   * HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF  *
   * CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE  *
   * OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.                                         *
   ****************************************************************************************/
  
  #ifndef __OPENSPACE_CORE___OPENSPACEENGINE___H__
  #define __OPENSPACE_CORE___OPENSPACEENGINE___H__
  
  #include <openspace/properties/stringproperty.h>
  #include <openspace/util/keys.h>
  #include <openspace/util/mouse.h>
  #include <ghoul/glm.h>
  #include <memory>
  #include <string>
  #include <vector>
  
  namespace openspace {
  
  class AssetManager;
  class LoadingScreen;
  class Scene;
  
  namespace scripting { struct LuaLibrary; }
  
    // Structure that is responsible for the delayed shutdown of the application
  struct ShutdownInformation {
      // Whether the application is currently in shutdown mode (i.e. counting down the
      // timer and closing it at '0'
      bool inShutdown = false;
      // Total amount of time the application will wait before actually shutting down
      float waitTime = 0.f;
      // Current state of the countdown; if it reaches '0', the application will
      // close
      float timer = 0.f;
  };
  
  struct CommandlineArguments {
      std::string configurationName;
      std::string configurationOverride;
  };
  
  class OpenSpaceEngine {
  public:
      OpenSpaceEngine();
      ~OpenSpaceEngine();
  
      void registerPathTokens();
      void initialize();
      void initializeGL();
      void deinitialize();
      void deinitializeGL();
      void preSynchronization();
      void postSynchronizationPreDraw();
      void render(const glm::mat4& sceneMatrix, const glm::mat4& viewMatrix,
          const glm::mat4& projectionMatrix);
      void drawOverlays();
      void postDraw();
      void keyboardCallback(Key key, KeyModifier mod, KeyAction action);
      void charCallback(unsigned int codepoint, KeyModifier modifier);
      void mouseButtonCallback(MouseButton button, MouseAction action, KeyModifier mods);
      void mousePositionCallback(double x, double y);
      void mouseScrollWheelCallback(double posX, double posY);
      void externalControlCallback(const char* receivedChars, int size, int clientId);
      std::vector<char> encode();
      void decode(std::vector<char> data);
  
      void scheduleLoadSingleAsset(std::string assetPath);
      void toggleShutdownMode();
  
      // Guaranteed to return a valid pointer
      AssetManager& assetManager();
      LoadingScreen* loadingScreen();
  
      void writeSceneDocumentation();
      void writeStaticDocumentation();
  
      /**
       * Returns the Lua library that contains all Lua functions available to affect the
       * application.
       */
      static scripting::LuaLibrary luaLibrary();
  
  private:
      void loadSingleAsset(const std::string& assetPath);
      void loadFonts();
  
      void runGlobalCustomizationScripts();
      void configureLogging();
  
      std::unique_ptr<Scene> _scene;
      std::unique_ptr<AssetManager> _assetManager;
      std::unique_ptr<LoadingScreen> _loadingScreen;
  
      bool _hasScheduledAssetLoading = false;
      std::string _scheduledAssetPathToLoad;
  
      ShutdownInformation _shutdown;
  
      // The first frame might take some more time in the update loop, so we need to know to
      // disable the synchronization; otherwise a hardware sync will kill us after 1 minute
      bool _isFirstRenderingFirstFrame = true;
  };
  
  } // namespace openspace
  
  #endif // __OPENSPACE_CORE___OPENSPACEENGINE___H__
  