/*
 Copyright (C) 2009 Erik Ogenvik <erik@ogenvik.org>

 This program is free software; you can redistribute it and/or modify
 it under the terms of the GNU General Public License as published by
 the Free Software Foundation; either version 2 of the License, or
 (at your option) any later version.

 This program is distributed in the hope that it will be useful,
 but WITHOUT ANY WARRANTY; without even the implied warranty of
 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 GNU General Public License for more details.

 You should have received a copy of the GNU General Public License
 along with this program; if not, write to the Free Software Foundation,
 Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */

#ifndef ATLASHELPER_H_
#define ATLASHELPER_H_

#include <Atlas/Objects/ObjectsFwd.h>
#include <string>


namespace Ember::OgreView::Gui {

/**
 * @author Erik Ogenvik <erik@ogenvik.org>
 * @brief Provides simple Atlas help functionality, mainly meant for those things that are cumbersome to do in the script language.
 */
class AtlasHelper {
public:

	/**
	 * @brief Serializes the supplied object into a string using the supplied codec type.
	 * @param obj The object to serialize.
	 * @param codecType The codec type to use. Supported formats are: bach, xml
	 * @return The object in serialized form.
	 */
	static std::string serialize(const Atlas::Objects::Root& obj, const std::string& codecType = "bach");

	static Atlas::Objects::Root deserialize(const std::string& text, const std::string& codecType);

};

}


#endif /* ATLASHELPER_H_ */
