BansheeEngine/Source/BansheeEditor/Include/BsCmdInstantiateSO.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
{
	/** @addtogroup UndoRedo
	 *  @{
	 */

	/**	
	 * A command used for undo/redo purposes. Instantiates scene object(s) from a prefab and removes them as an undo
	 * operation.
	 */
	class BS_ED_EXPORT CmdInstantiateSO : public EditorCommand
	{
	public:
		~CmdInstantiateSO();

		/**
		 * Instantiates the specified prefab. Automatically registers the command with undo/redo system.
		 *
		 * @param[in]	prefab			Prefab to instantiate.
		 * @param[in]	description		Optional description of what exactly the command does.
		 * @return						Instantiated object.
		 */
		static HSceneObject execute(const HPrefab& prefab, const WString& description = StringUtil::WBLANK);

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

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

	private:
		friend class UndoRedo;

		CmdInstantiateSO(const WString& description, const HPrefab& prefab);

		HPrefab mPrefab;
		HSceneObject mSceneObject;
	};

	/** @} */
}