OpenSpace/modules/advancedatmosphere/rendering/renderableatmosphere.h

/*****************************************************************************************
 *                                                                                       *
 * OpenSpace                                                                             *
 *                                                                                       *
 * Copyright (c) 2014-2020                                                               *
 *                                                                                       *
 * 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_ATMOSPHERE___RENDERABLEATMOSPHERE___H__
#define __OPENSPACE_MODULE_ATMOSPHERE___RENDERABLEATMOSPHERE___H__

#include <openspace/rendering/renderable.h>

#include <modules/atmosphere/rendering/atmospheredeferredcaster.h>

#include <openspace/properties/stringproperty.h>
#include <openspace/properties/scalar/boolproperty.h>
#include <openspace/properties/scalar/intproperty.h>
#include <openspace/properties/scalar/floatproperty.h>
#include <openspace/properties/vector/vec3property.h>
#include <openspace/properties/propertyowner.h>
#include <openspace/util/updatestructures.h>

#include <ghoul/opengl/textureunit.h>

#include <memory>
#include <string>
#include <vector>

namespace ghoul::opengl {
    class ProgramObject;
    class Texture;
}

namespace openspace {

class AtmosphereDeferredcaster;

struct TransformData;
struct AdvancedATMModeData;

// Shadow structure
struct ShadowConfiguration {
    std::pair<std::string, double> source;
    std::pair<std::string, double> caster;
};

struct ShadowRenderingStruct {
    double xu = 0.0;
    double xp = 0.0;
    double rs = 0.0;
    double rc = 0.0;
    glm::dvec3 sourceCasterVec = glm::dvec3(0.0);
    glm::dvec3 casterPositionVec = glm::dvec3(0.0);
    bool isShadowing = false;
};

namespace documentation { struct Documentation; }
namespace planetgeometry { class PlanetGeometry; }

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

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

    void render(const RenderData& data, RendererTasks& rendererTask) override;
    void update(const UpdateData& data) override;

    static documentation::Documentation Documentation();

private:
    glm::dmat4 computeModelTransformMatrix(const openspace::TransformData& transformData);
    void updateAtmosphereParameters();
    void setDeferredCasterParameters(const bool executePreCalculations);

    properties::FloatProperty _atmosphereHeightP;
    properties::FloatProperty _groundAverageReflectanceP;
    properties::FloatProperty _groundRadianceEmittionP;
    properties::FloatProperty _rayleighHeightScaleP;
    properties::Vec3Property  _rayleighScatteringCoeffP;
    properties::BoolProperty  _ozoneEnabledP;
    properties::BoolProperty  _oxygenEnableP;
    properties::Vec3Property  _ozoneAbsorptionCrossSectionP;
    properties::FloatProperty _oxygenHeightScaleP;
    properties::Vec3Property  _oxygenAbsorptionCrossSectionP;
    properties::FloatProperty _mieHeightScaleP;
    properties::Vec3Property  _mieScatteringCoeffP;
    properties::Vec3Property  _mieAbsorptionCoeffP;
    properties::Vec3Property  _mieExtinctionCoeffP;
    properties::FloatProperty _mieScatteringExtinctionPropCoefficientP;
    properties::FloatProperty _mieAsymmetricFactorGP;
    properties::FloatProperty _sunIntensityP;
    properties::BoolProperty  _sunFollowingCameraEnabledP;
    properties::BoolProperty  _hardShadowsEnabledP;
    properties::BoolProperty  _enableAdvancedModeP;

    // Advanced Mode Parameters
    properties::BoolProperty  _useOnlyAdvancedMieP;
    properties::BoolProperty  _useCornettePhaseFunctionP;
    properties::BoolProperty  _usePenndorfPhaseFunctionP;
    properties::Vec3Property  _nRealRayleighP;
    properties::Vec3Property  _nComplexRayleighP;
    properties::Vec3Property  _nRealMieP;
    properties::Vec3Property  _nComplexMieP;
    properties::Vec3Property  _lambdaArrayP;
    properties::Vec3Property  _KappaP;
    properties::Vec3Property  _g1P;
    properties::Vec3Property  _g2P;
    properties::Vec3Property  _alphaP;
    properties::FloatProperty _deltaPolarizabilityP;
    properties::FloatProperty _NRayleighP;
    properties::FloatProperty _NMieP;
    properties::FloatProperty _NRayleighAbsMoleculeP;
    properties::FloatProperty _radiusAbsMoleculeRayleighP;
    properties::FloatProperty _meanRadiusParticleMieP;
    properties::FloatProperty _turbidityP;
    properties::FloatProperty _jungeExponentP;
    properties::PropertyOwner _advancedModeOwner;
    
    bool _atmosphereEnabled               = false;
    bool _ozoneLayerEnabled               = false;
    bool _oxygenAbsEnabled                = false;
    bool _sunFollowingCameraEnabled       = false;
    bool _shadowEnabled                   = false;
    bool _hardShadows                     = false;
    
    float _atmosphereRadius               = 0.f;
    float _atmospherePlanetRadius         = 0.f;
    float _planetAverageGroundReflectance = 0.f;
    float _planetGroundRadianceEmittion   = 0.f;
    float _sunRadianceIntensity           = 5.f;
    float _mieScattExtPropCoefProp        = 1.f;


    // Atmosphere Debug
    bool _saveCalculationsToTexture   = false;
    float _preCalculatedTexturesScale = 1.f;

    std::unique_ptr<AtmosphereDeferredcaster> _deferredcaster;

    glm::dmat3 _stateMatrix = glm::dmat3(1.0);

    std::vector<ShadowConfiguration> _shadowConfArray;
};

} // namespace openspace

#endif // __OPENSPACE_MODULE_ATMOSPHERE___RENDERABLEATMOSPHERE___H__