From 6336ee998afa5587221861ce752a7c56a7dbdb94 Mon Sep 17 00:00:00 2001
From: Alexander Bock <alexander.bock@liu.se>
Date: Wed, 17 Dec 2014 18:47:30 +0100
Subject: [PATCH] Added description for SelectionProperty

---
 .../openspace/properties/selectionproperty.h  |  7 +-
 src/properties/selectionproperty.cpp          | 64 +++++--------------
 .../stars/renderableconstellationbounds.cpp   |  1 -
 3 files changed, 19 insertions(+), 53 deletions(-)

diff --git a/include/openspace/properties/selectionproperty.h b/include/openspace/properties/selectionproperty.h
index 86b20298cb..2a094c6b77 100644
--- a/include/openspace/properties/selectionproperty.h
+++ b/include/openspace/properties/selectionproperty.h
@@ -32,8 +32,6 @@
 namespace openspace {
 namespace properties {
 
-//REGISTER_TEMPLATEPROPERTY_HEADER(SelectionProperty, std::vector<int>);
-
 class SelectionProperty : public TemplateProperty<std::vector<int>> {
 public:
 	struct Option {
@@ -46,9 +44,10 @@ public:
 	void addOption(Option option);
 	const std::vector<Option>& options() const;
 
-	//void setValue(std::vector<int> value) override;
-
 private:
+	static const std::string OptionsKey;
+	std::string generateAdditionalDescription() const;
+
 	/// The list of options which have been registered with this OptionProperty
 	std::vector<Option> _options;
 	std::vector<int> _values;
diff --git a/src/properties/selectionproperty.cpp b/src/properties/selectionproperty.cpp
index 6faaf8e915..fd1ebf2691 100644
--- a/src/properties/selectionproperty.cpp
+++ b/src/properties/selectionproperty.cpp
@@ -31,12 +31,14 @@ namespace {
 namespace openspace {
 namespace properties {
 
+const std::string SelectionProperty::OptionsKey = "Options";
+
 SelectionProperty::SelectionProperty(std::string identifier, std::string guiName)
 	: TemplateProperty(std::move(identifier), std::move(guiName), std::vector<int>())
 {}
 
 void SelectionProperty::addOption(Option option) {
-	// @COPY-N-PASTE from optionproperty.cpp, possible refactoring? ---abock
+	// @REFACTOR from optionproperty.cpp, possible refactoring? ---abock
 	for (const Option& o : _options) {
 		if (o.value == option.value) {
 			LWARNING("The value of option {" << o.value << " -> " << o.description <<
@@ -51,10 +53,6 @@ void SelectionProperty::addOption(Option option) {
 const std::vector<SelectionProperty::Option>& SelectionProperty::options() const {
 	return _options;
 }
-//
-//void SelectionProperty::setValue(std::vector<int> value) {
-//	_values = std::move(value);
-//}
 
 template <>
 std::string PropertyDelegate<TemplateProperty<std::vector<int>>>::className() {
@@ -113,49 +111,19 @@ int PropertyDelegate<TemplateProperty<std::vector<int>>>::typeLua() {
 	return LUA_TTABLE;
 }
 
-//REGISTER_TEMPLATEPROPERTY_SOURCE(SelectionProperty, std::vector<int>, std::vector<int>(),
-//	[](lua_State* state, bool& success) -> std::vector<int> {
-//		static const int KEY = -2;
-//		static const int VAL = -1;
-//
-//		std::vector<int> result;
-//
-//		if (!lua_istable(state, -1)) {
-//			LERROR("Parameter passed to the property is not a table");
-//			success = false;
-//			return result;
-//		}
-//
-//		lua_pushnil(state);
-//		while (lua_next(state, -2) != 0) {
-//			int valueType = lua_type(state, VAL);
-//
-//			if (lua_isnumber(state, VAL)) {
-//				int number = static_cast<int>(lua_tonumber(state, VAL));
-//				result.push_back(number);
-//			}
-//			else {
-//				success = false;
-//				return std::vector<int>();
-//			}
-//
-//			lua_pop(state, 1);
-//		}
-//
-//		success = true;
-//		return result;
-//	},
-//	[](lua_State* state, const std::vector<int>& value) -> bool {
-//		//@NOTE Untested ---abock
-//		lua_newtable(state);
-//		for (int i = 0; i < value.size(); ++i) {
-//			int v = value[i];
-//			lua_pushinteger(state, v);
-//			lua_setfield(state, -2, std::to_string(i).c_str());
-//		}
-//		return true;
-//	}, LUA_TTABLE
-//);
+std::string SelectionProperty::generateAdditionalDescription() const {
+	std::string result;
+	result += OptionsKey + " = {";
+	for (size_t i = 0; i < _options.size(); ++i) {
+		const Option& o = _options[i];
+		result += "[\"" + std::to_string(o.value) + "\"] = \"" + o.description + "\"";
+		if (i != _options.size() - 1)
+			result += ",";
+	}
+
+	result += "}";
+	return result;
+}
 
 } // namespace properties
 } // namespace openspace
diff --git a/src/rendering/stars/renderableconstellationbounds.cpp b/src/rendering/stars/renderableconstellationbounds.cpp
index e8e057662f..3a869633ce 100644
--- a/src/rendering/stars/renderableconstellationbounds.cpp
+++ b/src/rendering/stars/renderableconstellationbounds.cpp
@@ -326,7 +326,6 @@ void RenderableConstellationBounds::fillSelectionProperty() {
 	for (int i = 0 ; i < _constellationBounds.size(); ++i) {
 		const ConstellationBound& bound = _constellationBounds[i];
 		_constellationSelection.addOption( { i, bound.constellationFullName } );
-
 	}
 }