OpenSpace/modules/newhorizons/rendering/renderableplanetprojection.h

/*****************************************************************************************
 *                                                                                       *
 * OpenSpace                                                                             *
 *                                                                                       *
 * Copyright (c) 2014-2016                                                               *
 *                                                                                       *
 * 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 __RENDERABLEPLANETPROJECTION_H__
#define __RENDERABLEPLANETPROJECTION_H__

#include <ghoul/opengl/textureunit.h>

// open space includes
#include <openspace/rendering/renderable.h>
#include <modules/newhorizons/util/imagesequencer.h>

#include <modules/newhorizons/util/sequenceparser.h>
#include <modules/newhorizons/util/hongkangparser.h>
#include <modules/newhorizons/util/labelparser.h>
#include <modules/newhorizons/util/decoder.h>


#include <openspace/properties/stringproperty.h>
#include <openspace/properties/triggerproperty.h>
#include <openspace/util/updatestructures.h>
#include <openspace/util/spicemanager.h>

#include <ghoul/opengl/framebufferobject.h>

// ghoul includes
#include <ghoul/opengl/programobject.h>
#include <ghoul/opengl/texture.h>
#include <openspace/query/query.h>

#include <queue>

namespace openspace {

namespace planetgeometry{
class PlanetGeometry;
}


class RenderablePlanetProjection : public Renderable {
public:
    RenderablePlanetProjection(const ghoul::Dictionary& dictionary);
    ~RenderablePlanetProjection();

    bool initialize() override;
    bool deinitialize() override;
    bool isReady() const override;


    void render(const RenderData& data) override;
    void update(const UpdateData& data) override;
    ghoul::opengl::Texture* baseTexture() { return _texture.get(); };

protected:

    void loadTexture();
    void loadProjectionTexture();
    bool auxiliaryRendertarget();
    glm::mat4 computeProjectorMatrix(const glm::vec3 loc, glm::dvec3 aim, const glm::vec3 up);
    void attitudeParameters(double time);

    void textureBind();
    void project();
    void clearAllProjections();
private:
    void imageProjectGPU();

    std::map<std::string, Decoder*> _fileTranslation;

    properties::StringProperty  _colorTexturePath;
    properties::StringProperty _heightMapTexturePath;
    properties::StringProperty _normalMapTexturePath;

    properties::StringProperty  _projectionTexturePath;
    properties::IntProperty _rotation;
    //properties::FloatProperty _fadeProjection;
    properties::BoolProperty _performProjection;
    properties::BoolProperty _clearAllProjections;

    std::unique_ptr<ghoul::opengl::ProgramObject> _programObject;
    std::unique_ptr<ghoul::opengl::ProgramObject> _fboProgramObject;

    std::unique_ptr<ghoul::opengl::Texture> _texture;
    std::unique_ptr<ghoul::opengl::Texture> _textureOriginal;
    std::unique_ptr<ghoul::opengl::Texture> _textureProj;
    std::unique_ptr<ghoul::opengl::Texture> _textureWhiteSquare;
    std::unique_ptr<ghoul::opengl::Texture> _heightMapTexture;
    std::unique_ptr<ghoul::opengl::Texture> _normalMapTexture;

    properties::FloatProperty _heightExaggeration;
    properties::BoolProperty _enableNormalMapping;

    planetgeometry::PlanetGeometry* _geometry;
    
    glm::vec2  _camScaling;
    glm::vec3  _up;
    glm::mat4  _transform;
    glm::mat4  _projectorMatrix;

    //sequenceloading
    std::string _sequenceSource;
    std::string _sequenceType;
    bool _foundSequence;

    // spice
    std::string _instrumentID;
    std::string _projectorID;
    std::string _projecteeID;
    SpiceManager::AberrationCorrection _aberration;
    std::vector<std::string> _potentialTargets; // @TODO copy-n-paste from renderablefov


    float _fovy;
    float _aspectRatio;
    float _nearPlane;
    float _farPlane;

    glm::dmat3 _stateMatrix;
    glm::dmat3 _instrumentMatrix;
    glm::vec3  _boresight;

    double _time;
    double _previousTime;
    double _previousCapture;
    double lightTime;

    std::vector<Image> _imageTimes;
    int _sequenceID;

    std::string _target;
    std::string _frame;
    std::string _defaultProjImage;
    std::string _clearingImage;
    std::string _next;

    bool _capture;

    // FBO stuff
    GLuint _fboID;
    GLuint _quad;
    GLuint _vertexPositionBuffer;

    bool _hasHeightMap;
    bool _hasNormalMap;

    std::queue<Image> imageQueue;
};
}  // namespace openspace

#endif  // __RENDERABLEPLANETPROJECTION_H__