BansheeEngine/Source/BansheeCore/Include/BsGameObjectManager.h

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

#include "BsCorePrerequisites.h"
#include "BsModule.h"
#include "BsGameObject.h"

namespace BansheeEngine
{
	/** @cond INTERNAL */
	/** @addtogroup Scene
	 *  @{
	 */

	/**	Possible modes to use when deserializing games objects. */
	enum GameObjectHandleDeserializationMode
	{
		/** All handles will point to old ID that were restored from the deserialized file. */
		GODM_UseOriginalIds = 0x01, 
		/** All handles will point to new IDs that were given to the deserialized GameObjects. */
		GODM_UseNewIds = 0x02,
		/** Handles pointing to GameObjects outside of the currently deserialized set
		will attempt to be restored in case those objects are still active. */
		GODM_RestoreExternal = 0x04,
		/** Handles pointing to GameObjects outside of the currently deserialized set
		will be broken. */
		GODM_BreakExternal = 0x08,
		/** Handles pointing to GameObjects that cannot be found will not be set to null. */
		GODM_KeepMissing = 0x10
	};

	/**
	 * Tracks GameObject creation and destructions. Also resolves GameObject references from GameObject handles.
	 *
	 * @note	Sim thread only.
	 */
	class BS_CORE_EXPORT GameObjectManager : public Module<GameObjectManager>
	{
		/**	Contains data for an yet unresolved game object handle. */
		struct UnresolvedHandle
		{
			UINT64 originalInstanceId;
			GameObjectHandleBase handle;
		};

	public:
		GameObjectManager();
		~GameObjectManager();

		/**
		 * Registers a new GameObject and returns the handle to the object.
		 * 			
		 * @param[in]	object			Constructed GameObject to wrap in the handle and initialize.
		 * @param[in]	originalId		If the object is being created due to deserialization you must provide the original
		 *								object's ID so that deserialized handles can map to it properly.
		 * @return						Handle to the GameObject.
		 */
		GameObjectHandleBase registerObject(const std::shared_ptr<GameObject>& object, UINT64 originalId = 0);

		/**
		 * Unregisters a GameObject. Handles to this object will no longer be valid after this call. This should be called
		 * whenever a GameObject is destroyed.
		 */
		void unregisterObject(GameObjectHandleBase& object);

		/**
		 * Attempts to find a GameObject handle based on the GameObject instance ID. Returns empty handle if ID cannot be 
		 * found.
		 */
		GameObjectHandleBase getObject(UINT64 id) const;

		/**
		 * Attempts to find a GameObject handle based on the GameObject instance ID. Returns true if object with the 
		 * specified ID is found, false otherwise.
		 */
		bool tryGetObject(UINT64 id, GameObjectHandleBase& object) const;

		/**	Checks if the GameObject with the specified instance ID exists. */
		bool objectExists(UINT64 id) const;

		/**
		 * Changes the instance ID by which an object can be retrieved by. 
		 *
		 * @note	Caller is required to update the object itself with the new ID.
		 */
		void remapId(UINT64 oldId, UINT64 newId);

		/**	Queues the object to be destroyed at the end of a GameObject update cycle. */
		void queueForDestroy(const GameObjectHandleBase& object);

		/**	Destroys any GameObjects that were queued for destruction. */
		void destroyQueuedObjects();

		/**	Triggered when a game object is being destroyed. */
		Event<void(const HGameObject&)> onDestroyed;

		/************************************************************************/
		/* 							DESERIALIZATION                      		*/
		/************************************************************************/
		// Note: GameObjects need a bit of special handling when it comes to deserialization,
		// which is what this part of the code is used for. It performs two main actions:
		//  - 1. Resolves all GameObjectHandles on deserialization
		//    - We can't just resolve them as we go because during deserialization not all objects
		//      have necessarily been created.
		//  - 2. Maps serialized IDs to actual in-engine IDs. 

		/** Needs to be called whenever GameObject deserialization starts. Must be followed by endDeserialization() call. */
		void startDeserialization();

		/** Needs to be called whenever GameObject deserialization ends. Must be preceded by startDeserialization() call. */
		void endDeserialization();

		/**	Returns true if GameObject deserialization is currently in progress. */
		bool isGameObjectDeserializationActive() const { return mIsDeserializationActive; }

		/**	Queues the specified handle and resolves it when deserialization ends. */
		void registerUnresolvedHandle(UINT64 originalId, GameObjectHandleBase& object);

		/**	Registers a callback that will be triggered when GameObject serialization ends. */
		void registerOnDeserializationEndCallback(std::function<void()> callback);

		/**
		 * Changes the deserialization mode for any following GameObject handle.
		 *
		 * @param[in]	gameObjectDeserializationMode	Mode that controls how are GameObjects handles resolved when being
		 *												deserialized.
		 */
		void setDeserializationMode(UINT32 gameObjectDeserializationMode);

		/**
		 * Attempts to update the ID of the provided handle by mapping its old ID to the newly deserialized object and its
		 * new ID. Game object deserialization must be active.
		 */
		void resolveDeserializedHandle(UnresolvedHandle& data, UINT32 flags);

		/**	Gets the currently active flags that control how are game object handles deserialized. */
		UINT32 getDeserializationFlags() const { return mGODeserializationMode; }

	private:
		UINT64 mNextAvailableID; // 0 is not a valid ID
		Map<UINT64, GameObjectHandleBase> mObjects;
		Map<UINT64, GameObjectHandleBase> mQueuedForDestroy;

		GameObject* mActiveDeserializedObject;
		bool mIsDeserializationActive;
		Map<UINT64, UINT64> mIdMapping;
		Map<UINT64, SPtr<GameObjectHandleData>> mUnresolvedHandleData;
		Vector<UnresolvedHandle> mUnresolvedHandles;
		Vector<std::function<void()>> mEndCallbacks;
		UINT32 mGODeserializationMode;
	};

	/** @} */
	/** @endcond */
}