.. index:: pair: class; EE::Scene::MainThreadLifetime
.. _doxid-class_e_e_1_1_scene_1_1_main_thread_lifetime:

template class EE::Scene::MainThreadLifetime
============================================

.. toctree::
	:hidden:

	struct_EE_Scene_MainThreadLifetime_State.rst
	class_EE_Scene_MainThreadLifetime_WeakHandle.rst

Gates main-thread callbacks with the lifetime of a non-owning object.

The dispatcher and the guarded object must belong to the main thread. The dispatcher may be the guarded object itself, but it must otherwise outlive it. Worker threads may safely copy a :ref:`WeakHandle <doxid-class_e_e_1_1_scene_1_1_main_thread_lifetime_1_1_weak_handle>` and call run(); callbacks queued before invalidation become no-ops once the object is destroyed.


.. ref-code-block:: cpp
	:class: doxyrest-overview-code-block

	#include <mainthreadlifetime.hpp>
	
	template <typename T>
	class MainThreadLifetime {
	public:
		// structs
	
		struct :ref:`State<doxid-struct_e_e_1_1_scene_1_1_main_thread_lifetime_1_1_state>`;

		// classes
	
		class :ref:`WeakHandle<doxid-class_e_e_1_1_scene_1_1_main_thread_lifetime_1_1_weak_handle>`;

		// construction
	
		:target:`MainThreadLifetime<doxid-class_e_e_1_1_scene_1_1_main_thread_lifetime_1a0af2cc232999c473301247b04bf28fa7>`(T* object, :ref:`Node<doxid-class_e_e_1_1_scene_1_1_node>`* dispatcher);
		:target:`MainThreadLifetime<doxid-class_e_e_1_1_scene_1_1_main_thread_lifetime_1aac45d37ddcfcee6ae0a06e7a3a37d012>`(const MainThreadLifetime&);
		:target:`~MainThreadLifetime<doxid-class_e_e_1_1_scene_1_1_main_thread_lifetime_1a9b1e817681c51c36175c1e8f1fc26700>`();

		// methods
	
		MainThreadLifetime& :target:`operator=<doxid-class_e_e_1_1_scene_1_1_main_thread_lifetime_1a1c506715284ab4a9903ea69c0efa0fa3>`(const MainThreadLifetime&);
		:ref:`WeakHandle<doxid-class_e_e_1_1_scene_1_1_main_thread_lifetime_1_1_weak_handle>` :target:`weakHandle<doxid-class_e_e_1_1_scene_1_1_main_thread_lifetime_1a72b70aa0b6967729f19658c73c317931>`() const;
		void :target:`setDispatcher<doxid-class_e_e_1_1_scene_1_1_main_thread_lifetime_1a78183e7c722f53768b0f72bdd96bd843>`(:ref:`Node<doxid-class_e_e_1_1_scene_1_1_node>`* dispatcher);
		void :target:`invalidate<doxid-class_e_e_1_1_scene_1_1_main_thread_lifetime_1aabc6fd11a9ca269407d7f574fa88b674>`();
	};