OpenSpace/include/openspace/scene/scene.h

/*****************************************************************************************
 *                                                                                       *
 * OpenSpace                                                                             *
 *                                                                                       *
 * Copyright (c) 2014-2017                                                               *
 *                                                                                       *
 * 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___SCENE___H__
#define __OPENSPACE_CORE___SCENE___H__

#include <vector>
#include <map>
#include <set>
#include <mutex>

#include <openspace/util/camera.h>
#include <openspace/util/updatestructures.h>
#include <openspace/scripting/scriptengine.h>
#include <openspace/scene/scenegraph.h>

#include <ghoul/opengl/programobject.h>

namespace ghoul { class Dictionary; }

namespace openspace {

namespace documentation { struct Documentation; }

class SceneGraphNode;

// Notifications:
// SceneGraphFinishedLoading
class Scene {
public:
    // constructors & destructor
    Scene();
    ~Scene();

    /**
     * Initalizes the SceneGraph by loading modules from the ${SCENEPATH} directory
     */
    bool initialize();

    /*
     * Clean up everything
     */
    bool deinitialize();

    /*
     * Load the scenegraph from the provided folder
     */
    void scheduleLoadSceneFile(const std::string& sceneDescriptionFilePath);
    void clearSceneGraph();

    void loadModule(const std::string& modulePath);

    /*
     * Updates all SceneGraphNodes relative positions
     */
    void update(const UpdateData& data);

    /*
     * Evaluates if the SceneGraphNodes are visible to the provided camera
     */
    void evaluate(Camera* camera);

    /*
     * Render visible SceneGraphNodes using the provided camera
     */
    void render(const RenderData& data, RendererTasks& tasks);

    /*
     * Returns the root SceneGraphNode
     */
    SceneGraphNode* root() const;

    /**
     * Return the scenegraph node with the specified name or <code>nullptr</code> if that
     * name does not exist
     */
    SceneGraphNode* sceneGraphNode(const std::string& name) const;

    std::vector<SceneGraphNode*> allSceneGraphNodes() const;

    SceneGraph& sceneGraph();

    void addSceneGraphNode(SceneGraphNode* node){
        _graph.addSceneGraphNode(node);
    }
    /**
     * Returns the Lua library that contains all Lua functions available to change the
     * scene graph. The functions contained are
     * - openspace::luascriptfunctions::property_setValue
     * - openspace::luascriptfunctions::property_getValue
     * \return The Lua library that contains all Lua functions available to change the
     * scene graph
     */
    static scripting::LuaLibrary luaLibrary();

    static documentation::Documentation Documentation();

private:
    bool loadSceneInternal(const std::string& sceneDescriptionFilePath);

    void writePropertyDocumentation(const std::string& filename, const std::string& type, const std::string& sceneFilename);

    std::string _focus;

    // actual scenegraph
    SceneGraph _graph;
    //SceneGraphNode* _root;
    //std::vector<SceneGraphNode*> _nodes;
    //std::map<std::string, SceneGraphNode*> _allNodes;

    std::string _sceneGraphToLoad;

    std::mutex _programUpdateLock;
    std::set<ghoul::opengl::ProgramObject*> _programsToUpdate;
    std::vector<std::unique_ptr<ghoul::opengl::ProgramObject>> _programs;

    typedef std::map<std::string, ghoul::Dictionary> NodeMap;
    typedef std::multimap<std::string, std::string> DependencyMap;
    typedef std::vector<std::string> LoadedList;

    struct LoadMaps {
        NodeMap nodes;
        DependencyMap dependencies;
        LoadedList loadedNodes;
    };

    void loadModules(const std::string& directory, const ghoul::Dictionary& dictionary);
    void loadModule(LoadMaps& m,const std::string& modulePath, lua_State* state);
    void loadNodes(const std::string& parentName, LoadMaps& m);
    void loadNode(const ghoul::Dictionary& dictionary);
};

} // namespace openspace

#endif // __OPENSPACE_CORE___SCENE___H__