OpenSpace/modules/space/rendering/renderablestars.h

/*****************************************************************************************
 *                                                                                       *
 * OpenSpace                                                                             *
 *                                                                                       *
 * Copyright (c) 2014-2025                                                               *
 *                                                                                       *
 * 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_SPACE___RENDERABLESTARS___H__
#define __OPENSPACE_MODULE_SPACE___RENDERABLESTARS___H__

#include <openspace/rendering/renderable.h>

#include <openspace/data/dataloader.h>
#include <openspace/properties/misc/stringproperty.h>
#include <openspace/properties/misc/optionproperty.h>
#include <openspace/properties/propertyowner.h>
#include <openspace/properties/scalar/floatproperty.h>
#include <openspace/properties/vector/vec2property.h>
#include <openspace/properties/vector/vec3property.h>
#include <ghoul/opengl/ghoul_gl.h>
#include <ghoul/opengl/uniformcache.h>
#include <optional>

namespace ghoul::filesystem { class File; }
namespace ghoul::opengl {
    class ProgramObject;
    class Texture;
} // namespace ghoul::opengl

namespace openspace {

namespace documentation { struct Documentation; }

class RenderableStars : public Renderable {
public:
    explicit RenderableStars(const ghoul::Dictionary& dictionary);
    ~RenderableStars() override = default;

    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:
    enum ColorOption {
        Color = 0,
        Velocity = 1,
        Speed = 2,
        OtherData = 3,
        FixedColor = 4
    };

    void loadPSFTexture();
    void loadData();
    std::vector<float> createDataSlice(ColorOption option);

    properties::StringProperty _speckFile;

    properties::StringProperty _colorTexturePath;
    std::unique_ptr<ghoul::opengl::Texture> _colorTexture;
    std::unique_ptr<ghoul::filesystem::File> _colorTextureFile;

    struct {
        properties::PropertyOwner container;

        properties::StringProperty bvColor;
        properties::StringProperty luminance;
        properties::StringProperty absoluteMagnitude;
        properties::StringProperty vx;
        properties::StringProperty vy;
        properties::StringProperty vz;
        properties::StringProperty speed;
    } _dataMapping;

    properties::OptionProperty _colorOption;
    properties::OptionProperty _otherDataOption;
    properties::StringProperty _otherDataColorMapPath;
    properties::Vec2Property _otherDataRange;
    std::unique_ptr<ghoul::opengl::Texture> _otherDataColorMapTexture;
    properties::Vec3Property _fixedColor;
    properties::BoolProperty _filterOutOfRange;

    struct TextureComponent {
        properties::PropertyOwner container;

        properties::StringProperty texturePath;
        properties::FloatProperty multiplier;
        properties::FloatProperty gamma;
        properties::FloatProperty scale;

        std::unique_ptr<ghoul::opengl::Texture> texture;
        std::unique_ptr<ghoul::filesystem::File> file;
    };

    TextureComponent _core;
    TextureComponent _glare;

    struct {
        properties::PropertyOwner container;
        properties::OptionProperty method;
        properties::FloatProperty lumCent;
        properties::FloatProperty radiusCent;
    } _parameters;

    properties::FloatProperty _magnitudeExponent;
    properties::Vec2Property _fadeInDistances;
    properties::BoolProperty _useProperMotion;
    properties::DoubleProperty _properMotionEpoch;
    properties::BoolProperty _enableFadeInDistance;

    std::unique_ptr<ghoul::opengl::ProgramObject> _program;
    UniformCache(
        modelMatrix, cameraViewProjectionMatrix, cameraUp, eyePosition, colorOption,
        useProperMotion, diffTime, magnitudeExponent, sizeComposition, lumCent,
        radiusCent, colorTexture, opacity, otherDataTexture, otherDataRange,
        filterOutOfRange, fixedColor, glareTexture, glareMultiplier, glareGamma,
        glareScale, hasCore, coreTexture, coreMultiplier, coreGamma, coreScale
    ) _uniformCache;

    bool _speckFileIsDirty = true;
    bool _pointSpreadFunctionTextureIsDirty = true;
    bool _colorTextureIsDirty = true;
    bool _dataIsDirty = true;
    bool _otherDataColorMapIsDirty = true;

    dataloader::Dataset _dataset;

    std::string _queuedOtherData;

    std::optional<float> _staticFilterValue;
    float _staticFilterReplacementValue = 0.f;

    GLuint _vao = 0;
    GLuint _vbo = 0;
};

} // namespace openspace

#endif // __OPENSPACE_MODULE_SPACE___RENDERABLESTARS___H__