BansheeEngine/BansheeEditor/Include/BsCmdRecordSO.h

//********************************** Banshee Engine (www.banshee3d.com) **************************************************//
//**************** Copyright (c) 2016 Marko Pintera ([email protected]). All rights reserved. **********************//
#pragma once

#include "BsEditorPrerequisites.h"
#include "BsEditorCommand.h"
#include "BsUndoRedo.h"
#include "BsCmdUtility.h"

namespace BansheeEngine
{
	/**
	 * @brief	A command used for undo/redo purposes. It records a state of the entire
	 *			scene object at a specific point and allows you to restore it to its
	 *			original values as needed.
	 */
	class BS_ED_EXPORT CmdRecordSO : public EditorCommand
	{
	public:
		~CmdRecordSO();

		/**
		 * @brief	Creates and executes the command on the provided scene object.
		 *			Automatically registers the command with undo/redo system.
		 *
		 * @param	sceneObject		Scene object to record.
		 * @param	recordHierarchy	If true, all children of the provided scene object will be recorded as well.
		 * @param	description		Optional description of what exactly the command does.
		 */
		static void execute(const HSceneObject& sceneObject, bool recordHierarchy = false, 
			const WString& description = StringUtil::WBLANK);

		/**
		 * @copydoc	EditorCommand::commit
		 */
		void commit() override;

		/**
		 * @copydoc	EditorCommand::revert
		 */
		void revert() override;

	private:
		friend class UndoRedo;

		CmdRecordSO(const WString& description, const HSceneObject& sceneObject, bool recordHierarchy);

		/**
		 * @brief	Saves the state of the specified object, all of its children
		 *			and components. Make sure to call "clear" when you no longer need
		 *			the data, or wish to call this method again.
		 */
		void recordSO(const HSceneObject& sceneObject);

		/**
		 * @brief	Clears all the stored data and frees memory.
		 */
		void clear();

		HSceneObject mSceneObject;
		CmdUtility::SceneObjProxy mSceneObjectProxy;
		bool mRecordHierarchy;

		UINT8* mSerializedObject;
		UINT32 mSerializedObjectSize;
	};
}