mirror of
https://github.com/OpenSpace/OpenSpace.git
synced 2026-01-06 11:39:49 -06:00
Sphere maintenance (#2800)
* Split RenderableSphere class into a local and online sphere * Make the video sphere derive from the regular sphere * Make RenderableTimeVaryingSphere derive from RenderableSphere * Some clean up * Address PR comments
This commit is contained in:
@@ -55,6 +55,8 @@ set(HEADER_FILES
|
||||
rendering/renderableplanetimevaryingimage.h
|
||||
rendering/renderableprism.h
|
||||
rendering/renderablesphere.h
|
||||
rendering/renderablesphereimagelocal.h
|
||||
rendering/renderablesphereimageonline.h
|
||||
rendering/renderabletimevaryingsphere.h
|
||||
rendering/renderabletrail.h
|
||||
rendering/renderabletrailorbit.h
|
||||
@@ -111,6 +113,8 @@ set(SOURCE_FILES
|
||||
rendering/renderableplanetimevaryingimage.cpp
|
||||
rendering/renderableprism.cpp
|
||||
rendering/renderablesphere.cpp
|
||||
rendering/renderablesphereimagelocal.cpp
|
||||
rendering/renderablesphereimageonline.cpp
|
||||
rendering/renderabletimevaryingsphere.cpp
|
||||
rendering/renderabletrail.cpp
|
||||
rendering/renderabletrailorbit.cpp
|
||||
|
||||
@@ -48,7 +48,8 @@
|
||||
#include <modules/base/rendering/renderablelabel.h>
|
||||
#include <modules/base/rendering/renderablemodel.h>
|
||||
#include <modules/base/rendering/renderablenodeline.h>
|
||||
#include <modules/base/rendering/renderablesphere.h>
|
||||
#include <modules/base/rendering/renderablesphereimagelocal.h>
|
||||
#include <modules/base/rendering/renderablesphereimageonline.h>
|
||||
#include <modules/base/rendering/renderabletrailorbit.h>
|
||||
#include <modules/base/rendering/renderabletrailtrajectory.h>
|
||||
#include <modules/base/rendering/renderableplaneimagelocal.h>
|
||||
@@ -146,7 +147,8 @@ void BaseModule::internalInitialize(const ghoul::Dictionary&) {
|
||||
"RenderableTimeVaryingSphere"
|
||||
);
|
||||
fRenderable->registerClass<RenderableRadialGrid>("RenderableRadialGrid");
|
||||
fRenderable->registerClass<RenderableSphere>("RenderableSphere");
|
||||
fRenderable->registerClass<RenderableSphereImageLocal>("RenderableSphereImageLocal");
|
||||
fRenderable->registerClass<RenderableSphereImageOnline>("RenderableSphereImageOnline");
|
||||
fRenderable->registerClass<RenderableSphericalGrid>("RenderableSphericalGrid");
|
||||
fRenderable->registerClass<RenderableTrailOrbit>("RenderableTrailOrbit");
|
||||
fRenderable->registerClass<RenderableTrailTrajectory>("RenderableTrailTrajectory");
|
||||
@@ -226,6 +228,8 @@ std::vector<documentation::Documentation> BaseModule::documentations() const {
|
||||
RenderablePrism::Documentation(),
|
||||
RenderableRadialGrid::Documentation(),
|
||||
RenderableSphere::Documentation(),
|
||||
RenderableSphereImageLocal::Documentation(),
|
||||
RenderableSphereImageOnline::Documentation(),
|
||||
RenderableSphericalGrid::Documentation(),
|
||||
RenderableTimeVaryingSphere::Documentation(),
|
||||
RenderableTrailOrbit::Documentation(),
|
||||
|
||||
@@ -31,13 +31,12 @@
|
||||
#include <openspace/rendering/renderengine.h>
|
||||
#include <openspace/util/sphere.h>
|
||||
#include <openspace/util/updatestructures.h>
|
||||
#include <ghoul/glm.h>
|
||||
#include <ghoul/filesystem/filesystem.h>
|
||||
#include <ghoul/glm.h>
|
||||
#include <ghoul/logging/logmanager.h>
|
||||
#include <ghoul/io/texture/texturereader.h>
|
||||
#include <ghoul/opengl/texture.h>
|
||||
#include <ghoul/opengl/textureunit.h>
|
||||
#include <ghoul/opengl/openglstatecache.h>
|
||||
#include <ghoul/opengl/programobject.h>
|
||||
#include <ghoul/opengl/textureunit.h>
|
||||
#include <optional>
|
||||
|
||||
namespace {
|
||||
@@ -46,29 +45,27 @@ namespace {
|
||||
"colorTexture", "mirrorTexture"
|
||||
};
|
||||
|
||||
constexpr openspace::properties::Property::PropertyInfo SizeInfo = {
|
||||
"Size",
|
||||
"Size (in meters)",
|
||||
"This value specifies the radius of the sphere in meters",
|
||||
openspace::properties::Property::Visibility::AdvancedUser
|
||||
};
|
||||
|
||||
constexpr openspace::properties::Property::PropertyInfo SegmentsInfo = {
|
||||
"Segments",
|
||||
"Number of Segments",
|
||||
"This value specifies the number of segments that the sphere is separated in",
|
||||
// @VISIBILITY(2.67)
|
||||
openspace::properties::Property::Visibility::AdvancedUser
|
||||
};
|
||||
|
||||
enum class Orientation : int {
|
||||
Outside = 0,
|
||||
Inside,
|
||||
Both
|
||||
};
|
||||
|
||||
constexpr openspace::properties::Property::PropertyInfo TextureInfo = {
|
||||
"Texture",
|
||||
"Texture",
|
||||
"This value specifies an image that is loaded from disk and is used as a texture "
|
||||
"that is applied to this sphere. This image is expected to be an equirectangular "
|
||||
"projection",
|
||||
// @VISIBILITY(2.33)
|
||||
openspace::properties::Property::Visibility::User
|
||||
};
|
||||
|
||||
constexpr openspace::properties::Property::PropertyInfo MirrorTextureInfo = {
|
||||
"MirrorTexture",
|
||||
"Mirror Texture",
|
||||
"Mirror the texture along the x-axis",
|
||||
openspace::properties::Property::Visibility::User
|
||||
};
|
||||
|
||||
constexpr openspace::properties::Property::PropertyInfo OrientationInfo = {
|
||||
"Orientation",
|
||||
"Orientation",
|
||||
@@ -77,30 +74,20 @@ namespace {
|
||||
openspace::properties::Property::Visibility::AdvancedUser
|
||||
};
|
||||
|
||||
constexpr openspace::properties::Property::PropertyInfo SegmentsInfo = {
|
||||
"Segments",
|
||||
"Number of Segments",
|
||||
"This value specifies the number of segments that the sphere is separated in",
|
||||
// @VISIBILITY(2.67)
|
||||
constexpr openspace::properties::Property::PropertyInfo MirrorTextureInfo = {
|
||||
"MirrorTexture",
|
||||
"Mirror Texture",
|
||||
"Mirror the texture along the x-axis",
|
||||
openspace::properties::Property::Visibility::AdvancedUser
|
||||
};
|
||||
|
||||
constexpr openspace::properties::Property::PropertyInfo DisableFadeInOutInfo = {
|
||||
"DisableFadeInOut",
|
||||
"Disable Fade-In/Fade-Out effects",
|
||||
"Enables/Disables the fade in and out effects",
|
||||
openspace::properties::Property::Visibility::User
|
||||
};
|
||||
|
||||
constexpr openspace::properties::Property::PropertyInfo SizeInfo = {
|
||||
"Size",
|
||||
"Size (in meters)",
|
||||
"This value specifies the radius of the sphere in meters",
|
||||
openspace::properties::Property::Visibility::AdvancedUser
|
||||
};
|
||||
|
||||
constexpr openspace::properties::Property::PropertyInfo FadeOutThresholdInfo = {
|
||||
"FadeOutThreshold",
|
||||
"Fade-Out Threshold",
|
||||
"This value determines percentage of the sphere that is visible before starting "
|
||||
"to fade it out. A negative or zero value means no fading out will happen. This "
|
||||
"is also the default",
|
||||
openspace::properties::Property::Visibility::AdvancedUser
|
||||
};
|
||||
|
||||
constexpr openspace::properties::Property::PropertyInfo FadeInThresholdInfo = {
|
||||
"FadeInThreshold",
|
||||
"Fade-In Threshold",
|
||||
@@ -111,11 +98,13 @@ namespace {
|
||||
openspace::properties::Property::Visibility::AdvancedUser
|
||||
};
|
||||
|
||||
constexpr openspace::properties::Property::PropertyInfo DisableFadeInOutInfo = {
|
||||
"DisableFadeInOut",
|
||||
"Disable Fade-In/Fade-Out effects",
|
||||
"Enables/Disables the fade in and out effects",
|
||||
openspace::properties::Property::Visibility::User
|
||||
constexpr openspace::properties::Property::PropertyInfo FadeOutThresholdInfo = {
|
||||
"FadeOutThreshold",
|
||||
"Fade-Out Threshold",
|
||||
"This value determines percentage of the sphere that is visible before starting "
|
||||
"to fade it out. A negative or zero value means no fading out will happen. This "
|
||||
"is also the default",
|
||||
openspace::properties::Property::Visibility::AdvancedUser
|
||||
};
|
||||
|
||||
struct [[codegen::Dictionary(RenderableSphere)]] Parameters {
|
||||
@@ -125,9 +114,6 @@ namespace {
|
||||
// [[codegen::verbatim(SegmentsInfo.description)]]
|
||||
int segments;
|
||||
|
||||
// [[codegen::verbatim(TextureInfo.description)]]
|
||||
std::string texture;
|
||||
|
||||
enum class [[codegen::map(Orientation)]] Orientation {
|
||||
Outside,
|
||||
Inside,
|
||||
@@ -140,14 +126,14 @@ namespace {
|
||||
// [[codegen::verbatim(MirrorTextureInfo.description)]]
|
||||
std::optional<bool> mirrorTexture;
|
||||
|
||||
// [[codegen::verbatim(FadeOutThresholdInfo.description)]]
|
||||
std::optional<float> fadeOutThreshold [[codegen::inrange(0.0, 1.0)]];
|
||||
// [[codegen::verbatim(DisableFadeInOutInfo.description)]]
|
||||
std::optional<bool> disableFadeInOut;
|
||||
|
||||
// [[codegen::verbatim(FadeInThresholdInfo.description)]]
|
||||
std::optional<float> fadeInThreshold;
|
||||
|
||||
// [[codegen::verbatim(DisableFadeInOutInfo.description)]]
|
||||
std::optional<bool> disableFadeInOut;
|
||||
// [[codegen::verbatim(FadeOutThresholdInfo.description)]]
|
||||
std::optional<float> fadeOutThreshold [[codegen::inrange(0.0, 1.0)]];
|
||||
};
|
||||
#include "renderablesphere_codegen.cpp"
|
||||
} // namespace
|
||||
@@ -160,10 +146,9 @@ documentation::Documentation RenderableSphere::Documentation() {
|
||||
|
||||
RenderableSphere::RenderableSphere(const ghoul::Dictionary& dictionary)
|
||||
: Renderable(dictionary)
|
||||
, _texturePath(TextureInfo)
|
||||
, _orientation(OrientationInfo, properties::OptionProperty::DisplayType::Dropdown)
|
||||
, _size(SizeInfo, 1.f, 0.f, 1e25f)
|
||||
, _segments(SegmentsInfo, 8, 4, 1000)
|
||||
, _orientation(OrientationInfo, properties::OptionProperty::DisplayType::Dropdown)
|
||||
, _mirrorTexture(MirrorTextureInfo, false)
|
||||
, _disableFadeInDistance(DisableFadeInOutInfo, false)
|
||||
, _fadeInThreshold(FadeInThresholdInfo, -1.f, -0.1f, 1.f, 0.001f)
|
||||
@@ -174,23 +159,6 @@ RenderableSphere::RenderableSphere(const ghoul::Dictionary& dictionary)
|
||||
addProperty(Fadeable::_opacity);
|
||||
|
||||
_size = p.size;
|
||||
_segments = p.segments;
|
||||
_texturePath = p.texture;
|
||||
|
||||
_orientation.addOptions({
|
||||
{ static_cast<int>(Orientation::Outside), "Outside" },
|
||||
{ static_cast<int>(Orientation::Inside), "Inside" },
|
||||
{ static_cast<int>(Orientation::Both), "Both" }
|
||||
});
|
||||
|
||||
if (p.orientation.has_value()) {
|
||||
_orientation = static_cast<int>(codegen::map<Orientation>(*p.orientation));
|
||||
}
|
||||
else {
|
||||
_orientation = static_cast<int>(Orientation::Outside);
|
||||
}
|
||||
addProperty(_orientation);
|
||||
|
||||
_size.setExponent(15.f);
|
||||
_size.onChange([this]() {
|
||||
setBoundingSphere(_size);
|
||||
@@ -198,29 +166,39 @@ RenderableSphere::RenderableSphere(const ghoul::Dictionary& dictionary)
|
||||
});
|
||||
addProperty(_size);
|
||||
|
||||
_segments = p.segments;
|
||||
_segments.onChange([this]() {
|
||||
_sphereIsDirty = true;
|
||||
});
|
||||
addProperty(_segments);
|
||||
_segments.onChange([this]() { _sphereIsDirty = true; });
|
||||
|
||||
addProperty(_texturePath);
|
||||
_texturePath.onChange([this]() { loadTexture(); });
|
||||
_orientation.addOptions({
|
||||
{ static_cast<int>(Orientation::Outside), "Outside" },
|
||||
{ static_cast<int>(Orientation::Inside), "Inside" },
|
||||
{ static_cast<int>(Orientation::Both), "Both" }
|
||||
});
|
||||
_orientation = p.orientation.has_value() ?
|
||||
static_cast<int>(codegen::map<Orientation>(*p.orientation)):
|
||||
static_cast<int>(Orientation::Outside);
|
||||
addProperty(_orientation);
|
||||
|
||||
_mirrorTexture = p.mirrorTexture.value_or(_mirrorTexture);
|
||||
addProperty(_mirrorTexture);
|
||||
|
||||
_fadeOutThreshold = p.fadeOutThreshold.value_or(_fadeOutThreshold);
|
||||
addProperty(_fadeOutThreshold);
|
||||
_disableFadeInDistance = p.disableFadeInOut.value_or(_disableFadeInDistance);
|
||||
addProperty(_disableFadeInDistance);
|
||||
|
||||
_fadeInThreshold = p.fadeInThreshold.value_or(_fadeInThreshold);
|
||||
addProperty(_fadeInThreshold);
|
||||
|
||||
_disableFadeInDistance = p.disableFadeInOut.value_or(_disableFadeInDistance);
|
||||
addProperty(_disableFadeInDistance);
|
||||
_fadeOutThreshold = p.fadeOutThreshold.value_or(_fadeOutThreshold);
|
||||
addProperty(_fadeOutThreshold);
|
||||
|
||||
setBoundingSphere(_size);
|
||||
}
|
||||
|
||||
bool RenderableSphere::isReady() const {
|
||||
return _shader && _texture;
|
||||
return _shader != nullptr;
|
||||
}
|
||||
|
||||
void RenderableSphere::initializeGL() {
|
||||
@@ -239,12 +217,10 @@ void RenderableSphere::initializeGL() {
|
||||
);
|
||||
|
||||
ghoul::opengl::updateUniformLocations(*_shader, _uniformCache, UniformNames);
|
||||
|
||||
loadTexture();
|
||||
}
|
||||
|
||||
void RenderableSphere::deinitializeGL() {
|
||||
_texture = nullptr;
|
||||
_sphere = nullptr;
|
||||
|
||||
BaseModule::ProgramObjectManager.release(
|
||||
"Sphere",
|
||||
@@ -252,6 +228,7 @@ void RenderableSphere::deinitializeGL() {
|
||||
global::renderEngine->removeRenderProgram(p);
|
||||
}
|
||||
);
|
||||
|
||||
_shader = nullptr;
|
||||
}
|
||||
|
||||
@@ -366,21 +343,21 @@ void RenderableSphere::render(const RenderData& data, RendererTasks&) {
|
||||
glDisable(GL_CULL_FACE);
|
||||
}
|
||||
|
||||
if (_renderBin == Renderable::RenderBin::PreDeferredTransparent) {
|
||||
if (renderBin() == Renderable::RenderBin::PreDeferredTransparent) {
|
||||
glBlendFunc(GL_SRC_ALPHA, GL_ONE);
|
||||
glDepthMask(false);
|
||||
}
|
||||
|
||||
_sphere->render();
|
||||
|
||||
if (_renderBin == Renderable::RenderBin::PreDeferredTransparent) {
|
||||
glBlendFunc(GL_SRC_ALPHA, GL_ONE_MINUS_SRC_ALPHA);
|
||||
glDepthMask(true);
|
||||
}
|
||||
|
||||
_shader->setIgnoreUniformLocationError(IgnoreError::No);
|
||||
_shader->deactivate();
|
||||
|
||||
// Reset
|
||||
global::renderEngine->openglStateCache().resetBlendState();
|
||||
global::renderEngine->openglStateCache().resetDepthState();
|
||||
unbindTexture();
|
||||
|
||||
if (orientation == Orientation::Inside) {
|
||||
glCullFace(GL_BACK);
|
||||
}
|
||||
@@ -402,28 +379,8 @@ void RenderableSphere::update(const UpdateData&) {
|
||||
}
|
||||
}
|
||||
|
||||
void RenderableSphere::bindTexture() {
|
||||
_texture->bind();
|
||||
}
|
||||
|
||||
void RenderableSphere::unbindTexture() {}
|
||||
|
||||
void RenderableSphere::loadTexture() {
|
||||
if (!_texturePath.value().empty()) {
|
||||
std::unique_ptr<ghoul::opengl::Texture> texture =
|
||||
ghoul::io::TextureReader::ref().loadTexture(_texturePath, 2);
|
||||
|
||||
if (texture) {
|
||||
LDEBUGC(
|
||||
"RenderableSphere",
|
||||
fmt::format("Loaded texture from {}", absPath(_texturePath))
|
||||
);
|
||||
texture->uploadTexture();
|
||||
texture->setFilter(ghoul::opengl::Texture::FilterMode::LinearMipMap);
|
||||
texture->purgeFromRAM();
|
||||
_texture = std::move(texture);
|
||||
}
|
||||
}
|
||||
void RenderableSphere::unbindTexture() {
|
||||
glBindTexture(GL_TEXTURE_2D, 0);
|
||||
}
|
||||
|
||||
} // namespace openspace
|
||||
|
||||
@@ -27,16 +27,10 @@
|
||||
|
||||
#include <openspace/rendering/renderable.h>
|
||||
|
||||
#include <openspace/properties/stringproperty.h>
|
||||
#include <openspace/properties/optionproperty.h>
|
||||
#include <openspace/properties/scalar/intproperty.h>
|
||||
#include <openspace/properties/scalar/floatproperty.h>
|
||||
#include <ghoul/opengl/uniformcache.h>
|
||||
|
||||
namespace ghoul::opengl {
|
||||
class ProgramObject;
|
||||
class Texture;
|
||||
} // namespace ghoul::opengl
|
||||
namespace ghoul::opengl { class ProgramObject; }
|
||||
|
||||
namespace openspace {
|
||||
|
||||
@@ -61,33 +55,27 @@ public:
|
||||
static documentation::Documentation Documentation();
|
||||
|
||||
protected:
|
||||
virtual void bindTexture();
|
||||
virtual void bindTexture() = 0;
|
||||
virtual void unbindTexture();
|
||||
|
||||
private:
|
||||
void loadTexture();
|
||||
|
||||
properties::StringProperty _texturePath;
|
||||
properties::OptionProperty _orientation;
|
||||
|
||||
properties::FloatProperty _size;
|
||||
properties::IntProperty _segments;
|
||||
|
||||
properties::OptionProperty _orientation;
|
||||
properties::BoolProperty _mirrorTexture;
|
||||
properties::BoolProperty _disableFadeInDistance;
|
||||
|
||||
properties::BoolProperty _disableFadeInDistance;
|
||||
properties::FloatProperty _fadeInThreshold;
|
||||
properties::FloatProperty _fadeOutThreshold;
|
||||
|
||||
private:
|
||||
ghoul::opengl::ProgramObject* _shader = nullptr;
|
||||
std::unique_ptr<ghoul::opengl::Texture> _texture;
|
||||
|
||||
std::unique_ptr<Sphere> _sphere;
|
||||
bool _sphereIsDirty = false;
|
||||
|
||||
UniformCache(opacity, modelViewProjection, modelViewTransform, modelViewRotation,
|
||||
colorTexture, mirrorTexture) _uniformCache;
|
||||
|
||||
bool _sphereIsDirty = false;
|
||||
};
|
||||
|
||||
} // namespace openspace
|
||||
|
||||
134
modules/base/rendering/renderablesphereimagelocal.cpp
Normal file
134
modules/base/rendering/renderablesphereimagelocal.cpp
Normal file
@@ -0,0 +1,134 @@
|
||||
/*****************************************************************************************
|
||||
* *
|
||||
* OpenSpace *
|
||||
* *
|
||||
* Copyright (c) 2014-2023 *
|
||||
* *
|
||||
* 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 <modules/base/rendering/renderablesphereimagelocal.h>
|
||||
|
||||
#include <openspace/documentation/documentation.h>
|
||||
#include <openspace/documentation/verifier.h>
|
||||
#include <openspace/util/sphere.h>
|
||||
#include <ghoul/filesystem/filesystem.h>
|
||||
#include <ghoul/io/texture/texturereader.h>
|
||||
#include <ghoul/opengl/texture.h>
|
||||
#include <optional>
|
||||
|
||||
namespace {
|
||||
constexpr openspace::properties::Property::PropertyInfo TextureInfo = {
|
||||
"Texture",
|
||||
"Texture",
|
||||
"This value specifies an image that is loaded from disk and is used as a texture "
|
||||
"that is applied to this sphere. This image is expected to be an equirectangular "
|
||||
"projection",
|
||||
// @VISIBILITY(2.33)
|
||||
openspace::properties::Property::Visibility::User
|
||||
};
|
||||
|
||||
struct [[codegen::Dictionary(RenderableSphere)]] Parameters {
|
||||
// [[codegen::verbatim(TextureInfo.description)]]
|
||||
std::string texture;
|
||||
|
||||
// If this value is set to 'true', the image for this sphere will not be loaded at
|
||||
// startup but rather when the image is shown for the first time. Additionally, if
|
||||
// the sphere is disabled, the image will automatically be unloaded
|
||||
std::optional<bool> lazyLoading;
|
||||
};
|
||||
#include "renderablesphereimagelocal_codegen.cpp"
|
||||
} // namespace
|
||||
|
||||
namespace openspace {
|
||||
|
||||
documentation::Documentation RenderableSphereImageLocal::Documentation() {
|
||||
return codegen::doc<Parameters>("base_renderable_sphere_image_local");
|
||||
}
|
||||
|
||||
RenderableSphereImageLocal::RenderableSphereImageLocal(const ghoul::Dictionary& dictionary)
|
||||
: RenderableSphere(dictionary)
|
||||
, _texturePath(TextureInfo)
|
||||
{
|
||||
const Parameters p = codegen::bake<Parameters>(dictionary);
|
||||
|
||||
_texturePath = p.texture;
|
||||
_texturePath.onChange([this]() {
|
||||
loadTexture();
|
||||
});
|
||||
addProperty(_texturePath);
|
||||
}
|
||||
|
||||
bool RenderableSphereImageLocal::isReady() const {
|
||||
return RenderableSphere::isReady() && _texture;
|
||||
}
|
||||
|
||||
void RenderableSphereImageLocal::initializeGL() {
|
||||
RenderableSphere::initializeGL();
|
||||
|
||||
if (!_isLoadingLazily) {
|
||||
loadTexture();
|
||||
}
|
||||
}
|
||||
|
||||
void RenderableSphereImageLocal::deinitializeGL() {
|
||||
_texture = nullptr;
|
||||
|
||||
RenderableSphere::deinitializeGL();
|
||||
}
|
||||
|
||||
void RenderableSphereImageLocal::update(const UpdateData& data) {
|
||||
RenderableSphere::update(data);
|
||||
|
||||
if (_textureIsDirty) {
|
||||
loadTexture();
|
||||
_textureIsDirty = false;
|
||||
}
|
||||
}
|
||||
|
||||
void RenderableSphereImageLocal::bindTexture() {
|
||||
_texture->bind();
|
||||
}
|
||||
|
||||
void RenderableSphereImageLocal::loadTexture() {
|
||||
if (_texturePath.value().empty()) {
|
||||
return;
|
||||
}
|
||||
|
||||
std::unique_ptr<ghoul::opengl::Texture> texture =
|
||||
ghoul::io::TextureReader::ref().loadTexture(_texturePath, 2);
|
||||
|
||||
if (!texture) {
|
||||
LWARNINGC(
|
||||
"RenderableSphereImageLocal",
|
||||
fmt::format("Could not load texture from {}", absPath(_texturePath))
|
||||
);
|
||||
return;
|
||||
}
|
||||
|
||||
LDEBUGC(
|
||||
"RenderableSphereImageLocal",
|
||||
fmt::format("Loaded texture from {}", absPath(_texturePath))
|
||||
);
|
||||
texture->uploadTexture();
|
||||
texture->setFilter(ghoul::opengl::Texture::FilterMode::LinearMipMap);
|
||||
texture->purgeFromRAM();
|
||||
_texture = std::move(texture);
|
||||
}
|
||||
|
||||
} // namespace openspace
|
||||
67
modules/base/rendering/renderablesphereimagelocal.h
Normal file
67
modules/base/rendering/renderablesphereimagelocal.h
Normal file
@@ -0,0 +1,67 @@
|
||||
/*****************************************************************************************
|
||||
* *
|
||||
* OpenSpace *
|
||||
* *
|
||||
* Copyright (c) 2014-2023 *
|
||||
* *
|
||||
* 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_BASE___RENDERABLESPHEREIMAGELOCAL___H__
|
||||
#define __OPENSPACE_MODULE_BASE___RENDERABLESPHEREIMAGELOCAL___H__
|
||||
|
||||
#include <modules/base/rendering/renderablesphere.h>
|
||||
|
||||
namespace ghoul::opengl { class Texture; }
|
||||
|
||||
namespace openspace {
|
||||
|
||||
struct RenderData;
|
||||
struct UpdateData;
|
||||
|
||||
namespace documentation { struct Documentation; }
|
||||
|
||||
class RenderableSphereImageLocal : public RenderableSphere {
|
||||
public:
|
||||
RenderableSphereImageLocal(const ghoul::Dictionary& dictionary);
|
||||
|
||||
void initializeGL() override;
|
||||
void deinitializeGL() override;
|
||||
|
||||
bool isReady() const override;
|
||||
|
||||
void update(const UpdateData& data) override;
|
||||
|
||||
static documentation::Documentation Documentation();
|
||||
|
||||
protected:
|
||||
void bindTexture() override;
|
||||
|
||||
private:
|
||||
void loadTexture();
|
||||
|
||||
properties::StringProperty _texturePath;
|
||||
|
||||
std::unique_ptr<ghoul::opengl::Texture> _texture;
|
||||
bool _isLoadingLazily = false;
|
||||
bool _textureIsDirty = false;
|
||||
};
|
||||
|
||||
} // namespace openspace
|
||||
|
||||
#endif // __OPENSPACE_MODULE_BASE___RENDERABLESPHEREIMAGELOCAL___H__
|
||||
163
modules/base/rendering/renderablesphereimageonline.cpp
Normal file
163
modules/base/rendering/renderablesphereimageonline.cpp
Normal file
@@ -0,0 +1,163 @@
|
||||
/*****************************************************************************************
|
||||
* *
|
||||
* OpenSpace *
|
||||
* *
|
||||
* Copyright (c) 2014-2023 *
|
||||
* *
|
||||
* 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 <modules/base/rendering/renderablesphereimageonline.h>
|
||||
|
||||
#include <openspace/documentation/documentation.h>
|
||||
#include <openspace/documentation/verifier.h>
|
||||
#include <openspace/engine/globals.h>
|
||||
#include <openspace/util/sphere.h>
|
||||
#include <ghoul/filesystem/filesystem.h>
|
||||
#include <ghoul/io/texture/texturereader.h>
|
||||
#include <ghoul/opengl/texture.h>
|
||||
|
||||
namespace {
|
||||
constexpr openspace::properties::Property::PropertyInfo TextureInfo = {
|
||||
"URL",
|
||||
"Image URL",
|
||||
"Sets the URL of the texture that is displayed on this sphere. If "
|
||||
"this value is changed, the image at the new path will automatically be loaded "
|
||||
"and displayed. This image is expected to be an equirectangular projection",
|
||||
// @VISIBILITY(2.25)
|
||||
openspace::properties::Property::Visibility::User
|
||||
};
|
||||
|
||||
struct [[codegen::Dictionary(RenderableSphere)]] Parameters {
|
||||
// [[codegen::verbatim(TextureInfo.description)]]
|
||||
std::string url [[codegen::key("URL")]];
|
||||
};
|
||||
#include "renderablesphereimageonline_codegen.cpp"
|
||||
} // namespace
|
||||
|
||||
namespace openspace {
|
||||
|
||||
documentation::Documentation RenderableSphereImageOnline::Documentation() {
|
||||
return codegen::doc<Parameters>("base_renderable_sphere_image_online");
|
||||
}
|
||||
|
||||
RenderableSphereImageOnline::RenderableSphereImageOnline(const ghoul::Dictionary& dictionary)
|
||||
: RenderableSphere(dictionary)
|
||||
, _textureUrl(TextureInfo)
|
||||
{
|
||||
const Parameters p = codegen::bake<Parameters>(dictionary);
|
||||
|
||||
_textureUrl = p.url;
|
||||
_textureUrl.onChange([this]() {
|
||||
_textureIsDirty = true;
|
||||
});
|
||||
addProperty(_textureUrl);
|
||||
}
|
||||
|
||||
void RenderableSphereImageOnline::deinitializeGL() {
|
||||
_texture = nullptr;
|
||||
|
||||
RenderableSphere::deinitializeGL();
|
||||
}
|
||||
|
||||
void RenderableSphereImageOnline::update(const UpdateData& data) {
|
||||
RenderableSphere::update(data);
|
||||
|
||||
if (!_textureIsDirty) {
|
||||
return;
|
||||
}
|
||||
|
||||
if (!_imageFuture.valid()) {
|
||||
std::future<DownloadManager::MemoryFile> future = downloadImageToMemory(
|
||||
_textureUrl
|
||||
);
|
||||
if (future.valid()) {
|
||||
_imageFuture = std::move(future);
|
||||
}
|
||||
}
|
||||
|
||||
if (_imageFuture.valid() && DownloadManager::futureReady(_imageFuture)) {
|
||||
DownloadManager::MemoryFile imageFile = _imageFuture.get();
|
||||
|
||||
if (imageFile.corrupted) {
|
||||
LERRORC(
|
||||
"RenderableSphereImageOnline",
|
||||
fmt::format("Error loading image from URL '{}'", _textureUrl)
|
||||
);
|
||||
return;
|
||||
}
|
||||
|
||||
try {
|
||||
std::unique_ptr<ghoul::opengl::Texture> texture =
|
||||
ghoul::io::TextureReader::ref().loadTexture(
|
||||
reinterpret_cast<void*>(imageFile.buffer),
|
||||
imageFile.size,
|
||||
2,
|
||||
imageFile.format
|
||||
);
|
||||
|
||||
if (texture) {
|
||||
// Images don't need to start on 4-byte boundaries, for example if the
|
||||
// image is only RGB
|
||||
glPixelStorei(GL_UNPACK_ALIGNMENT, 1);
|
||||
|
||||
texture->uploadTexture();
|
||||
texture->setFilter(ghoul::opengl::Texture::FilterMode::LinearMipMap);
|
||||
texture->purgeFromRAM();
|
||||
|
||||
_texture = std::move(texture);
|
||||
_textureIsDirty = false;
|
||||
}
|
||||
}
|
||||
catch (const ghoul::io::TextureReader::InvalidLoadException& e) {
|
||||
_textureIsDirty = false;
|
||||
LERRORC(e.component, e.message);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
void RenderableSphereImageOnline::bindTexture() {
|
||||
if (_texture) {
|
||||
_texture->bind();
|
||||
}
|
||||
else {
|
||||
unbindTexture();
|
||||
}
|
||||
}
|
||||
|
||||
std::future<DownloadManager::MemoryFile>
|
||||
RenderableSphereImageOnline::downloadImageToMemory(const std::string& url)
|
||||
{
|
||||
return global::downloadManager->fetchFile(
|
||||
url,
|
||||
[url](const DownloadManager::MemoryFile&) {
|
||||
LDEBUGC(
|
||||
"RenderableSphereImageOnline",
|
||||
fmt::format("Download to memory finished for image '{}'", url)
|
||||
);
|
||||
},
|
||||
[url](const std::string& err) {
|
||||
LDEBUGC(
|
||||
"RenderableSphereImageOnline",
|
||||
fmt::format("Download to memory failed for image '{}': {}", url, err)
|
||||
);
|
||||
}
|
||||
);
|
||||
}
|
||||
|
||||
} // namespace openspace
|
||||
67
modules/base/rendering/renderablesphereimageonline.h
Normal file
67
modules/base/rendering/renderablesphereimageonline.h
Normal file
@@ -0,0 +1,67 @@
|
||||
/*****************************************************************************************
|
||||
* *
|
||||
* OpenSpace *
|
||||
* *
|
||||
* Copyright (c) 2014-2023 *
|
||||
* *
|
||||
* 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_BASE___RENDERABLESPHEREIMAGEONLINE___H__
|
||||
#define __OPENSPACE_MODULE_BASE___RENDERABLESPHEREIMAGEONLINE___H__
|
||||
|
||||
#include <modules/base/rendering/renderablesphere.h>
|
||||
|
||||
#include <openspace/engine/downloadmanager.h>
|
||||
|
||||
namespace ghoul::opengl { class Texture; }
|
||||
|
||||
namespace openspace {
|
||||
|
||||
struct RenderData;
|
||||
struct UpdateData;
|
||||
|
||||
namespace documentation { struct Documentation; }
|
||||
|
||||
class RenderableSphereImageOnline : public RenderableSphere {
|
||||
public:
|
||||
RenderableSphereImageOnline(const ghoul::Dictionary& dictionary);
|
||||
|
||||
void deinitializeGL() override;
|
||||
|
||||
void update(const UpdateData& data) override;
|
||||
|
||||
static documentation::Documentation Documentation();
|
||||
|
||||
protected:
|
||||
void bindTexture() override;
|
||||
|
||||
private:
|
||||
std::future<DownloadManager::MemoryFile> downloadImageToMemory(
|
||||
const std::string& url);
|
||||
|
||||
properties::StringProperty _textureUrl;
|
||||
|
||||
std::future<DownloadManager::MemoryFile> _imageFuture;
|
||||
std::unique_ptr<ghoul::opengl::Texture> _texture;
|
||||
bool _textureIsDirty = false;
|
||||
};
|
||||
|
||||
} // namespace openspace
|
||||
|
||||
#endif // __OPENSPACE_MODULE_BASE___RENDERABLESPHEREIMAGEONLINE___H__
|
||||
@@ -24,35 +24,31 @@
|
||||
|
||||
#include <modules/base/rendering/renderabletimevaryingsphere.h>
|
||||
|
||||
#include <modules/base/basemodule.h>
|
||||
#include <openspace/documentation/documentation.h>
|
||||
#include <openspace/documentation/verifier.h>
|
||||
#include <openspace/engine/globals.h>
|
||||
#include <openspace/rendering/renderengine.h>
|
||||
#include <openspace/util/sphere.h>
|
||||
#include <openspace/util/updatestructures.h>
|
||||
#include <ghoul/filesystem/filesystem.h>
|
||||
#include <ghoul/glm.h>
|
||||
#include <ghoul/io/texture/texturereader.h>
|
||||
#include <ghoul/logging/logmanager.h>
|
||||
#include <ghoul/misc/crc32.h>
|
||||
#include <ghoul/opengl/texture.h>
|
||||
#include <ghoul/opengl/textureunit.h>
|
||||
#include <ghoul/opengl/programobject.h>
|
||||
#include <filesystem>
|
||||
#include <optional>
|
||||
|
||||
namespace {
|
||||
constexpr std::array<const char*, 5> UniformNames = {
|
||||
"opacity", "modelViewProjection", "modelViewRotation", "colorTexture",
|
||||
"mirrorTexture"
|
||||
};
|
||||
// Extract J2000 time from file names
|
||||
// Requires files to be named as such: 'YYYY-MM-DDTHH-MM-SS-XXX.png'
|
||||
double extractTriggerTimeFromFileName(const std::string& filePath) {
|
||||
// Extract the filename from the path (without extension)
|
||||
std::string timeString = std::filesystem::path(filePath).stem().string();
|
||||
|
||||
enum class Orientation {
|
||||
Outside = 0,
|
||||
Inside,
|
||||
Both
|
||||
};
|
||||
// Ensure the separators are correct
|
||||
timeString.replace(4, 1, "-");
|
||||
timeString.replace(7, 1, "-");
|
||||
timeString.replace(13, 1, ":");
|
||||
timeString.replace(16, 1, ":");
|
||||
timeString.replace(19, 1, ".");
|
||||
|
||||
return openspace::Time::convertTime(timeString);
|
||||
}
|
||||
|
||||
constexpr openspace::properties::Property::PropertyInfo TextureSourceInfo = {
|
||||
"TextureSource",
|
||||
@@ -63,185 +59,36 @@ namespace {
|
||||
openspace::properties::Property::Visibility::AdvancedUser
|
||||
};
|
||||
|
||||
constexpr openspace::properties::Property::PropertyInfo MirrorTextureInfo = {
|
||||
"MirrorTexture",
|
||||
"Mirror Texture",
|
||||
"Mirror the texture along the x-axis",
|
||||
openspace::properties::Property::Visibility::User
|
||||
};
|
||||
|
||||
constexpr openspace::properties::Property::PropertyInfo OrientationInfo = {
|
||||
"Orientation",
|
||||
"Orientation",
|
||||
"Specifies whether the texture is applied to the inside of the sphere, the "
|
||||
"outside of the sphere, or both",
|
||||
openspace::properties::Property::Visibility::AdvancedUser
|
||||
};
|
||||
|
||||
constexpr openspace::properties::Property::PropertyInfo SegmentsInfo = {
|
||||
"Segments",
|
||||
"Number of Segments",
|
||||
"This value specifies the number of segments that the sphere is separated in",
|
||||
// @VISIBILITY(2.67)
|
||||
openspace::properties::Property::Visibility::User
|
||||
};
|
||||
|
||||
constexpr openspace::properties::Property::PropertyInfo SizeInfo = {
|
||||
"Size",
|
||||
"Size (in meters)",
|
||||
"This value specifies the radius of the sphere in meters",
|
||||
openspace::properties::Property::Visibility::AdvancedUser
|
||||
};
|
||||
|
||||
constexpr openspace::properties::Property::PropertyInfo FadeOutThresholdInfo = {
|
||||
"FadeOutThreshold",
|
||||
"Fade-Out Threshold",
|
||||
"This value determines percentage of the sphere is visible before starting "
|
||||
"fading-out it",
|
||||
openspace::properties::Property::Visibility::AdvancedUser
|
||||
};
|
||||
|
||||
constexpr openspace::properties::Property::PropertyInfo FadeInThresholdInfo = {
|
||||
"FadeInThreshold",
|
||||
"Fade-In Threshold",
|
||||
"Distance from center of MilkyWay from where the astronomical object starts to "
|
||||
"fade in",
|
||||
openspace::properties::Property::Visibility::AdvancedUser
|
||||
};
|
||||
|
||||
constexpr openspace::properties::Property::PropertyInfo DisableFadeInOutInfo = {
|
||||
"DisableFadeInOut",
|
||||
"Disable Fade-In/Fade-Out effects",
|
||||
"Enables/Disables the Fade-In/Out effects",
|
||||
// @VISIBILITY(2.33)
|
||||
openspace::properties::Property::Visibility::User
|
||||
};
|
||||
|
||||
struct [[codegen::Dictionary(RenderableTimeVaryingSphere)]] Parameters {
|
||||
// [[codegen::verbatim(SizeInfo.description)]]
|
||||
float size;
|
||||
|
||||
// [[codegen::verbatim(SegmentsInfo.description)]]
|
||||
int segments;
|
||||
|
||||
// [[codegen::verbatim(TextureSourceInfo.description)]]
|
||||
std::string textureSource;
|
||||
|
||||
enum class [[codegen::map(Orientation)]] Orientation {
|
||||
Outside,
|
||||
Inside,
|
||||
Both
|
||||
};
|
||||
|
||||
// [[codegen::verbatim(OrientationInfo.description)]]
|
||||
std::optional<Orientation> orientation;
|
||||
|
||||
// [[codegen::verbatim(MirrorTextureInfo.description)]]
|
||||
std::optional<bool> mirrorTexture;
|
||||
|
||||
// [[codegen::verbatim(FadeOutThresholdInfo.description)]]
|
||||
std::optional<float> fadeOutThreshold [[codegen::inrange(0.0, 1.0)]];
|
||||
|
||||
// [[codegen::verbatim(FadeInThresholdInfo.description)]]
|
||||
std::optional<float> fadeInThreshold;
|
||||
|
||||
// [[codegen::verbatim(DisableFadeInOutInfo.description)]]
|
||||
std::optional<bool> disableFadeInOut;
|
||||
};
|
||||
#include "renderabletimevaryingsphere_codegen.cpp"
|
||||
} // namespace
|
||||
|
||||
namespace openspace {
|
||||
|
||||
double extractTriggerTimeFromFileName(const std::string& filePath);
|
||||
|
||||
documentation::Documentation RenderableTimeVaryingSphere::Documentation() {
|
||||
return codegen::doc<Parameters>("base_renderable_time_varying_sphere");
|
||||
}
|
||||
|
||||
RenderableTimeVaryingSphere::RenderableTimeVaryingSphere(
|
||||
const ghoul::Dictionary& dictionary)
|
||||
: Renderable(dictionary)
|
||||
: RenderableSphere(dictionary)
|
||||
, _textureSourcePath(TextureSourceInfo)
|
||||
, _orientation(OrientationInfo, properties::OptionProperty::DisplayType::Dropdown)
|
||||
, _size(SizeInfo, 1.f, 0.f, 1e35f)
|
||||
, _segments(SegmentsInfo, 8, 4, 1000)
|
||||
, _mirrorTexture(MirrorTextureInfo, false)
|
||||
, _disableFadeInDistance(DisableFadeInOutInfo, true)
|
||||
, _fadeInThreshold(FadeInThresholdInfo, -1.f, -1.f, 1.f)
|
||||
, _fadeOutThreshold(FadeOutThresholdInfo, -1.f, -1.f, 1.f)
|
||||
{
|
||||
const Parameters p = codegen::bake<Parameters>(dictionary);
|
||||
|
||||
addProperty(Fadeable::_opacity);
|
||||
|
||||
_size = p.size;
|
||||
_segments = p.segments;
|
||||
_textureSourcePath = p.textureSource;
|
||||
|
||||
_orientation.addOptions({
|
||||
{ static_cast<int>(Orientation::Outside), "Outside" },
|
||||
{ static_cast<int>(Orientation::Inside), "Inside" },
|
||||
{ static_cast<int>(Orientation::Both), "Both" }
|
||||
});
|
||||
|
||||
if (p.orientation.has_value()) {
|
||||
_orientation = static_cast<int>(codegen::map<Orientation>(*p.orientation));
|
||||
}
|
||||
else {
|
||||
_orientation = static_cast<int>(Orientation::Outside);
|
||||
}
|
||||
addProperty(_orientation);
|
||||
|
||||
_size.setExponent(20.f);
|
||||
_size.onChange([this]() {
|
||||
setBoundingSphere(_size);
|
||||
_sphereIsDirty = true;
|
||||
});
|
||||
addProperty(_size);
|
||||
|
||||
addProperty(_segments);
|
||||
_segments.onChange([this]() { _sphereIsDirty = true; });
|
||||
|
||||
addProperty(_mirrorTexture);
|
||||
addProperty(_fadeOutThreshold);
|
||||
addProperty(_fadeInThreshold);
|
||||
|
||||
_mirrorTexture = p.mirrorTexture.value_or(_mirrorTexture);
|
||||
_fadeOutThreshold = p.fadeOutThreshold.value_or(_fadeOutThreshold);
|
||||
_fadeInThreshold = p.fadeInThreshold.value_or(_fadeInThreshold);
|
||||
|
||||
if (_fadeOutThreshold || _fadeInThreshold) {
|
||||
_disableFadeInDistance = false;
|
||||
addProperty(_disableFadeInDistance);
|
||||
}
|
||||
|
||||
setBoundingSphere(_size);
|
||||
}
|
||||
|
||||
bool RenderableTimeVaryingSphere::isReady() const {
|
||||
return _shader && _texture;
|
||||
return RenderableSphere::isReady() && _texture;
|
||||
}
|
||||
|
||||
void RenderableTimeVaryingSphere::initializeGL() {
|
||||
_sphere = std::make_unique<Sphere>(_size, _segments);
|
||||
_sphere->initialize();
|
||||
RenderableSphere::initializeGL();
|
||||
|
||||
_shader = BaseModule::ProgramObjectManager.request(
|
||||
"Timevarying Sphere",
|
||||
[]() -> std::unique_ptr<ghoul::opengl::ProgramObject> {
|
||||
return global::renderEngine->buildRenderProgram(
|
||||
"Timevarying Sphere",
|
||||
absPath("${MODULE_BASE}/shaders/sphere_vs.glsl"),
|
||||
absPath("${MODULE_BASE}/shaders/sphere_fs.glsl")
|
||||
);
|
||||
}
|
||||
);
|
||||
_shader->setIgnoreUniformLocationError(
|
||||
ghoul::opengl::ProgramObject::IgnoreError::Yes
|
||||
);
|
||||
|
||||
ghoul::opengl::updateUniformLocations(*_shader, _uniformCache, UniformNames);
|
||||
extractMandatoryInfoFromSourceFolder();
|
||||
computeSequenceEndTime();
|
||||
loadTexture();
|
||||
@@ -249,134 +96,9 @@ void RenderableTimeVaryingSphere::initializeGL() {
|
||||
|
||||
void RenderableTimeVaryingSphere::deinitializeGL() {
|
||||
_texture = nullptr;
|
||||
|
||||
BaseModule::ProgramObjectManager.release(
|
||||
"Timevarying Sphere",
|
||||
[](ghoul::opengl::ProgramObject* p) {
|
||||
global::renderEngine->removeRenderProgram(p);
|
||||
}
|
||||
);
|
||||
_files.clear();
|
||||
_shader = nullptr;
|
||||
}
|
||||
|
||||
void RenderableTimeVaryingSphere::render(const RenderData& data, RendererTasks&) {
|
||||
Orientation orientation = static_cast<Orientation>(_orientation.value());
|
||||
|
||||
glm::dmat4 modelTransform =
|
||||
glm::translate(glm::dmat4(1.0), data.modelTransform.translation) *
|
||||
glm::dmat4(data.modelTransform.rotation) *
|
||||
glm::scale(glm::dmat4(1.0), glm::dvec3(data.modelTransform.scale));
|
||||
|
||||
glm::dmat3 modelRotation = data.modelTransform.rotation;
|
||||
|
||||
_shader->activate();
|
||||
|
||||
glm::mat4 modelViewProjection = data.camera.projectionMatrix() *
|
||||
glm::mat4(data.camera.combinedViewMatrix() * modelTransform);
|
||||
_shader->setUniform(_uniformCache.modelViewProjection, modelViewProjection);
|
||||
|
||||
glm::mat3 modelViewRotation = glm::mat3(
|
||||
glm::dmat3(data.camera.viewRotationMatrix()) * modelRotation
|
||||
);
|
||||
_shader->setUniform(_uniformCache.modelViewRotation, modelViewRotation);
|
||||
|
||||
float adjustedOpacity = opacity();
|
||||
|
||||
if (!_disableFadeInDistance) {
|
||||
if (_fadeInThreshold > -1.0) {
|
||||
const float logDistCamera = glm::log(static_cast<float>(
|
||||
glm::distance(data.camera.positionVec3(), data.modelTransform.translation)
|
||||
));
|
||||
const float startLogFadeDistance = glm::log(_size * _fadeInThreshold);
|
||||
const float stopLogFadeDistance = startLogFadeDistance + 1.f;
|
||||
|
||||
if (logDistCamera > startLogFadeDistance &&
|
||||
logDistCamera < stopLogFadeDistance)
|
||||
{
|
||||
const float fadeFactor = glm::clamp(
|
||||
(logDistCamera - startLogFadeDistance) /
|
||||
(stopLogFadeDistance - startLogFadeDistance),
|
||||
0.f,
|
||||
1.f
|
||||
);
|
||||
adjustedOpacity *= fadeFactor;
|
||||
}
|
||||
else if (logDistCamera <= startLogFadeDistance) {
|
||||
adjustedOpacity = 0.f;
|
||||
}
|
||||
}
|
||||
|
||||
if (_fadeOutThreshold > -1.0) {
|
||||
const float logDistCamera = glm::log(static_cast<float>(
|
||||
glm::distance(data.camera.positionVec3(), data.modelTransform.translation)
|
||||
));
|
||||
const float startLogFadeDistance = glm::log(_size * _fadeOutThreshold);
|
||||
const float stopLogFadeDistance = startLogFadeDistance + 1.f;
|
||||
|
||||
if (logDistCamera > startLogFadeDistance &&
|
||||
logDistCamera < stopLogFadeDistance)
|
||||
{
|
||||
const float fadeFactor = glm::clamp(
|
||||
(logDistCamera - startLogFadeDistance) /
|
||||
(stopLogFadeDistance - startLogFadeDistance),
|
||||
0.f,
|
||||
1.f
|
||||
);
|
||||
adjustedOpacity *= (1.f - fadeFactor);
|
||||
}
|
||||
else if (logDistCamera >= stopLogFadeDistance) {
|
||||
adjustedOpacity = 0.f;
|
||||
}
|
||||
}
|
||||
}
|
||||
// Performance wise
|
||||
if (adjustedOpacity < 0.01f) {
|
||||
return;
|
||||
}
|
||||
|
||||
_shader->setUniform(_uniformCache.opacity, adjustedOpacity);
|
||||
_shader->setUniform(_uniformCache._mirrorTexture, _mirrorTexture);
|
||||
|
||||
ghoul::opengl::TextureUnit unit;
|
||||
unit.activate();
|
||||
_texture->bind();
|
||||
_shader->setUniform(_uniformCache.colorTexture, unit);
|
||||
|
||||
// Setting these states should not be necessary,
|
||||
// since they are the default state in OpenSpace.
|
||||
glEnable(GL_CULL_FACE);
|
||||
glCullFace(GL_BACK);
|
||||
|
||||
if (orientation == Orientation::Inside) {
|
||||
glCullFace(GL_FRONT);
|
||||
}
|
||||
else if (orientation == Orientation::Both) {
|
||||
glDisable(GL_CULL_FACE);
|
||||
}
|
||||
|
||||
if (_renderBin == Renderable::RenderBin::PreDeferredTransparent) {
|
||||
glBlendFunc(GL_SRC_ALPHA, GL_ONE);
|
||||
glDepthMask(false);
|
||||
}
|
||||
|
||||
_sphere->render();
|
||||
|
||||
if (_renderBin == Renderable::RenderBin::PreDeferredTransparent) {
|
||||
glBlendFunc(GL_SRC_ALPHA, GL_ONE_MINUS_SRC_ALPHA);
|
||||
glDepthMask(true);
|
||||
}
|
||||
|
||||
_shader->setIgnoreUniformLocationError(ghoul::opengl::ProgramObject::IgnoreError::No);
|
||||
_shader->deactivate();
|
||||
|
||||
if (orientation == Orientation::Inside) {
|
||||
glCullFace(GL_BACK);
|
||||
}
|
||||
else if (orientation == Orientation::Both) {
|
||||
glEnable(GL_CULL_FACE);
|
||||
}
|
||||
glDisable(GL_CULL_FACE);
|
||||
RenderableSphere::deinitializeGL();
|
||||
}
|
||||
|
||||
void RenderableTimeVaryingSphere::extractMandatoryInfoFromSourceFolder() {
|
||||
@@ -386,7 +108,7 @@ void RenderableTimeVaryingSphere::extractMandatoryInfoFromSourceFolder() {
|
||||
fs::path sourceFolder = absPath(_textureSourcePath);
|
||||
if (!std::filesystem::is_directory(sourceFolder)) {
|
||||
throw ghoul::RuntimeError(
|
||||
"Source folder for timevaryingsphere is not a valid directory"
|
||||
"Source folder for RenderableTimeVaryingSphere is not a valid directory"
|
||||
);
|
||||
}
|
||||
// Extract all file paths from the provided folder
|
||||
@@ -410,7 +132,8 @@ void RenderableTimeVaryingSphere::extractMandatoryInfoFromSourceFolder() {
|
||||
}
|
||||
|
||||
std::sort(
|
||||
_files.begin(), _files.end(),
|
||||
_files.begin(),
|
||||
_files.end(),
|
||||
[](const FileData& a, const FileData& b) {
|
||||
return a.time < b.time;
|
||||
}
|
||||
@@ -418,19 +141,14 @@ void RenderableTimeVaryingSphere::extractMandatoryInfoFromSourceFolder() {
|
||||
// Ensure that there are available and valid source files left
|
||||
if (_files.empty()) {
|
||||
throw ghoul::RuntimeError(
|
||||
"Source folder for timevaryingsphere contains no files"
|
||||
"Source folder for RenderableTimeVaryingSphere contains no files"
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
void RenderableTimeVaryingSphere::update(const UpdateData& data) {
|
||||
if (!_enabled) {
|
||||
return;
|
||||
}
|
||||
if (_shader->isDirty()) {
|
||||
_shader->rebuildFromFile();
|
||||
ghoul::opengl::updateUniformLocations(*_shader, _uniformCache, UniformNames);
|
||||
}
|
||||
RenderableSphere::update(data);
|
||||
|
||||
const double currentTime = data.time.j2000Seconds();
|
||||
const bool isInInterval = (currentTime >= _files[0].time) &&
|
||||
(currentTime < _sequenceEndTime);
|
||||
@@ -443,40 +161,33 @@ void RenderableTimeVaryingSphere::update(const UpdateData& data) {
|
||||
(nextIdx < _files.size() && currentTime >= _files[nextIdx].time))
|
||||
{
|
||||
updateActiveTriggerTimeIndex(currentTime);
|
||||
_sphereIsDirty = true;
|
||||
_textureIsDirty = true;
|
||||
} // else {we're still in same state as previous frame (no changes needed)}
|
||||
}
|
||||
else {
|
||||
// not in interval => set everything to false
|
||||
_activeTriggerTimeIndex = 0;
|
||||
}
|
||||
if (_sphereIsDirty) {
|
||||
_sphere = std::make_unique<Sphere>(_size, _segments);
|
||||
_sphere->initialize();
|
||||
if (_textureIsDirty) {
|
||||
loadTexture();
|
||||
_sphereIsDirty = false;
|
||||
_textureIsDirty = false;
|
||||
}
|
||||
}
|
||||
|
||||
// Extract J2000 time from file names
|
||||
// Requires files to be named as such: 'YYYY-MM-DDTHH-MM-SS-XXX.png'
|
||||
double extractTriggerTimeFromFileName(const std::string& filePath) {
|
||||
// Extract the filename from the path (without extension)
|
||||
std::string timeString = std::filesystem::path(filePath).stem().string();
|
||||
|
||||
// Ensure the separators are correct
|
||||
timeString.replace(4, 1, "-");
|
||||
timeString.replace(7, 1, "-");
|
||||
timeString.replace(13, 1, ":");
|
||||
timeString.replace(16, 1, ":");
|
||||
timeString.replace(19, 1, ".");
|
||||
|
||||
return Time::convertTime(timeString);
|
||||
void RenderableTimeVaryingSphere::bindTexture() {
|
||||
if (_texture) {
|
||||
_texture->bind();
|
||||
}
|
||||
else {
|
||||
unbindTexture();
|
||||
}
|
||||
}
|
||||
|
||||
void RenderableTimeVaryingSphere::updateActiveTriggerTimeIndex(double currentTime) {
|
||||
auto iter = std::upper_bound(
|
||||
_files.begin(), _files.end(), currentTime,
|
||||
_files.begin(),
|
||||
_files.end(),
|
||||
currentTime,
|
||||
[](double value, const FileData& f) {
|
||||
return value < f.time;
|
||||
}
|
||||
@@ -499,8 +210,8 @@ void RenderableTimeVaryingSphere::computeSequenceEndTime() {
|
||||
if (_files.size() > 1) {
|
||||
const double lastTriggerTime = _files[_files.size() - 1].time;
|
||||
const double sequenceDuration = lastTriggerTime - _files[0].time;
|
||||
const double averageStateDuration = sequenceDuration /
|
||||
(static_cast<double>(_files.size()) - 1.0);
|
||||
const double averageStateDuration =
|
||||
sequenceDuration / (static_cast<double>(_files.size()) - 1.0);
|
||||
_sequenceEndTime = lastTriggerTime + averageStateDuration;
|
||||
}
|
||||
}
|
||||
@@ -510,4 +221,5 @@ void RenderableTimeVaryingSphere::loadTexture() {
|
||||
_texture = _files[_activeTriggerTimeIndex].texture.get();
|
||||
}
|
||||
}
|
||||
|
||||
} // namespace openspace
|
||||
|
||||
@@ -25,28 +25,18 @@
|
||||
#ifndef __OPENSPACE_MODULE_BASE___RENDERABLETIMEVARYINGSPHERE___H__
|
||||
#define __OPENSPACE_MODULE_BASE___RENDERABLETIMEVARYINGSPHERE___H__
|
||||
|
||||
#include <openspace/rendering/renderable.h>
|
||||
#include <modules/base/rendering/renderablesphere.h>
|
||||
|
||||
#include <openspace/properties/stringproperty.h>
|
||||
#include <openspace/properties/optionproperty.h>
|
||||
#include <openspace/properties/scalar/intproperty.h>
|
||||
#include <openspace/properties/scalar/floatproperty.h>
|
||||
#include <ghoul/opengl/uniformcache.h>
|
||||
|
||||
namespace ghoul::opengl {
|
||||
class ProgramObject;
|
||||
class Texture;
|
||||
} // namespace ghoul::opengl
|
||||
namespace ghoul::opengl { class Texture; }
|
||||
|
||||
namespace openspace {
|
||||
|
||||
class Sphere;
|
||||
struct RenderData;
|
||||
struct UpdateData;
|
||||
|
||||
namespace documentation { struct Documentation; }
|
||||
|
||||
class RenderableTimeVaryingSphere : public Renderable {
|
||||
class RenderableTimeVaryingSphere : public RenderableSphere {
|
||||
public:
|
||||
RenderableTimeVaryingSphere(const ghoul::Dictionary& dictionary);
|
||||
|
||||
@@ -55,11 +45,13 @@ public:
|
||||
|
||||
bool isReady() const override;
|
||||
|
||||
void render(const RenderData& data, RendererTasks& rendererTask) override;
|
||||
void update(const UpdateData& data) override;
|
||||
|
||||
static documentation::Documentation Documentation();
|
||||
|
||||
protected:
|
||||
void bindTexture() override;
|
||||
|
||||
private:
|
||||
struct FileData {
|
||||
std::string path;
|
||||
@@ -77,25 +69,8 @@ private:
|
||||
int _activeTriggerTimeIndex = 0;
|
||||
|
||||
properties::StringProperty _textureSourcePath;
|
||||
properties::OptionProperty _orientation;
|
||||
|
||||
properties::FloatProperty _size;
|
||||
properties::IntProperty _segments;
|
||||
|
||||
properties::BoolProperty _mirrorTexture;
|
||||
properties::BoolProperty _disableFadeInDistance;
|
||||
|
||||
properties::FloatProperty _fadeInThreshold;
|
||||
properties::FloatProperty _fadeOutThreshold;
|
||||
|
||||
ghoul::opengl::ProgramObject* _shader = nullptr;
|
||||
ghoul::opengl::Texture* _texture = nullptr;
|
||||
std::unique_ptr<Sphere> _sphere;
|
||||
|
||||
UniformCache(opacity, modelViewProjection, modelViewRotation, colorTexture,
|
||||
_mirrorTexture) _uniformCache;
|
||||
|
||||
bool _sphereIsDirty = false;
|
||||
bool _textureIsDirty = false;
|
||||
};
|
||||
|
||||
} // namespace openspace
|
||||
|
||||
Reference in New Issue
Block a user