From 679a8b4129041171d76096d947043cdc654777b4 Mon Sep 17 00:00:00 2001
From: Simon Detheridge <simon@highlyillogical.org>
Date: Fri, 26 Jun 2015 21:23:27 +0100
Subject: [PATCH] Serialise FlameMotion elements to/from XML

---
 Source/Ember/EmberToXml.h | 107 ++++++++++++++++++++++++++++++
 Source/Ember/XmlToEmber.h | 132 ++++++++++++++++++++++++++++++++++++++
 2 files changed, 239 insertions(+)

diff --git a/Source/Ember/EmberToXml.h b/Source/Ember/EmberToXml.h
index b1febdd..45a2810 100644
--- a/Source/Ember/EmberToXml.h
+++ b/Source/Ember/EmberToXml.h
@@ -221,6 +221,9 @@ public:
 
 		os << "\">\n";
 
+		for (i = 0; i < ember.m_FlameMotionElements.size(); ++i)
+			os << "   " << ToString(ember.m_FlameMotionElements[i]);
+
 		//This is a grey area, what to do about symmetry to avoid duplicating the symmetry xforms when reading back?//TODO//BUG.
 		//if (ember.m_Symmetry)
 		//	os << "   <symmetry kind=\"" << ember.m_Symmetry << "\"/>\n";
@@ -719,6 +722,110 @@ private:
 		return os.str();
 	}
 
+	/// <summary>
+	/// Convert a FlameMotion element to an xml string
+	/// </summary>
+	/// <param name="motion">The FlameMotion object to convert to XML</param>
+	string ToString(const FlameMotion<T> &motion)
+	{
+		ostringstream os;
+		os << "<flame_motion motion_frequency=\"" << motion.m_MotionFreq << "\" ";
+
+		os << "motion_func=";
+		switch(motion.m_MotionFunc)
+		{
+		case MOTION_SIN:
+			os << "\"sin\"";
+			break;
+		case MOTION_HILL:
+			os << "\"hill\"";
+			break;
+		case MOTION_TRIANGLE:
+			os << "\"triangle\"";
+			break;
+		case MOTION_SAW:
+			os << "\"saw\"";
+			break;
+		}
+
+		T r = 0.0;
+		T g = 0.0;
+		T b = 0.0;
+		T cx = 0.0;
+		T cy = 0.0;
+
+		for(int i = 0; i < motion.m_MotionParams.size(); ++i)
+		{
+			switch(motion.m_MotionParams[i].first)
+			{
+			case FLAME_MOTION_ZOOM:
+				os << " zoom=\"" << motion.m_MotionParams[i].second << "\"";
+				break;
+			case FLAME_MOTION_ZPOS:
+				os << " cam_zpos=\"" << motion.m_MotionParams[i].second << "\"";
+				break;
+			case FLAME_MOTION_PERSPECTIVE:
+				os << " cam_persp=\"" << motion.m_MotionParams[i].second << "\"";
+				break;
+			case FLAME_MOTION_YAW:
+				os << " cam_yaw=\"" << motion.m_MotionParams[i].second << "\"";
+				break;
+			case FLAME_MOTION_PITCH:
+				os << " cam_pitch=\"" << motion.m_MotionParams[i].second << "\"";
+				break;
+			case FLAME_MOTION_DEPTH_BLUR:
+				os << " cam_dof=\"" << motion.m_MotionParams[i].second << "\"";
+				break;
+			case FLAME_MOTION_CENTER_X:
+				cx = motion.m_MotionParams[i].second;
+				break;
+			case FLAME_MOTION_CENTER_Y:
+				cy = motion.m_MotionParams[i].second;
+				break;
+			case FLAME_MOTION_ROTATE:
+				os << " rotate=\"" << motion.m_MotionParams[i].second << "\"";
+				break;
+			case FLAME_MOTION_HUE:
+				os << " hue=\"" << motion.m_MotionParams[i].second << "\"";
+				break;
+			case FLAME_MOTION_BRIGHTNESS:
+				os << " brightness=\"" << motion.m_MotionParams[i].second << "\"";
+				break;
+			case FLAME_MOTION_GAMMA:
+				os << " gamma=\"" << motion.m_MotionParams[i].second << "\"";
+				break;
+			case FLAME_MOTION_GAMMA_THRESH:
+				os << " gamma_threshold=\"" << motion.m_MotionParams[i].second << "\"";
+				break;
+			case FLAME_MOTION_HIGHLIGHT_POWER:
+				os << " highlight_power=\"" << motion.m_MotionParams[i].second << "\"";
+				break;
+			case FLAME_MOTION_BACKGROUND_R:
+				r = motion.m_MotionParams[i].second;
+				break;
+			case FLAME_MOTION_BACKGROUND_G:
+				g = motion.m_MotionParams[i].second;
+				break;
+			case FLAME_MOTION_BACKGROUND_B:
+				b = motion.m_MotionParams[i].second;
+				break;
+			case FLAME_MOTION_VIBRANCY:
+				os << " vibrancy=\"" << motion.m_MotionParams[i].second << "\"";
+				break;
+			}
+		}
+
+		if ( r != 0.0 || g != 0.0 || b != 0.0 )
+			os << " background=\"" << r << " " << g << " " << b << "\"";
+
+		if ( cx != 0.0 || cy != 0.0 )
+			os << " center=\"" << cx << " " << cy << "\"";
+
+		os << "/>\n";
+
+		return os.str();
+	}
+
 	void AddFilenameWithoutAmpersand(xmlNodePtr node, string& filename)
 	{
 		if (filename.find_first_of('&') != std::string::npos)
diff --git a/Source/Ember/XmlToEmber.h b/Source/Ember/XmlToEmber.h
index 8293598..290b43e 100644
--- a/Source/Ember/XmlToEmber.h
+++ b/Source/Ember/XmlToEmber.h
@@ -998,6 +998,112 @@ private:
 				editNode = xmlCopyNode(childNode, 1);
 				xmlDocSetRootElement(currentEmber.m_Edits, editNode);
 			}
+			else if (!Compare(childNode->name, "flame_motion"))
+			{
+				FlameMotion<T> motion;
+
+				att = childNode->properties;
+
+				if (att == nullptr)
+				{
+					m_ErrorReport.push_back(string(loc) + " : <flame_motion> element has no attributes");
+					return false;
+				}
+
+				for (curAtt = att; curAtt; curAtt = curAtt->next)
+				{
+					attStr = reinterpret_cast<char*>(xmlGetProp(childNode, curAtt->name));
+
+					if		(ParseAndAssignFloat(curAtt->name, attStr, "motion_frequency", motion.m_MotionFreq, ret)) { }
+					else if (!Compare(curAtt->name, "motion_function"))
+					{
+						string func(attStr);
+						if ( func == "sin" )
+							motion.m_MotionFunc = MOTION_SIN;
+						else if ( func == "triangle" )
+							motion.m_MotionFunc = MOTION_TRIANGLE;
+						else if ( func == "hill" )
+							motion.m_MotionFunc = MOTION_HILL;
+						else if ( func == "saw" )
+							motion.m_MotionFunc = MOTION_SAW;
+						else
+						{
+							m_ErrorReport.push_back(string(loc) + " : invalid flame motion function " + func);
+							return false;
+						}
+					}
+					else if (!Compare(curAtt->name, "zoom"))
+						ret = ret && AttToFlameMotionFloat(att, attStr, FLAME_MOTION_ZOOM, motion);
+					else if (!Compare(curAtt->name, "cam_zpos"))
+						ret = ret && AttToFlameMotionFloat(att, attStr, FLAME_MOTION_ZPOS, motion);
+					else if (!Compare(curAtt->name, "cam_persp"))
+						ret = ret && AttToFlameMotionFloat(att, attStr, FLAME_MOTION_PERSPECTIVE, motion);
+					else if (!Compare(curAtt->name, "cam_yaw"))
+						ret = ret && AttToFlameMotionFloat(att, attStr, FLAME_MOTION_YAW, motion);
+					else if (!Compare(curAtt->name, "cam_pitch"))
+						ret = ret && AttToFlameMotionFloat(att, attStr, FLAME_MOTION_PITCH, motion);
+					else if (!Compare(curAtt->name, "cam_dof"))
+						ret = ret && AttToFlameMotionFloat(att, attStr, FLAME_MOTION_DEPTH_BLUR, motion);
+					else if (!Compare(curAtt->name, "rotate"))
+						ret = ret && AttToFlameMotionFloat(att, attStr, FLAME_MOTION_ROTATE, motion);
+					else if (!Compare(curAtt->name, "hue"))
+						ret = ret && AttToFlameMotionFloat(att, attStr, FLAME_MOTION_HUE, motion);
+					else if (!Compare(curAtt->name, "brightness"))
+						ret = ret && AttToFlameMotionFloat(att, attStr, FLAME_MOTION_BRIGHTNESS, motion);
+					else if (!Compare(curAtt->name, "gamma"))
+						ret = ret && AttToFlameMotionFloat(att, attStr, FLAME_MOTION_GAMMA, motion);
+					else if (!Compare(curAtt->name, "gamma_threshold"))
+						ret = ret && AttToFlameMotionFloat(att, attStr, FLAME_MOTION_GAMMA_THRESH, motion);
+					else if (!Compare(curAtt->name, "highlight_power"))
+						ret = ret && AttToFlameMotionFloat(att, attStr, FLAME_MOTION_HIGHLIGHT_POWER, motion);
+					else if (!Compare(curAtt->name, "vibrancy"))
+						ret = ret && AttToFlameMotionFloat(att, attStr, FLAME_MOTION_VIBRANCY, motion);
+					else if (!Compare(curAtt->name, "background"))
+					{
+						double r, g, b;
+
+						if (sscanf_s(attStr, "%lf %lf %lf", &r, &g, &b) != 3)
+						{
+							m_ErrorReport.push_back(string(loc) + " : Invalid flame motion background attribute " + string(attStr));
+							xmlFree(attStr);
+							return false;
+						}
+
+						if (r != 0)
+							motion.m_MotionParams.push_back(pair<eFlameMotionParam, T>(FLAME_MOTION_BACKGROUND_R, T(r)));
+						if (g != 0)
+							motion.m_MotionParams.push_back(pair<eFlameMotionParam, T>(FLAME_MOTION_BACKGROUND_G, T(g)));
+						if (b != 0)
+							motion.m_MotionParams.push_back(pair<eFlameMotionParam, T>(FLAME_MOTION_BACKGROUND_B, T(b)));
+					}
+					else if (!Compare(curAtt->name, "center"))
+					{
+						double cx, cy;
+
+						if (sscanf_s(attStr, "%lf %lf", &cx, &cy) != 2)
+						{
+							m_ErrorReport.push_back(string(loc) + " : Invalid flame motion center attribute " + string(attStr));
+							xmlFree(attStr);
+							return false;
+						}
+
+						if (cx != 0)
+							motion.m_MotionParams.push_back(pair<eFlameMotionParam, T>(FLAME_MOTION_CENTER_X, T(cx)));
+						if (cy != 0)
+							motion.m_MotionParams.push_back(pair<eFlameMotionParam, T>(FLAME_MOTION_CENTER_Y, T(cy)));
+					}
+					else
+					{
+						m_ErrorReport.push_back(string(loc) + " : Unknown flame motion attribute " + string(CCX(curAtt->name)));
+						xmlFree(attStr);
+						return false;
+					}
+
+					xmlFree(attStr);
+				}
+
+				currentEmber.m_FlameMotionElements.push_back(motion);
+			}
 		}
 
 		//if (!newLinear)
@@ -1010,6 +1116,32 @@ private:
 		return m_ErrorReport.empty();
 	}
 
+	/// <summary>
+	/// Parse a floating point value from an xml attribute and add the value to a FlameMotion object
+	/// </summary>
+	/// <param name="att">The current attribute</param>
+	/// <param name="attStr">The attribute value to parse</param>
+	/// <param name="param">The flame motion parameter type</param>
+	/// <param name="motion">The flame motion element to add the parameter to</param>
+	/// <returns>True if there were no errors, else false.</returns>
+	bool AttToFlameMotionFloat(xmlAttrPtr att, const char *attStr, eFlameMotionParam param, FlameMotion<T> &motion)
+	{
+		const char* loc = __FUNCTION__;
+
+		bool r = false;
+		T val = 0.0;
+
+		if (Atof(attStr, val))
+		{
+			motion.m_MotionParams.push_back(pair<eFlameMotionParam, T>(param, val));
+			r = true;
+		} else {
+			m_ErrorReport.push_back(string(loc) + " : Failed to parse float value for flame motion attribute \"" + string(CCX(att->name)) + "\" : " + string(attStr) + "");
+		}
+
+		return r;
+	}
+
 	/// <summary>
 	/// Parse an xform element.
 	/// </summary>