mirror of
https://github.com/OpenSpace/OpenSpace.git
synced 2026-01-07 20:21:24 -06:00
8a30dc570e
* Pass ViewOptions meta data to WebUi * Add Color ViewOption * Add Logarithmic ViewOption * Update gui hash to get slider and color picker UI features
386 lines
12 KiB
C++
386 lines
12 KiB
C++
/*****************************************************************************************
|
|
* *
|
|
* 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 <openspace/properties/property.h>
|
|
#include <openspace/properties/propertyowner.h>
|
|
#include <ghoul/logging/logmanager.h>
|
|
#include <ghoul/lua/ghoul_lua.h>
|
|
#include <ghoul/misc/dictionaryjsonformatter.h>
|
|
#include <algorithm>
|
|
|
|
namespace {
|
|
constexpr const char* MetaDataKeyGroup = "Group";
|
|
constexpr const char* MetaDataKeyReadOnly = "isReadOnly";
|
|
constexpr const char* MetaDataKeyViewOptions = "ViewOptions";
|
|
constexpr const char* MetaDataKeyVisibility = "Visibility";
|
|
|
|
} // namespace
|
|
|
|
namespace openspace::properties {
|
|
|
|
Property::OnChangeHandle Property::OnChangeHandleAll =
|
|
std::numeric_limits<OnChangeHandle>::max();
|
|
|
|
const char* Property::ViewOptions::Color = "Color";
|
|
const char* Property::ViewOptions::Logarithmic = "Logarithmic";
|
|
|
|
const char* Property::IdentifierKey = "Identifier";
|
|
const char* Property::NameKey = "Name";
|
|
const char* Property::TypeKey = "Type";
|
|
const char* Property::DescriptionKey = "Description";
|
|
const char* Property::JsonValueKey = "Value";
|
|
const char* Property::MetaDataKey = "MetaData";
|
|
const char* Property::AdditionalDataKey = "AdditionalData";
|
|
|
|
|
|
|
|
std::string sanitizeString(const std::string& s) {
|
|
std::string result;
|
|
|
|
for (const char& c : s) {
|
|
switch (c) {
|
|
case '"':
|
|
result += "\\\"";
|
|
break;
|
|
case '\\':
|
|
result += "\\\\";
|
|
break;
|
|
case '\b':
|
|
result += "\\b";
|
|
break;
|
|
case '\f':
|
|
result += "\\f";
|
|
break;
|
|
case '\n':
|
|
result += "\\n";
|
|
break;
|
|
case '\r':
|
|
result += "\\r";
|
|
break;
|
|
case '\t':
|
|
result += "\\t";
|
|
break;
|
|
default:
|
|
result += c;
|
|
}
|
|
}
|
|
|
|
return result;
|
|
}
|
|
|
|
|
|
#ifdef _DEBUG
|
|
uint64_t Property::Identifier = 0;
|
|
#endif
|
|
|
|
Property::Property(PropertyInfo info)
|
|
: _identifier(std::move(info.identifier))
|
|
, _guiName(std::move(info.guiName))
|
|
, _description(std::move(info.description))
|
|
#ifdef _DEBUG
|
|
, _id(Identifier++)
|
|
#endif
|
|
{
|
|
ghoul_assert(!_identifier.empty(), "Identifier must not be empty");
|
|
ghoul_assert(!_guiName.empty(), "guiName must not be empty");
|
|
|
|
setVisibility(info.visibility);
|
|
}
|
|
|
|
Property::~Property() {
|
|
notifyDeleteListeners();
|
|
}
|
|
|
|
const std::string& Property::identifier() const {
|
|
return _identifier;
|
|
}
|
|
|
|
std::string Property::fullyQualifiedIdentifier() const {
|
|
std::string identifier = _identifier;
|
|
PropertyOwner* currentOwner = owner();
|
|
while (currentOwner) {
|
|
std::string ownerId = currentOwner->identifier();
|
|
if (!ownerId.empty()) {
|
|
identifier = ownerId + "." + identifier; // NOLINT
|
|
}
|
|
currentOwner = currentOwner->owner();
|
|
}
|
|
return identifier;
|
|
}
|
|
|
|
std::any Property::get() const {
|
|
return std::any();
|
|
}
|
|
|
|
bool Property::getLuaValue(lua_State*) const {
|
|
return false;
|
|
}
|
|
|
|
void Property::set(std::any) {} // NOLINT
|
|
|
|
bool Property::setLuaValue(lua_State*) {
|
|
return false;
|
|
}
|
|
|
|
const std::type_info& Property::type() const {
|
|
return typeid(void);
|
|
}
|
|
|
|
int Property::typeLua() const {
|
|
return LUA_TNIL;
|
|
}
|
|
|
|
bool Property::getStringValue(std::string&) const {
|
|
return false;
|
|
}
|
|
|
|
std::string Property::getStringValue() const {
|
|
std::string value;
|
|
bool status = getStringValue(value);
|
|
if (!status) {
|
|
throw ghoul::RuntimeError("Could not get string value", identifier());
|
|
}
|
|
return value;
|
|
}
|
|
|
|
const std::string& Property::guiName() const {
|
|
return _guiName;
|
|
}
|
|
|
|
const std::string& Property::description() const {
|
|
return _description;
|
|
}
|
|
|
|
void Property::setGroupIdentifier(std::string groupId) {
|
|
_metaData.setValue(MetaDataKeyGroup, std::move(groupId));
|
|
}
|
|
|
|
std::string Property::groupIdentifier() const {
|
|
if (_metaData.hasValue<std::string>(MetaDataKeyGroup)) {
|
|
return _metaData.value<std::string>(MetaDataKeyGroup);
|
|
}
|
|
else {
|
|
return "";
|
|
}
|
|
}
|
|
|
|
void Property::setVisibility(Visibility visibility) {
|
|
_metaData.setValue(
|
|
MetaDataKeyVisibility,
|
|
static_cast<std::underlying_type_t<Visibility>>(visibility)
|
|
);
|
|
}
|
|
|
|
Property::Visibility Property::visibility() const {
|
|
return static_cast<Visibility>(
|
|
_metaData.value<std::underlying_type_t<Visibility>>(MetaDataKeyVisibility)
|
|
);
|
|
}
|
|
|
|
void Property::setReadOnly(bool state) {
|
|
_metaData.setValue(MetaDataKeyReadOnly, state);
|
|
}
|
|
|
|
void Property::setViewOption(std::string option, bool value) {
|
|
ghoul::Dictionary d;
|
|
d.setValue(option, value);
|
|
_metaData.setValue(MetaDataKeyViewOptions, d);
|
|
}
|
|
|
|
bool Property::viewOption(const std::string& option, bool defaultValue) const {
|
|
if (!_metaData.hasValue<ghoul::Dictionary>(MetaDataKeyViewOptions)) {
|
|
return defaultValue;
|
|
}
|
|
ghoul::Dictionary d = _metaData.value<ghoul::Dictionary>(MetaDataKeyViewOptions);
|
|
if (d.hasKey(option)) {
|
|
return d.value<bool>(option);
|
|
}
|
|
else {
|
|
return defaultValue;
|
|
}
|
|
}
|
|
|
|
const ghoul::Dictionary& Property::metaData() const {
|
|
return _metaData;
|
|
}
|
|
|
|
std::string Property::toJson() const {
|
|
std::string result = "{";
|
|
result += "\"" + std::string(DescriptionKey) + "\": " +
|
|
generateBaseJsonDescription() + ", ";
|
|
result += "\"" + std::string(JsonValueKey) + "\": " + jsonValue() + '}';
|
|
return result;
|
|
}
|
|
|
|
std::string Property::jsonValue() const {
|
|
return getStringValue();
|
|
}
|
|
|
|
Property::OnChangeHandle Property::onChange(std::function<void()> callback) {
|
|
ghoul_assert(callback, "The callback must not be empty");
|
|
|
|
OnChangeHandle handle = _currentHandleValue++;
|
|
_onChangeCallbacks.emplace_back(handle, std::move(callback));
|
|
return handle;
|
|
}
|
|
|
|
Property::OnChangeHandle Property::onDelete(std::function<void()> callback) {
|
|
ghoul_assert(callback, "The callback must not be empty");
|
|
|
|
OnDeleteHandle handle = _currentHandleValue++;
|
|
_onDeleteCallbacks.emplace_back(handle, std::move(callback));
|
|
return handle;
|
|
}
|
|
|
|
void Property::removeOnChange(OnChangeHandle handle) {
|
|
if (handle == OnChangeHandleAll) {
|
|
_onChangeCallbacks.clear();
|
|
}
|
|
else {
|
|
auto it = std::find_if(
|
|
_onChangeCallbacks.begin(),
|
|
_onChangeCallbacks.end(),
|
|
[handle](const std::pair<OnChangeHandle, std::function<void()>>& p) {
|
|
return p.first == handle;
|
|
}
|
|
);
|
|
|
|
ghoul_assert(
|
|
it != _onChangeCallbacks.end(),
|
|
"handle must be a valid callback handle"
|
|
);
|
|
|
|
_onChangeCallbacks.erase(it);
|
|
}
|
|
}
|
|
|
|
void Property::removeOnDelete(OnDeleteHandle handle) {
|
|
auto it = std::find_if(
|
|
_onDeleteCallbacks.begin(),
|
|
_onDeleteCallbacks.end(),
|
|
[handle](const std::pair<OnDeleteHandle, std::function<void()>>& p) {
|
|
return p.first == handle;
|
|
}
|
|
);
|
|
|
|
ghoul_assert(
|
|
it != _onDeleteCallbacks.end(),
|
|
"handle must be a valid callback handle"
|
|
);
|
|
|
|
_onDeleteCallbacks.erase(it);
|
|
}
|
|
|
|
PropertyOwner* Property::owner() const {
|
|
return _owner;
|
|
}
|
|
|
|
void Property::setPropertyOwner(PropertyOwner* owner) {
|
|
_owner = owner;
|
|
}
|
|
|
|
void Property::notifyChangeListeners() {
|
|
for (const std::pair<OnChangeHandle, std::function<void()>>& p : _onChangeCallbacks) {
|
|
p.second();
|
|
}
|
|
}
|
|
|
|
void Property::notifyDeleteListeners() {
|
|
for (const std::pair<OnDeleteHandle, std::function<void()>>& p : _onDeleteCallbacks) {
|
|
p.second();
|
|
}
|
|
}
|
|
|
|
bool Property::hasChanged() const {
|
|
return _isValueDirty;
|
|
}
|
|
|
|
void Property::resetToUnchanged() {
|
|
_isValueDirty = false;
|
|
}
|
|
|
|
std::string Property::generateBaseJsonDescription() const {
|
|
std::string cName = className();
|
|
std::string cNameSan = sanitizeString(cName);
|
|
std::string identifier = fullyQualifiedIdentifier();
|
|
std::string identifierSan = sanitizeString(identifier);
|
|
std::string gName = guiName();
|
|
std::string gNameSan = sanitizeString(gName);
|
|
std::string metaData = generateMetaDataJsonDescription();
|
|
std::string description = generateAdditionalJsonDescription();
|
|
|
|
return
|
|
"{ \"" + std::string(TypeKey) + "\": \"" + cNameSan + "\", " +
|
|
"\"" + std::string(IdentifierKey) + "\": \"" + identifierSan + "\", " +
|
|
"\"" + std::string(NameKey) + "\": \"" + gNameSan + "\", " +
|
|
"\"" + std::string(MetaDataKey) + "\": " + metaData + ", " +
|
|
"\"" + std::string(AdditionalDataKey) + "\": " + description + " }";
|
|
}
|
|
|
|
std::string Property::generateMetaDataJsonDescription() const {
|
|
static const std::map<Visibility, std::string> VisibilityConverter = {
|
|
{ Visibility::All, "All" },
|
|
{ Visibility::Developer, "Developer" },
|
|
{ Visibility::User, "User" },
|
|
{ Visibility::Hidden, "Hidden" }
|
|
};
|
|
Visibility visibility = static_cast<Visibility>(
|
|
_metaData.value<std::underlying_type_t<Visibility>>(MetaDataKeyVisibility));
|
|
const std::string& vis = VisibilityConverter.at(visibility);
|
|
|
|
bool isReadOnly = false;
|
|
if (_metaData.hasValue<bool>(MetaDataKeyReadOnly)) {
|
|
isReadOnly = _metaData.value<bool>(MetaDataKeyReadOnly);
|
|
}
|
|
std::string isReadOnlyString = (isReadOnly ? "true" : "false");
|
|
|
|
std::string groupId = groupIdentifier();
|
|
std::string sanitizedGroupId = sanitizeString(groupId);
|
|
|
|
std::string viewOptions = "{}";
|
|
if (_metaData.hasValue<ghoul::Dictionary>(MetaDataKeyViewOptions)) {
|
|
viewOptions = ghoul::formatJson(
|
|
_metaData.value<ghoul::Dictionary>(MetaDataKeyViewOptions)
|
|
);
|
|
}
|
|
|
|
std::string result = "{ ";
|
|
result += fmt::format("\"{}\": \"{}\",", MetaDataKeyGroup, sanitizedGroupId);
|
|
result += fmt::format("\"{}\": \"{}\",", MetaDataKeyVisibility, vis);
|
|
result += fmt::format("\"{}\": {},", MetaDataKeyReadOnly, isReadOnlyString);
|
|
result += fmt::format("\"{}\": {}", MetaDataKeyViewOptions, viewOptions);
|
|
result += " }";
|
|
return result;
|
|
}
|
|
|
|
std::string Property::generateAdditionalJsonDescription() const {
|
|
return "{}";
|
|
}
|
|
|
|
void Property::setInterpolationTarget(std::any) {} // NOLINT
|
|
void Property::setLuaInterpolationTarget(lua_State*) {}
|
|
void Property::interpolateValue(float, ghoul::EasingFunc<float>) {}
|
|
|
|
} // namespace openspace::properties
|