BansheeEngine/Source/BansheeEditor/Include/BsCmdCloneSO.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. Clones scene object(s) and removes them as an undo operation. */
	class BS_ED_EXPORT CmdCloneSO : public EditorCommand
	{
	public:
		~CmdCloneSO();

		/**
		 * Creates a new scene object by cloning an existing object. Automatically registers the command with undo/redo 
		 * system.
		 *
		 * @param[in]	sceneObject		Scene object to clone.
		 * @param[in]	description		Optional description of what exactly the command does.
		 * @return						Cloned object.
		 */
		static HSceneObject execute(const HSceneObject& sceneObject, const WString& description = StringUtil::WBLANK);

		/**
		 * Creates new scene object(s) by cloning existing objects. Automatically registers the command with undo/redo 
		 * system.
		 *
		 * @param[in]	sceneObjects	Scene object(s) to clone.
		 * @param[in]	description		Optional description of what exactly the command does.
		 * @return						Cloned objects.
		 */
		static Vector<HSceneObject> execute(const Vector<HSceneObject>& sceneObjects, const WString& description = StringUtil::WBLANK);

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

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

	private:
		friend class UndoRedo;

		CmdCloneSO(const WString& description, const Vector<HSceneObject>& originals);

		Vector<HSceneObject> mOriginals;
		Vector<HSceneObject> mClones;
	};

	/** @} */
}