BansheeEngine/BansheeEditor/Include/BsCmdBreakPrefab.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"

namespace BansheeEngine
{
	/**
	 * @brief	A command used for undo/redo purposes. It breaks a prefab link of a scene object
	 *			and allows you to restore link.
	 */
	class BS_ED_EXPORT CmdBreakPrefab : public EditorCommand
	{
	public:
		~CmdBreakPrefab();

		/**
		 * @brief	Creates and executes the command on the provided scene object.
		 *			Automatically registers the command with undo/redo system.
		 *
		 * @param	sceneObject		Scene object whose prefab link to break.
		 * @param	description		Optional description of what exactly the command does.
		 */
		static void execute(const HSceneObject& sceneObject, const WString& description = StringUtil::WBLANK);

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

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

	private:
		friend class UndoRedo;

		CmdBreakPrefab(const WString& description, const HSceneObject& sceneObject);

		/**
		 * @brief	Clears all internal cached data. Should be called whenever a change is commited.
		 */
		void clear();

		HSceneObject mSceneObject;

		HSceneObject mPrefabRoot;
		String mPrefabLinkUUID;
		PrefabDiffPtr mPrefabDiff;
		UnorderedMap<UINT64, UINT32> mLinkIds;
	};
}