OpenSpace/modules/spacecraftinstruments/rendering/renderableplanetprojection.h

/*****************************************************************************************
 *                                                                                       *
 * OpenSpace                                                                             *
 *                                                                                       *
 * Copyright (c) 2014-2024                                                               *
 *                                                                                       *
 * 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_MODULE_SPACECRAFTINSTRUMENTS___RENDERABLEPLANETPROJECTION___H__
#define __OPENSPACE_MODULE_SPACECRAFTINSTRUMENTS___RENDERABLEPLANETPROJECTION___H__

#include <openspace/rendering/renderable.h>

#include <modules/spacecraftinstruments/util/projectioncomponent.h>
#include <openspace/properties/optionproperty.h>
#include <openspace/properties/stringproperty.h>
#include <openspace/properties/triggerproperty.h>
#include <openspace/properties/vector/vec3property.h>
#include <ghoul/opengl/uniformcache.h>

namespace openspace {

namespace documentation { struct Documentation; }

struct Image;
class Sphere;

namespace planetgeometry { class PlanetGeometry; }

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

    void initializeGL() override;
    void deinitializeGL() override;
    bool isReady() const override;

    void render(const RenderData& data, RendererTasks& rendererTask) override;
    void update(const UpdateData& data) override;
    ghoul::opengl::Texture& baseTexture() const;

    static documentation::Documentation Documentation();

private:
    void loadColorTexture();
    void loadHeightTexture();
    void createSphere();

    glm::mat4 attitudeParameters(double time, const glm::vec3& up);
    void imageProjectGPU(const ghoul::opengl::Texture& projectionTexture,
        const glm::mat4& projectorMatrix);

    ProjectionComponent _projectionComponent;

    properties::OptionProperty _colorTexturePaths;
    properties::StringProperty _addColorTexturePath;
    bool _colorTextureDirty = false;

    properties::OptionProperty _heightMapTexturePaths;
    properties::StringProperty _addHeightMapTexturePath;
    bool _heightMapTextureDirty = false;

    ghoul::opengl::ProgramObject* _programObject = nullptr;
    ghoul::opengl::ProgramObject* _fboProgramObject = nullptr;
    UniformCache(sun_pos, modelTransform, modelViewProjectionTransform, hasBaseMap,
        hasHeightMap, heightExaggeration, meridianShift, ambientBrightness,
        projectionFading, baseTexture, projectionTexture,
        heightTexture) _mainUniformCache;

    UniformCache(projectionTexture, ProjectorMatrix, ModelTransform, boresight,
        radius, segments) _fboUniformCache;

    std::unique_ptr<ghoul::opengl::Texture> _baseTexture;
    std::unique_ptr<ghoul::opengl::Texture> _heightMapTexture;

    properties::FloatProperty _heightExaggeration;
    properties::BoolProperty _meridianShift;
    properties::FloatProperty _ambientBrightness;
    properties::IntProperty _maxProjectionsPerFrame;
    properties::IntProperty _projectionsInBuffer;
    properties::TriggerProperty _clearProjectionBuffer;

    properties::Vec3Property _radius;
    properties::IntProperty _segments;
    std::unique_ptr<Sphere> _sphere;

    glm::mat4 _transform = glm::mat4(1.f);
    glm::mat4 _projectorMatrix = glm::mat4(1.f);
    glm::vec3 _boresight = glm::vec3(0.f);

    std::vector<Image> _imageTimes;

    GLuint _quad = 0;
    GLuint _vertexPositionBuffer = 0;
};

}  // namespace openspace

#endif // __OPENSPACE_MODULE_SPACECRAFTINSTRUMENTS___RENDERABLEPLANETPROJECTION___H__