/***************************************************************************************** * * * OpenSpace * * * * Copyright (c) 2014-2021 * * * * 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. * ****************************************************************************************/ #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include namespace { constexpr const char* _loggerCat = "RenderableStars"; constexpr const std::array UniformNames = { "modelMatrix", "cameraUp", "cameraViewProjectionMatrix", "colorOption", "magnitudeExponent", "eyePosition", "psfParamConf", "lumCent", "radiusCent", "brightnessCent", "colorTexture", "alphaValue", "psfTexture", "otherDataTexture", "otherDataRange", "filterOutOfRange", "fixedColor" }; constexpr const int RenderOptionPointSpreadFunction = 0; constexpr const int RenderOptionTexture = 1; constexpr const int PsfMethodSpencer = 0; constexpr const int PsfMethodMoffat = 1; constexpr const int PsfTextureSize = 64; constexpr const int ConvolvedfTextureSize = 257; constexpr double PARSEC = 0.308567756E17; struct ColorVBOLayout { std::array position; float value; float luminance; float absoluteMagnitude; float apparentMagnitude; }; struct VelocityVBOLayout { std::array position; float value; float luminance; float absoluteMagnitude; float apparentMagnitude; float vx; // v_x float vy; // v_y float vz; // v_z }; struct SpeedVBOLayout { std::array position; float value; float luminance; float absoluteMagnitude; float apparentMagnitude; float speed; }; struct OtherDataLayout { std::array position; float value; float luminance; float absoluteMagnitude; float apparentMagnitude; }; constexpr openspace::properties::Property::PropertyInfo SpeckFileInfo = { "SpeckFile", "Speck File", "The speck file that is loaded to get the data for rendering these stars." }; static const openspace::properties::Property::PropertyInfo ColorTextureInfo = { "ColorMap", "ColorBV Texture", "The path to the texture that is used to convert from the B-V value of the star " "to its color. The texture is used as a one dimensional lookup function." }; constexpr openspace::properties::Property::PropertyInfo MappingBvInfo = { "MappingBV", "Mapping (bv-color)", "The name of the variable in the speck file that is used as the b-v color " "variable" }; constexpr openspace::properties::Property::PropertyInfo MappingLuminanceInfo = { "MappingLuminance", "Mapping (luminance)", "The name of the variable in the speck file that is used as the luminance " "variable" }; constexpr openspace::properties::Property::PropertyInfo MappingAbsMagnitudeInfo = { "MappingAbsMagnitude", "Mapping (absolute magnitude)", "The name of the variable in the speck file that is used as the absolute " "magnitude variable" }; constexpr openspace::properties::Property::PropertyInfo MappingAppMagnitudeInfo = { "MappingAppMagnitude", "Mapping (apparent magnitude)", "The name of the variable in the speck file that is used as the apparent " "magnitude variable" }; constexpr openspace::properties::Property::PropertyInfo MappingVxInfo = { "MappingVx", "Mapping (vx)", "The name of the variable in the speck file that is used as the star velocity " "along the x-axis" }; constexpr openspace::properties::Property::PropertyInfo MappingVyInfo = { "MappingVy", "Mapping (vy)", "The name of the variable in the speck file that is used as the star velocity " "along the y-axis" }; constexpr openspace::properties::Property::PropertyInfo MappingVzInfo = { "MappingVz", "Mapping (vz)", "The name of the variable in the speck file that is used as the star velocity " "along the z-axis" }; constexpr openspace::properties::Property::PropertyInfo MappingSpeedInfo = { "MappingSpeed", "Mapping (speed)", "The name of the variable in the speck file that is used as the speed" }; constexpr openspace::properties::Property::PropertyInfo ColorOptionInfo = { "ColorOption", "Color Option", "This value determines which quantity is used for determining the color of the " "stars." }; constexpr openspace::properties::Property::PropertyInfo OtherDataOptionInfo = { "OtherData", "Other Data Column", "The index of the speck file data column that is used as the color input" }; constexpr openspace::properties::Property::PropertyInfo OtherDataValueRangeInfo = { "OtherDataValueRange", "Range of the other data values", "This value is the min/max value range that is used to normalize the other data " "values so they can be used by the specified color map." }; constexpr openspace::properties::Property::PropertyInfo FixedColorInfo = { "FixedColorValue", "Color used for fixed star colors", "The color that should be used if the 'Fixed Color' value is used." }; constexpr openspace::properties::Property::PropertyInfo OtherDataColorMapInfo = { "OtherDataColorMap", "Other Data Color Map", "The color map that is used if the 'Other Data' rendering method is selected" }; constexpr openspace::properties::Property::PropertyInfo FilterOutOfRangeInfo = { "FilterOutOfRange", "Filter Out of Range", "Determines whether other data values outside the value range should be visible " "or filtered away" }; // Old Method constexpr openspace::properties::Property::PropertyInfo PsfTextureInfo = { "Texture", "Point Spread Function Texture", "The path to the texture that should be used as a point spread function for the " "stars." }; //constexpr openspace::properties::Property::PropertyInfo ShapeTextureInfo = { // "ShapeTexture", // "Shape Texture to be convolved", // "The path to the texture that should be used as the base shape for the stars." //}; // PSF constexpr openspace::properties::Property::PropertyInfo MagnitudeExponentInfo = { "MagnitudeExponent", "Magnitude Exponent", "Adjust star magnitude by 10^MagnitudeExponent. " "Stars closer than this distance are given full opacity. " "Farther away, stars dim proportionally to the logarithm of their distance." }; constexpr openspace::properties::Property::PropertyInfo RenderMethodOptionInfo = { "RenderMethod", "Render Method", "Render method for the stars." }; openspace::properties::PropertyOwner::PropertyOwnerInfo UserProvidedTextureOptionInfo = { "UserProvidedTexture", "User Provided Texture", "" }; openspace::properties::PropertyOwner::PropertyOwnerInfo ParametersOwnerOptionInfo = { "ParametersOwner", "Parameters Options", "" }; openspace::properties::PropertyOwner::PropertyOwnerInfo MoffatMethodOptionInfo = { "MoffatMethodOption", "Moffat Method", "" }; constexpr openspace::properties::Property::PropertyInfo PSFMethodOptionInfo = { "PSFMethodOptionInfo", "PSF Method Option", "Debug option for PSF main function: Spencer or Moffat." }; constexpr openspace::properties::Property::PropertyInfo SizeCompositionOptionInfo = { "SizeComposition", "Size Composition Option", "Base multiplyer for the final stars' sizes." }; constexpr openspace::properties::Property::PropertyInfo LumPercentInfo = { "LumPercent", "Luminosity Contribution", "Luminosity Contribution." }; constexpr openspace::properties::Property::PropertyInfo RadiusPercentInfo = { "RadiusPercent", "Radius Contribution", "Radius Contribution." }; constexpr openspace::properties::Property::PropertyInfo BrightnessPercentInfo = { "BrightnessPercen", "App Brightness Contribution", "App Brightness Contribution." }; openspace::properties::PropertyOwner::PropertyOwnerInfo SpencerPSFParamOwnerInfo = { "SpencerPSFParamOwner", "Spencer PSF Paramameters", "PSF parameters for Spencer" }; constexpr openspace::properties::Property::PropertyInfo P0ParamInfo = { "P0Param", "P0", "P0 parameter contribution." }; constexpr openspace::properties::Property::PropertyInfo P1ParamInfo = { "P1Param", "P1", "P1 parameter contribution." }; constexpr openspace::properties::Property::PropertyInfo P2ParamInfo = { "P2Param", "P2", "P2 parameter contribution." }; constexpr openspace::properties::Property::PropertyInfo AlphaConstInfo = { "AlphaConst", "Alpha", "Empirical Alpha Constant." }; openspace::properties::PropertyOwner::PropertyOwnerInfo MoffatPSFParamOwnerInfo = { "MoffatPSFParam", "Moffat PSF Parameters", "PSF parameters for Moffat" }; constexpr openspace::properties::Property::PropertyInfo FWHMInfo = { "FWHM", "FWHM", "Moffat's FWHM" }; constexpr openspace::properties::Property::PropertyInfo BetaInfo = { "Beta", "Beta", "Moffat's Beta Constant." }; constexpr openspace::properties::Property::PropertyInfo FadeInDistancesInfo = { "FadeInDistances", "Fade-In Start and End Distances", "These values determine the initial and final distances from the center of " "our galaxy from which the astronomical object will start and end " "fading-in." }; constexpr openspace::properties::Property::PropertyInfo DisableFadeInInfo = { "DisableFadeIn", "Disable Fade-in effect", "Enables/Disables the Fade-in effect." }; struct [[codegen::Dictionary(RenderableStars)]] Parameters { // The path to the SPECK file containing information about the stars being // rendered std::filesystem::path speckFile [[codegen::key("File")]]; // [[codegen::verbatim(ColorTextureInfo.description)]] std::filesystem::path colorMap; enum class ColorOption { Color, Velocity, Speed, OtherData [[codegen::key("Other Data")]], FixedColor [[codegen::key("Fixed Color")]] }; // [[codegen::verbatim(ColorOptionInfo.description)]] std::optional colorOption; // [[codegen::verbatim(OtherDataOptionInfo.description)]] std::optional otherData; // [[codegen::verbatim(OtherDataColorMapInfo.description)]] std::optional otherDataColorMap; // [[codegen::verbatim(FilterOutOfRangeInfo.description)]] std::optional filterOutOfRange; // This value specifies a value that is always filtered out of the value ranges on // loading. This can be used to trim the dataset's automatic value range std::optional staticFilter; // This is the value that is used to replace statically filtered values. Setting // this value only makes sense if 'StaticFilter' is 'true', as well std::optional staticFilterReplacement; // [[codegen::verbatim(MagnitudeExponentInfo.description)]] std::optional magnitudeExponent; enum class RenderMethod { PSF, TextureBased [[codegen::key("Texture Based")]] }; // [[codegen::verbatim(RenderMethodOptionInfo.description)]] RenderMethod renderMethod; // [[codegen::verbatim(PsfTextureInfo.description)]] std::filesystem::path texture; enum class SizeComposition { AppBrightness [[codegen::key("App Brightness")]], LumSize [[codegen::key("Lum and Size")]], LumSizeAppBrightness [[codegen::key("Lum, Size and App Brightness")]], AbsMagnitude [[codegen::key("Abs Magnitude")]], AppMagnitude [[codegen::key("App Magnitude")]], DistanceModulus [[codegen::key("Distance Modulus")]] }; // [[codegen::verbatim(SizeCompositionOptionInfo.description)]] std::optional sizeComposition; struct DataMapping { // [[codegen::verbatim(MappingBvInfo.description)]] std::optional bv; // [[codegen::verbatim(MappingLuminanceInfo.description)]] std::optional luminance; // [[codegen::verbatim(MappingAbsMagnitudeInfo.description)]] std::optional absoluteMagnitude; // [[codegen::verbatim(MappingAppMagnitudeInfo.description)]] std::optional apparentMagnitude; // [[codegen::verbatim(MappingVxInfo.description)]] std::optional vx; // [[codegen::verbatim(MappingVyInfo.description)]] std::optional vy; // [[codegen::verbatim(MappingVzInfo.description)]] std::optional vz; // [[codegen::verbatim(MappingSpeedInfo.description)]] std::optional speed; }; // The mappings between data values and the variable names specified in the speck // file DataMapping dataMapping; // [[codegen::verbatim(FadeInDistancesInfo.description)]] std::optional fadeInDistances; // [[codegen::verbatim(DisableFadeInInfo.description)]] std::optional disableFadeIn; }; #include "renderablestars_codegen.cpp" } // namespace namespace openspace { documentation::Documentation RenderableStars::Documentation() { return codegen::doc("space_renderablestars"); } RenderableStars::RenderableStars(const ghoul::Dictionary& dictionary) : Renderable(dictionary) , _speckFile(SpeckFileInfo) , _colorTexturePath(ColorTextureInfo) //, _shapeTexturePath(ShapeTextureInfo) , _dataMappingContainer({ "DataMapping", "Data Mapping" }) , _dataMapping{ properties::StringProperty(MappingBvInfo), properties::StringProperty(MappingLuminanceInfo), properties::StringProperty(MappingAbsMagnitudeInfo), properties::StringProperty(MappingAppMagnitudeInfo), properties::StringProperty(MappingVxInfo), properties::StringProperty(MappingVyInfo), properties::StringProperty(MappingVzInfo), properties::StringProperty(MappingSpeedInfo) } , _colorOption(ColorOptionInfo, properties::OptionProperty::DisplayType::Dropdown) , _otherDataOption( OtherDataOptionInfo, properties::OptionProperty::DisplayType::Dropdown ) , _otherDataColorMapPath(OtherDataColorMapInfo) , _otherDataRange( OtherDataValueRangeInfo, glm::vec2(0.f, 1.f), glm::vec2(-10.f, -10.f), glm::vec2(10.f, 10.f) ) , _fixedColor(FixedColorInfo, glm::vec3(1.f), glm::vec3(0.f), glm::vec3(1.f)) , _filterOutOfRange(FilterOutOfRangeInfo, false) , _pointSpreadFunctionTexturePath(PsfTextureInfo) , _psfMethodOption( PSFMethodOptionInfo, properties::OptionProperty::DisplayType::Dropdown ) , _psfMultiplyOption( SizeCompositionOptionInfo, properties::OptionProperty::DisplayType::Dropdown ) , _lumCent(LumPercentInfo, 0.5f, 0.f, 3.f) , _radiusCent(RadiusPercentInfo, 0.5f, 0.f, 3.f) , _brightnessCent(BrightnessPercentInfo, 0.5f, 0.f, 3.f) , _magnitudeExponent(MagnitudeExponentInfo, 4.f, 0.f, 8.f) , _spencerPSFParamOwner(SpencerPSFParamOwnerInfo) , _p0Param(P0ParamInfo, 0.384f, 0.f, 1.f) , _p1Param(P1ParamInfo, 0.478f, 0.f, 1.f) , _p2Param(P2ParamInfo, 0.138f, 0.f, 1.f) , _spencerAlphaConst(AlphaConstInfo, 0.02f, 0.000001f, 5.f) , _moffatPSFParamOwner(MoffatPSFParamOwnerInfo) , _FWHMConst(FWHMInfo, 10.4f, 0.f, 100.f) , _moffatBetaConst(BetaInfo, 4.765f, 0.f, 100.f) , _renderingMethodOption( RenderMethodOptionInfo, properties::OptionProperty::DisplayType::Dropdown ) , _userProvidedTextureOwner(UserProvidedTextureOptionInfo) , _parametersOwner(ParametersOwnerOptionInfo) , _moffatMethodOwner(MoffatMethodOptionInfo) , _fadeInDistances( FadeInDistancesInfo, glm::vec2(0.f), glm::vec2(0.f), glm::vec2(100.f) ) , _disableFadeInDistance(DisableFadeInInfo, true) { using File = ghoul::filesystem::File; const Parameters p = codegen::bake(dictionary); addProperty(_opacity); registerUpdateRenderBinFromOpacity(); _dataMapping.bvColor = p.dataMapping.bv.value_or(""); _dataMapping.bvColor.onChange([this]() { _dataIsDirty = true; }); _dataMappingContainer.addProperty(_dataMapping.bvColor); _dataMapping.luminance = p.dataMapping.luminance.value_or(""); _dataMapping.luminance.onChange([this]() { _dataIsDirty = true; }); _dataMappingContainer.addProperty(_dataMapping.luminance); _dataMapping.absoluteMagnitude = p.dataMapping.absoluteMagnitude.value_or(""); _dataMapping.absoluteMagnitude.onChange([this]() { _dataIsDirty = true; }); _dataMappingContainer.addProperty(_dataMapping.absoluteMagnitude); _dataMapping.apparentMagnitude = p.dataMapping.apparentMagnitude.value_or(""); _dataMapping.apparentMagnitude.onChange([this]() { _dataIsDirty = true; }); _dataMappingContainer.addProperty(_dataMapping.apparentMagnitude); _dataMapping.vx = p.dataMapping.vx.value_or(""); _dataMapping.vx.onChange([this]() { _dataIsDirty = true; }); _dataMappingContainer.addProperty(_dataMapping.vx); _dataMapping.vy = p.dataMapping.vy.value_or(""); _dataMapping.vy.onChange([this]() { _dataIsDirty = true; }); _dataMappingContainer.addProperty(_dataMapping.vy); _dataMapping.vz = p.dataMapping.vz.value_or(""); _dataMapping.vz.onChange([this]() { _dataIsDirty = true; }); _dataMappingContainer.addProperty(_dataMapping.vz); _dataMapping.speed = p.dataMapping.speed.value_or(""); _dataMapping.speed.onChange([this]() { _dataIsDirty = true; }); _dataMappingContainer.addProperty(_dataMapping.speed); addPropertySubOwner(_dataMappingContainer); _speckFile = p.speckFile.string(); _speckFile.onChange([&]() { _speckFileIsDirty = true; }); addProperty(_speckFile); _colorTexturePath = p.colorMap.string(); _colorTextureFile = std::make_unique(_colorTexturePath.value()); //_shapeTexturePath = absPath(dictionary.value( // ShapeTextureInfo.identifier // )); //_shapeTextureFile = std::make_unique(_shapeTexturePath); if (p.otherDataColorMap.has_value()) { _otherDataColorMapPath = absPath(*p.otherDataColorMap).string(); } _fixedColor.setViewOption(properties::Property::ViewOptions::Color, true); addProperty(_fixedColor); _colorOption.addOptions({ { ColorOption::Color, "Color" }, { ColorOption::Velocity, "Velocity" }, { ColorOption::Speed, "Speed" }, { ColorOption::OtherData, "Other Data" }, { ColorOption::FixedColor, "Fixed Color" } }); if (p.colorOption.has_value()) { switch (*p.colorOption) { case Parameters::ColorOption::Color: _colorOption = ColorOption::Color; break; case Parameters::ColorOption::Velocity: _colorOption = ColorOption::Velocity; break; case Parameters::ColorOption::Speed: _colorOption = ColorOption::Speed; break; case Parameters::ColorOption::OtherData: _colorOption = ColorOption::OtherData; break; case Parameters::ColorOption::FixedColor: _colorOption = ColorOption::FixedColor; break; } } _colorOption.onChange([&] { _dataIsDirty = true; }); addProperty(_colorOption); _colorTexturePath.onChange([&] { _colorTextureIsDirty = true; }); _colorTextureFile->setCallback([this]() { _colorTextureIsDirty = true; }); addProperty(_colorTexturePath); _queuedOtherData = p.otherData.value_or(_queuedOtherData); _otherDataOption.onChange([&]() { _dataIsDirty = true; }); addProperty(_otherDataOption); _otherDataRange.setViewOption(properties::Property::ViewOptions::MinMaxRange); addProperty(_otherDataRange); addProperty(_otherDataColorMapPath); _otherDataColorMapPath.onChange([&]() { _otherDataColorMapIsDirty = true; }); _staticFilterValue = p.staticFilter; _staticFilterReplacementValue = p.staticFilterReplacement.value_or(_staticFilterReplacementValue); addProperty(_filterOutOfRange); _renderingMethodOption.addOption( RenderOptionPointSpreadFunction, "Point Spread Function Based" ); _renderingMethodOption.addOption(RenderOptionTexture, "Textured Based"); addProperty(_renderingMethodOption); if (p.renderMethod == Parameters::RenderMethod::PSF) { _renderingMethodOption = RenderOptionPointSpreadFunction; } else { _renderingMethodOption = RenderOptionTexture; } _pointSpreadFunctionTexturePath = absPath(p.texture.string()).string(); _pointSpreadFunctionFile = std::make_unique( _pointSpreadFunctionTexturePath.value() ); _pointSpreadFunctionTexturePath.onChange([this]() { _pointSpreadFunctionTextureIsDirty = true; }); _pointSpreadFunctionFile->setCallback([this]() { _pointSpreadFunctionTextureIsDirty = true; }); _userProvidedTextureOwner.addProperty(_pointSpreadFunctionTexturePath); _psfMethodOption.addOption(PsfMethodSpencer, "Spencer's Function"); _psfMethodOption.addOption(PsfMethodMoffat, "Moffat's Function"); _psfMethodOption = PsfMethodSpencer; _psfMethodOption.onChange([&]() { renderPSFToTexture(); }); _parametersOwner.addProperty(_psfMethodOption); _psfMultiplyOption.addOption(0, "Use Star's Apparent Brightness"); _psfMultiplyOption.addOption(1, "Use Star's Luminosity and Size"); _psfMultiplyOption.addOption(2, "Luminosity, Size, App Brightness"); _psfMultiplyOption.addOption(3, "Absolute Magnitude"); _psfMultiplyOption.addOption(4, "Apparent Magnitude"); _psfMultiplyOption.addOption(5, "Distance Modulus"); if (p.sizeComposition.has_value()) { switch (*p.sizeComposition) { case Parameters::SizeComposition::AppBrightness: _psfMultiplyOption = 0; break; case Parameters::SizeComposition::LumSize: _psfMultiplyOption = 1; break; case Parameters::SizeComposition::LumSizeAppBrightness: _psfMultiplyOption = 2; break; case Parameters::SizeComposition::AbsMagnitude: _psfMultiplyOption = 3; break; case Parameters::SizeComposition::AppMagnitude: _psfMultiplyOption = 4; break; case Parameters::SizeComposition::DistanceModulus: _psfMultiplyOption = 5; break; } } else { _psfMultiplyOption = 5; } _parametersOwner.addProperty(_psfMultiplyOption); _parametersOwner.addProperty(_lumCent); _parametersOwner.addProperty(_radiusCent); _parametersOwner.addProperty(_brightnessCent); _magnitudeExponent = p.magnitudeExponent.value_or(_magnitudeExponent); _parametersOwner.addProperty(_magnitudeExponent); auto renderPsf = [&]() { renderPSFToTexture(); }; _spencerPSFParamOwner.addProperty(_p0Param); _p0Param.onChange(renderPsf); _spencerPSFParamOwner.addProperty(_p1Param); _p1Param.onChange(renderPsf); _spencerPSFParamOwner.addProperty(_p2Param); _p2Param.onChange(renderPsf); _spencerPSFParamOwner.addProperty(_spencerAlphaConst); _spencerAlphaConst.onChange(renderPsf); _moffatPSFParamOwner.addProperty(_FWHMConst); _FWHMConst.onChange(renderPsf); _moffatPSFParamOwner.addProperty(_moffatBetaConst); _moffatBetaConst.onChange(renderPsf); _parametersOwner.addPropertySubOwner(_spencerPSFParamOwner); _parametersOwner.addPropertySubOwner(_moffatPSFParamOwner); addPropertySubOwner(_userProvidedTextureOwner); addPropertySubOwner(_parametersOwner); addPropertySubOwner(_moffatMethodOwner); if (p.fadeInDistances.has_value()) { glm::vec2 v = *p.fadeInDistances; _fadeInDistances = v; _disableFadeInDistance = false; _fadeInDistances.setViewOption(properties::Property::ViewOptions::MinMaxRange); addProperty(_fadeInDistances); addProperty(_disableFadeInDistance); } } RenderableStars::~RenderableStars() {} bool RenderableStars::isReady() const { return _program && _pointSpreadFunctionTexture; } void RenderableStars::initializeGL() { _program = global::renderEngine->buildRenderProgram( "Star", absPath("${MODULE_SPACE}/shaders/star_vs.glsl"), absPath("${MODULE_SPACE}/shaders/star_fs.glsl"), absPath("${MODULE_SPACE}/shaders/star_ge.glsl") ); ghoul::opengl::updateUniformLocations(*_program, _uniformCache, UniformNames); loadData(); // We need to wait until after loading the data until we can see if the requested // data value actually exists or not. Once we determine the index, we no longer // need the value and can clear it if (!_queuedOtherData.empty()) { int idx = _dataset.index(_queuedOtherData); if (idx == -1) { LERROR(fmt::format("Could not find other data column {}", _queuedOtherData)); } else { _otherDataOption = idx; _queuedOtherData.clear(); } } _speckFileIsDirty = false; LDEBUG("Creating Polygon Texture"); glGenVertexArrays(1, &_psfVao); glGenBuffers(1, &_psfVbo); glBindVertexArray(_psfVao); glBindBuffer(GL_ARRAY_BUFFER, _psfVbo); constexpr const std::array VertexData = { //x y s t -1.f, -1.f, 0.f, 0.f, 1.f, 1.f, 1.f, 1.f, -1.f, 1.f, 0.f, 1.f, -1.f, -1.f, 0.f, 0.f, 1.f, -1.f, 1.f, 0.f, 1.f, 1.f, 1.f, 1.f }; glBufferData(GL_ARRAY_BUFFER, sizeof(VertexData), VertexData.data(), GL_STATIC_DRAW); glVertexAttribPointer(0, 4, GL_FLOAT, GL_FALSE, 4 * sizeof(GLfloat), nullptr); glEnableVertexAttribArray(0); glBindVertexArray(0); glGenTextures(1, &_psfTexture); glBindTexture(GL_TEXTURE_2D, _psfTexture); glTexParameteri(GL_TEXTURE_2D, GL_TEXTURE_MIN_FILTER, GL_LINEAR); glTexParameteri(GL_TEXTURE_2D, GL_TEXTURE_MAG_FILTER, GL_LINEAR); glTexParameteri(GL_TEXTURE_2D, GL_TEXTURE_WRAP_S, GL_CLAMP_TO_EDGE); glTexParameteri(GL_TEXTURE_2D, GL_TEXTURE_WRAP_T, GL_CLAMP_TO_EDGE); // Stopped using a buffer object for GL_PIXEL_UNPACK_BUFFER glBindBuffer(GL_PIXEL_UNPACK_BUFFER, 0); glTexImage2D( GL_TEXTURE_2D, 0, GL_RGBA8, PsfTextureSize, PsfTextureSize, 0, GL_RGBA, GL_BYTE, nullptr ); LDEBUG("Creating Convolution Texture"); glGenTextures(1, &_convolvedTexture); glBindTexture(GL_TEXTURE_2D, _convolvedTexture); glTexParameteri(GL_TEXTURE_2D, GL_TEXTURE_MIN_FILTER, GL_LINEAR); glTexParameteri(GL_TEXTURE_2D, GL_TEXTURE_MAG_FILTER, GL_LINEAR); glTexParameteri(GL_TEXTURE_2D, GL_TEXTURE_WRAP_S, GL_CLAMP_TO_EDGE); glTexParameteri(GL_TEXTURE_2D, GL_TEXTURE_WRAP_T, GL_CLAMP_TO_EDGE); // Stopped using a buffer object for GL_PIXEL_UNPACK_BUFFER glBindBuffer(GL_PIXEL_UNPACK_BUFFER, 0); glTexImage2D( GL_TEXTURE_2D, 0, GL_RGBA8, ConvolvedfTextureSize, ConvolvedfTextureSize, 0, GL_RGBA, GL_BYTE, nullptr ); //loadShapeTexture(); loadPSFTexture(); renderPSFToTexture(); } void RenderableStars::deinitializeGL() { glDeleteBuffers(1, &_vbo); _vbo = 0; glDeleteVertexArrays(1, &_vao); _vao = 0; _colorTexture = nullptr; //_shapeTexture = nullptr; if (_program) { global::renderEngine->removeRenderProgram(_program.get()); _program = nullptr; } } void RenderableStars::loadPSFTexture() { _pointSpreadFunctionTexture = nullptr; if (!_pointSpreadFunctionTexturePath.value().empty() && std::filesystem::exists(_pointSpreadFunctionTexturePath.value())) { _pointSpreadFunctionTexture = ghoul::io::TextureReader::ref().loadTexture( absPath(_pointSpreadFunctionTexturePath).string() ); if (_pointSpreadFunctionTexture) { LDEBUG(fmt::format( "Loaded texture from {}", absPath(_pointSpreadFunctionTexturePath) )); _pointSpreadFunctionTexture->uploadTexture(); } _pointSpreadFunctionTexture->setFilter( ghoul::opengl::Texture::FilterMode::AnisotropicMipMap ); _pointSpreadFunctionFile = std::make_unique( _pointSpreadFunctionTexturePath.value() ); _pointSpreadFunctionFile->setCallback( [&]() { _pointSpreadFunctionTextureIsDirty = true; } ); } _pointSpreadFunctionTextureIsDirty = false; } void RenderableStars::renderPSFToTexture() { // Creates the FBO for the calculations GLuint psfFBO; glGenFramebuffers(1, &psfFBO); glBindFramebuffer(GL_FRAMEBUFFER, psfFBO); GLenum drawBuffers[1] = { GL_COLOR_ATTACHMENT0 }; glDrawBuffers(1, drawBuffers); glFramebufferTexture(GL_FRAMEBUFFER, GL_COLOR_ATTACHMENT0, _psfTexture, 0); glViewport(0, 0, PsfTextureSize, PsfTextureSize); glBlendFunc(GL_SRC_ALPHA, GL_ONE_MINUS_SRC_ALPHA); std::unique_ptr program = ghoul::opengl::ProgramObject::Build( "RenderStarPSFToTexture", absPath("${MODULE_SPACE}/shaders/psfToTexture_vs.glsl"), absPath("${MODULE_SPACE}/shaders/psfToTexture_fs.glsl") ); program->activate(); constexpr const std::array Black = { 0.f, 0.f, 0.f, 0.f }; glClearBufferfv(GL_COLOR, 0, Black.data()); program->setUniform("psfMethod", _psfMethodOption.value()); program->setUniform("p0Param", _p0Param); program->setUniform("p1Param", _p1Param); program->setUniform("p2Param", _p2Param); program->setUniform("alphaConst", _spencerAlphaConst); program->setUniform("FWHM", _FWHMConst); program->setUniform("betaConstant", _moffatBetaConst); // Draws psf to texture glBindVertexArray(_psfVao); glDrawArrays(GL_TRIANGLES, 0, 6); glBindVertexArray(0); program->deactivate(); // JCC: Convolution is disabled while FFT is not enabled //// Now convolves with a disc shape for final shape //GLuint convolveFBO; //glGenFramebuffers(1, &convolveFBO); //glBindFramebuffer(GL_FRAMEBUFFER, convolveFBO); //glDrawBuffers(1, drawBuffers); //glFramebufferTexture( // GL_FRAMEBUFFER, // GL_COLOR_ATTACHMENT0, // _convolvedTexture, // 0 //); //glViewport(0, 0, _convolvedfTextureSize, _convolvedfTextureSize); //std::unique_ptr programConvolve = // ghoul::opengl::ProgramObject::Build("ConvolvePSFandStarShape", // absPath("${MODULE_SPACE}/shaders/convolution_vs.glsl"), // absPath("${MODULE_SPACE}/shaders/convolution_fs.glsl") // ); //programConvolve->activate(); //glClearBufferfv(GL_COLOR, 0, black); //ghoul::opengl::TextureUnit psfTextureUnit; //psfTextureUnit.activate(); //glBindTexture(GL_TEXTURE_2D, _psfTexture); //programConvolve->setUniform("psfTexture", psfTextureUnit); // //ghoul::opengl::TextureUnit shapeTextureUnit; //shapeTextureUnit.activate(); //_shapeTexture->bind(); //programConvolve->setUniform("shapeTexture", shapeTextureUnit); //programConvolve->setUniform("psfTextureSize", _psfTextureSize); //programConvolve->setUniform( // "convolvedfTextureSize", // _convolvedfTextureSize //); //// Convolves to texture //glBindVertexArray(_psfVao); //glDrawArrays(GL_TRIANGLES, 0, 6); //glBindVertexArray(0); //programConvolve->deactivate(); //// Restores system state //glBindFramebuffer(GL_FRAMEBUFFER, defaultFBO); //glViewport( // m_viewport[0], // m_viewport[1], // m_viewport[2], // m_viewport[3] //); glDeleteFramebuffers(1, &psfFBO); //glDeleteFramebuffers(1, &convolveFBO); // Restores OpenGL blending state global::renderEngine->openglStateCache().resetBlendState(); } void RenderableStars::render(const RenderData& data, RendererTasks&) { if (_dataset.entries.empty()) { return; } glBlendFunc(GL_SRC_ALPHA, GL_ONE); glDepthMask(false); _program->activate(); glm::dvec3 eyePosition = glm::dvec3( glm::inverse(data.camera.combinedViewMatrix()) * glm::dvec4(0.0, 0.0, 0.0, 1.0) ); _program->setUniform(_uniformCache.eyePosition, eyePosition); glm::dvec3 cameraUp = data.camera.lookUpVectorWorldSpace(); _program->setUniform(_uniformCache.cameraUp, cameraUp); glm::dmat4 modelMatrix = glm::translate(glm::dmat4(1.0), data.modelTransform.translation) * glm::dmat4(data.modelTransform.rotation) * glm::scale(glm::dmat4(1.0), data.modelTransform.scale); glm::dmat4 projectionMatrix = glm::dmat4(data.camera.projectionMatrix()); glm::dmat4 cameraViewProjectionMatrix = projectionMatrix * data.camera.combinedViewMatrix(); _program->setUniform(_uniformCache.modelMatrix, modelMatrix); _program->setUniform( _uniformCache.cameraViewProjectionMatrix, cameraViewProjectionMatrix ); _program->setUniform(_uniformCache.colorOption, _colorOption); _program->setUniform(_uniformCache.magnitudeExponent, _magnitudeExponent); _program->setUniform(_uniformCache.psfParamConf, _psfMultiplyOption.value()); _program->setUniform(_uniformCache.lumCent, _lumCent); _program->setUniform(_uniformCache.radiusCent, _radiusCent); _program->setUniform(_uniformCache.brightnessCent, _brightnessCent); if (_colorOption == ColorOption::FixedColor) { if (_uniformCache.fixedColor == -1) { _uniformCache.fixedColor = _program->uniformLocation("fixedColor"); } _program->setUniform(_uniformCache.fixedColor, _fixedColor); } float fadeInVariable = 1.f; if (!_disableFadeInDistance) { float distCamera = static_cast(glm::length(data.camera.positionVec3())); const glm::vec2 fadeRange = _fadeInDistances; const double a = 1.f / ((fadeRange.y - fadeRange.x) * PARSEC); const double b = -(fadeRange.x / (fadeRange.y - fadeRange.x)); const double funcValue = a * distCamera + b; fadeInVariable *= static_cast(funcValue > 1.f ? 1.f : funcValue); _program->setUniform(_uniformCache.alphaValue, _opacity * fadeInVariable); } else { _program->setUniform(_uniformCache.alphaValue, _opacity); } ghoul::opengl::TextureUnit psfUnit; psfUnit.activate(); if (_renderingMethodOption.value() == 0) { // PSF Based Methods glBindTexture(GL_TEXTURE_2D, _psfTexture);\ // Convolutioned texture //glBindTexture(GL_TEXTURE_2D, _convolvedTexture); } else if (_renderingMethodOption.value() == 1) { // Textured based Method _pointSpreadFunctionTexture->bind(); } _program->setUniform(_uniformCache.psfTexture, psfUnit); ghoul::opengl::TextureUnit colorUnit; if (_colorTexture) { colorUnit.activate(); _colorTexture->bind(); _program->setUniform(_uniformCache.colorTexture, colorUnit); } ghoul::opengl::TextureUnit otherDataUnit; if (_colorOption == ColorOption::OtherData && _otherDataColorMapTexture) { otherDataUnit.activate(); _otherDataColorMapTexture->bind(); _program->setUniform(_uniformCache.otherDataTexture, otherDataUnit); } else { // We need to set the uniform to something, or the shader doesn't work _program->setUniform(_uniformCache.otherDataTexture, colorUnit); } // Same here, if we don't set this value, the rendering disappears even if we don't // use this color mode --- abock 2018-11-19 _program->setUniform(_uniformCache.otherDataRange, _otherDataRange); _program->setUniform(_uniformCache.filterOutOfRange, _filterOutOfRange); glBindVertexArray(_vao); const GLsizei nStars = static_cast(_dataset.entries.size()); glDrawArrays(GL_POINTS, 0, nStars); glBindVertexArray(0); _program->deactivate(); // Restores OpenGL blending state global::renderEngine->openglStateCache().resetBlendState(); global::renderEngine->openglStateCache().resetDepthState(); } void RenderableStars::update(const UpdateData&) { if (_speckFileIsDirty) { loadData(); _speckFileIsDirty = false; _dataIsDirty = true; } if (_dataset.entries.empty()) { return; } if (_dataIsDirty) { const int value = _colorOption; LDEBUG("Regenerating data"); std::vector slice = createDataSlice(ColorOption(value)); if (_vao == 0) { glGenVertexArrays(1, &_vao); } if (_vbo == 0) { glGenBuffers(1, &_vbo); } glBindVertexArray(_vao); glBindBuffer(GL_ARRAY_BUFFER, _vbo); glBufferData( GL_ARRAY_BUFFER, slice.size() * sizeof(GLfloat), slice.data(), GL_STATIC_DRAW ); GLint positionAttrib = _program->attributeLocation("in_position"); // bvLumAbsMagAppMag = bv color, luminosity, abs magnitude and app magnitude GLint bvLumAbsMagAppMagAttrib = _program->attributeLocation( "in_bvLumAbsMagAppMag" ); const size_t nStars = _dataset.entries.size(); const size_t nValues = slice.size() / nStars; GLsizei stride = static_cast(sizeof(GLfloat) * nValues); glEnableVertexAttribArray(positionAttrib); glEnableVertexAttribArray(bvLumAbsMagAppMagAttrib); const int colorOption = _colorOption; switch (colorOption) { case ColorOption::Color: case ColorOption::FixedColor: glVertexAttribPointer( positionAttrib, 3, GL_FLOAT, GL_FALSE, stride, nullptr // = offsetof(ColorVBOLayout, position) ); glVertexAttribPointer( bvLumAbsMagAppMagAttrib, 4, GL_FLOAT, GL_FALSE, stride, reinterpret_cast(offsetof(ColorVBOLayout, value)) ); break; case ColorOption::Velocity: { glVertexAttribPointer( positionAttrib, 3, GL_FLOAT, GL_FALSE, stride, nullptr // = offsetof(VelocityVBOLayout, position) ); glVertexAttribPointer( bvLumAbsMagAppMagAttrib, 4, GL_FLOAT, GL_FALSE, stride, reinterpret_cast(offsetof(VelocityVBOLayout, value)) ); GLint velocityAttrib = _program->attributeLocation("in_velocity"); glEnableVertexAttribArray(velocityAttrib); glVertexAttribPointer( velocityAttrib, 3, GL_FLOAT, GL_TRUE, stride, reinterpret_cast(offsetof(VelocityVBOLayout, vx)) // NOLINT ); break; } case ColorOption::Speed: { glVertexAttribPointer( positionAttrib, 3, GL_FLOAT, GL_FALSE, stride, nullptr // = offsetof(SpeedVBOLayout, position) ); glVertexAttribPointer( bvLumAbsMagAppMagAttrib, 4, GL_FLOAT, GL_FALSE, stride, reinterpret_cast(offsetof(SpeedVBOLayout, value)) ); GLint speedAttrib = _program->attributeLocation("in_speed"); glEnableVertexAttribArray(speedAttrib); glVertexAttribPointer( speedAttrib, 1, GL_FLOAT, GL_TRUE, stride, reinterpret_cast(offsetof(SpeedVBOLayout, speed)) ); break; } case ColorOption::OtherData: { glVertexAttribPointer( positionAttrib, 3, GL_FLOAT, GL_FALSE, stride, nullptr // = offsetof(OtherDataLayout, position) ); glVertexAttribPointer( bvLumAbsMagAppMagAttrib, 4, GL_FLOAT, GL_FALSE, stride, reinterpret_cast(offsetof(OtherDataLayout, value)) // NOLINT ); } } glBindBuffer(GL_ARRAY_BUFFER, 0); glBindVertexArray(0); _dataIsDirty = false; } if (_pointSpreadFunctionTextureIsDirty) { LDEBUG("Reloading Point Spread Function texture"); loadPSFTexture(); } if (_colorTextureIsDirty) { LDEBUG("Reloading Color Texture"); _colorTexture = nullptr; if (_colorTexturePath.value() != "") { _colorTexture = ghoul::io::TextureReader::ref().loadTexture( absPath(_colorTexturePath).string() ); if (_colorTexture) { LDEBUG(fmt::format("Loaded texture from {}", absPath(_colorTexturePath))); _colorTexture->uploadTexture(); } _colorTextureFile = std::make_unique( _colorTexturePath.value() ); _colorTextureFile->setCallback([this]() { _colorTextureIsDirty = true; }); } _colorTextureIsDirty = false; } //loadShapeTexture(); if (_otherDataColorMapIsDirty) { LDEBUG("Reloading Color Texture"); _otherDataColorMapTexture = nullptr; if (!_otherDataColorMapPath.value().empty()) { _otherDataColorMapTexture = ghoul::io::TextureReader::ref().loadTexture( absPath(_otherDataColorMapPath).string() ); if (_otherDataColorMapTexture) { LDEBUG(fmt::format( "Loaded texture from {}", absPath(_otherDataColorMapPath) )); _otherDataColorMapTexture->uploadTexture(); } } _otherDataColorMapIsDirty = false; } if (_program->isDirty()) { _program->rebuildFromFile(); ghoul::opengl::updateUniformLocations(*_program, _uniformCache, UniformNames); } } void RenderableStars::loadData() { std::filesystem::path file = absPath(_speckFile); if (!std::filesystem::is_regular_file(file)) { return; } _dataset = speck::data::loadFileWithCache(file); if (_dataset.entries.empty()) { return; } std::vector variableNames; variableNames.reserve(_dataset.variables.size()); for (const speck::Dataset::Variable& v : _dataset.variables) { variableNames.push_back(v.name); } _otherDataOption.addOptions(variableNames); bool success = _dataset.normalizeVariable("lum"); if (!success) { throw ghoul::RuntimeError("Could not find required variable 'luminosity'"); } } std::vector RenderableStars::createDataSlice(ColorOption option) { const int bvIdx = std::max(_dataset.index(_dataMapping.bvColor.value()), 0); const int lumIdx = std::max(_dataset.index(_dataMapping.luminance.value()), 0); const int absMagIdx = std::max( _dataset.index(_dataMapping.absoluteMagnitude.value()), 0 ); const int appMagIdx = std::max( _dataset.index(_dataMapping.apparentMagnitude.value()), 0 ); const int vxIdx = std::max(_dataset.index(_dataMapping.vx.value()), 0); const int vyIdx = std::max(_dataset.index(_dataMapping.vy.value()), 0); const int vzIdx = std::max(_dataset.index(_dataMapping.vz.value()), 0); const int speedIdx = std::max(_dataset.index(_dataMapping.speed.value()), 0); _otherDataRange = glm::vec2( std::numeric_limits::max(), -std::numeric_limits::max() ); double maxRadius = 0.0; std::vector result; // 7 for the default Color option of 3 positions + bv + lum + abs + app magnitude result.reserve(_dataset.entries.size() * 7); for (const speck::Dataset::Entry& e : _dataset.entries) { glm::dvec3 position = glm::dvec3(e.position) * distanceconstants::Parsec; maxRadius = std::max(maxRadius, glm::length(position)); switch (option) { case ColorOption::Color: case ColorOption::FixedColor: { union { ColorVBOLayout value; std::array data; } layout; layout.value.position = { { static_cast(position[0]), static_cast(position[1]), static_cast(position[2]) }}; layout.value.value = e.data[bvIdx]; layout.value.luminance = e.data[lumIdx]; layout.value.absoluteMagnitude = e.data[absMagIdx]; layout.value.apparentMagnitude = e.data[appMagIdx]; result.insert(result.end(), layout.data.begin(), layout.data.end()); break; } case ColorOption::Velocity: { union { VelocityVBOLayout value; std::array data; } layout; layout.value.position = {{ static_cast(position[0]), static_cast(position[1]), static_cast(position[2]) }}; layout.value.value = e.data[bvIdx]; layout.value.luminance = e.data[lumIdx]; layout.value.absoluteMagnitude = e.data[absMagIdx]; layout.value.apparentMagnitude = e.data[appMagIdx]; layout.value.vx = e.data[vxIdx]; layout.value.vy = e.data[vyIdx]; layout.value.vz = e.data[vzIdx]; result.insert(result.end(), layout.data.begin(), layout.data.end()); break; } case ColorOption::Speed: { union { SpeedVBOLayout value; std::array data; } layout; layout.value.position = {{ static_cast(position[0]), static_cast(position[1]), static_cast(position[2]) }}; layout.value.value = e.data[bvIdx]; layout.value.luminance = e.data[lumIdx]; layout.value.absoluteMagnitude = e.data[absMagIdx]; layout.value.apparentMagnitude = e.data[appMagIdx]; layout.value.speed = e.data[speedIdx]; result.insert(result.end(), layout.data.begin(), layout.data.end()); break; } case ColorOption::OtherData: { union { OtherDataLayout value; std::array data; } layout = {}; layout.value.position = {{ static_cast(position[0]), static_cast(position[1]), static_cast(position[2]) }}; int index = _otherDataOption.value(); // plus 3 because of the position layout.value.value = e.data[index]; if (_staticFilterValue.has_value() && e.data[index] == _staticFilterValue) { layout.value.value = _staticFilterReplacementValue; } glm::vec2 range = _otherDataRange; range.x = std::min(range.x, layout.value.value); range.y = std::max(range.y, layout.value.value); _otherDataRange = range; _otherDataRange.setMinValue(glm::vec2(range.x)); _otherDataRange.setMaxValue(glm::vec2(range.y)); layout.value.luminance = e.data[lumIdx]; layout.value.absoluteMagnitude = e.data[absMagIdx]; layout.value.apparentMagnitude = e.data[appMagIdx]; result.insert(result.end(), layout.data.begin(), layout.data.end()); break; } } } setBoundingSphere(maxRadius); return result; } } // namespace openspace