Files
OpenSpace/modules/exoplanets/exoplanetsmodule.h
Emma Broman 9ea69d6b1a Add option to specify a default texture for added exoplanets (#3353)
* Add possibility to specify a default texture for added exoplanets

* Warn if exoplanet texture does not exists and provide more user friendly warnings

* Address review comments
2024-07-30 09:05:40 +02:00

92 lines
4.6 KiB
C++

/*****************************************************************************************
* *
* OpenSpace *
* *
* Copyright (c) 2014-2024 *
* *
* Permission is hereby granted, free of charge, to any person obtaining a copy of this *
* software and associated documentation files (the "Software"), to deal in the Software *
* without restriction, including without limitation the rights to use, copy, modify, *
* merge, publish, distribute, sublicense, and/or sell copies of the Software, and to *
* permit persons to whom the Software is furnished to do so, subject to the following *
* conditions: *
* *
* The above copyright notice and this permission notice shall be included in all copies *
* or substantial portions of the Software. *
* *
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, *
* INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A *
* PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT *
* HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF *
* CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE *
* OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. *
****************************************************************************************/
#ifndef __OPENSPACE_MODULE_EXOPLANETS___EXOPLANETSMODULE___H__
#define __OPENSPACE_MODULE_EXOPLANETS___EXOPLANETSMODULE___H__
#include <openspace/util/openspacemodule.h>
#include <openspace/documentation/documentation.h>
#include <openspace/properties/scalar/boolproperty.h>
#include <openspace/properties/scalar/floatproperty.h>
#include <openspace/properties/stringproperty.h>
#include <openspace/properties/vector/vec3property.h>
#include <filesystem>
namespace openspace {
class ExoplanetsModule : public OpenSpaceModule {
public:
constexpr static const char* Name = "Exoplanets";
ExoplanetsModule();
~ExoplanetsModule() override = default;
bool hasDataFiles() const;
std::filesystem::path exoplanetsDataPath() const;
std::filesystem::path lookUpTablePath() const;
std::filesystem::path teffToBvConversionFilePath() const;
std::filesystem::path bvColormapPath() const;
std::filesystem::path starTexturePath() const;
std::filesystem::path starGlareTexturePath() const;
std::filesystem::path noDataTexturePath() const;
std::filesystem::path planetDefaultTexturePath() const;
std::filesystem::path orbitDiscTexturePath() const;
std::filesystem::path habitableZoneTexturePath() const;
glm::vec3 comparisonCircleColor() const;
bool showComparisonCircle() const;
bool showOrbitUncertainty() const;
bool showHabitableZone() const;
bool useOptimisticZone() const;
float habitableZoneOpacity() const;
scripting::LuaLibrary luaLibrary() const override;
std::vector<documentation::Documentation> documentations() const override;
protected:
void internalInitialize(const ghoul::Dictionary& dict) override;
properties::BoolProperty _enabled;
properties::StringProperty _exoplanetsDataFolder;
properties::StringProperty _bvColorMapPath;
properties::StringProperty _starTexturePath;
properties::StringProperty _starGlareTexturePath;
properties::StringProperty _noDataTexturePath;
properties::StringProperty _planetDefaultTexturePath;
properties::StringProperty _orbitDiscTexturePath;
properties::StringProperty _habitableZoneTexturePath;
properties::Vec3Property _comparisonCircleColor;
properties::BoolProperty _showComparisonCircle;
properties::BoolProperty _showOrbitUncertainty;
properties::BoolProperty _showHabitableZone;
properties::BoolProperty _useOptimisticZone;
properties::FloatProperty _habitableZoneOpacity;
};
} // namespace openspace
#endif // __OPENSPACE_MODULE_EXOPLANETS___EXOPLANETSMODULE___H__