.. index:: pair: class; EE::Scene::Actions::Tint
.. _doxid-class_e_e_1_1_scene_1_1_actions_1_1_tint:

class EE::Scene::Actions::Tint
==============================

.. toctree::
	:hidden:

	enum_EE_Scene_Actions_Tint_TintType.rst

Overview
~~~~~~~~




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

	#include <tint.hpp>
	
	class Tint: public :ref:`EE::Scene::Action<doxid-class_e_e_1_1_scene_1_1_action>` {
	public:
		// enums
	
		enum :ref:`TintType<doxid-class_e_e_1_1_scene_1_1_actions_1_1_tint_1a768b462b0d5af78e08b12f8586779b8f>`;

		// methods
	
		static Tint* :target:`New<doxid-class_e_e_1_1_scene_1_1_actions_1_1_tint_1af01f14ca8387ce3f1582fa9cde169ab3>`(
			const :ref:`Color<doxid-class_e_e_1_1_system_1_1_color>`& start,
			const :ref:`Color<doxid-class_e_e_1_1_system_1_1_color>`& end,
			const bool& interpolateAlpha,
			const :ref:`Time<doxid-class_e_e_1_1_system_1_1_time>`& duration,
			const :ref:`Ease::Interpolation<doxid-class_e_e_1_1_math_1_1_ease_1a2fd79dccc2ea8f8a2d566c58693f8888>`& type = Ease::Linear,
			const :ref:`TintType<doxid-class_e_e_1_1_scene_1_1_actions_1_1_tint_1a768b462b0d5af78e08b12f8586779b8f>`& colorInterpolationType = :ref:`Background<doxid-class_e_e_1_1_scene_1_1_actions_1_1_tint_1a768b462b0d5af78e08b12f8586779b8fa8db252401a9f1e21dac31deaf51c1217>`,
			const :ref:`Uint32<doxid-namespace_e_e_1acb11e434631749f2da0e0004d6038558>`& elemIndex = 0
		);
	
		virtual void :ref:`start<doxid-class_e_e_1_1_scene_1_1_actions_1_1_tint_1a9c73f218f78affed1cda148d3b69d98d>`();
		virtual void :ref:`stop<doxid-class_e_e_1_1_scene_1_1_actions_1_1_tint_1ab4800087ef2b79fdbb64c0a0d9781c71>`();
		virtual void :ref:`update<doxid-class_e_e_1_1_scene_1_1_actions_1_1_tint_1afb0f0dc18acb5df828fe29ea26510d34>`(const :ref:`Time<doxid-class_e_e_1_1_system_1_1_time>`& time);
		virtual bool :ref:`isDone<doxid-class_e_e_1_1_scene_1_1_actions_1_1_tint_1a20fd3bcc177adad47c26f8c35bf13a28>`();
		virtual :ref:`Action<doxid-class_e_e_1_1_scene_1_1_action>`* :ref:`clone<doxid-class_e_e_1_1_scene_1_1_actions_1_1_tint_1a2f0b6a9545dff77e8d1f45c8f42fbb1a>`() const;
		virtual :ref:`Action<doxid-class_e_e_1_1_scene_1_1_action>`* :ref:`reverse<doxid-class_e_e_1_1_scene_1_1_actions_1_1_tint_1ab0eeb80583226f663acc8bd338974408>`() const;
		virtual :ref:`Float<doxid-namespace_e_e_1aebd0ddfb5fe01be63ea3e3a76330fef6>` :ref:`getCurrentProgress<doxid-class_e_e_1_1_scene_1_1_actions_1_1_tint_1a2be714e52eb454558880ef7edc10951d>`();
		virtual :ref:`Time<doxid-class_e_e_1_1_system_1_1_time>` :ref:`getTotalTime<doxid-class_e_e_1_1_scene_1_1_actions_1_1_tint_1a886cf7334951c31959a95aabc330aa10>`();
		:ref:`Interpolation1d<doxid-class_e_e_1_1_math_1_1_interpolation1d>` :target:`getInterpolationR<doxid-class_e_e_1_1_scene_1_1_actions_1_1_tint_1a26dd760ce82ac280c9ba08c79c2c3620>`() const;
		void :target:`setInterpolationR<doxid-class_e_e_1_1_scene_1_1_actions_1_1_tint_1a561b3f9872df75f2fabdcb6517233680>`(const :ref:`Interpolation1d<doxid-class_e_e_1_1_math_1_1_interpolation1d>`& interpolationR);
		:ref:`Interpolation1d<doxid-class_e_e_1_1_math_1_1_interpolation1d>` :target:`getInterpolationG<doxid-class_e_e_1_1_scene_1_1_actions_1_1_tint_1acf49b5f684b3bd8d6fad7f416125daeb>`() const;
		void :target:`setInterpolationG<doxid-class_e_e_1_1_scene_1_1_actions_1_1_tint_1a485ece0fdf661707d5adfc7700f4a97c>`(const :ref:`Interpolation1d<doxid-class_e_e_1_1_math_1_1_interpolation1d>`& interpolationG);
		:ref:`Interpolation1d<doxid-class_e_e_1_1_math_1_1_interpolation1d>` :target:`getInterpolationB<doxid-class_e_e_1_1_scene_1_1_actions_1_1_tint_1ab592174c9df3676833e59efae55bcc88>`() const;
		void :target:`setInterpolationB<doxid-class_e_e_1_1_scene_1_1_actions_1_1_tint_1a1309285ffd166e1402896b032a296f41>`(const :ref:`Interpolation1d<doxid-class_e_e_1_1_math_1_1_interpolation1d>`& interpolationB);
		:ref:`Interpolation1d<doxid-class_e_e_1_1_math_1_1_interpolation1d>` :target:`getInterpolationA<doxid-class_e_e_1_1_scene_1_1_actions_1_1_tint_1ad5bd2f255cfbb89ac32ec862a374d0ae>`() const;
		void :target:`setInterpolationA<doxid-class_e_e_1_1_scene_1_1_actions_1_1_tint_1a943a83292eac9fd6d0184c8739538080>`(const :ref:`Interpolation1d<doxid-class_e_e_1_1_math_1_1_interpolation1d>`& interpolationA);
	};

Inherited Members
-----------------

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

	public:
		// typedefs
	
		typedef std::function<void(:ref:`Action<doxid-class_e_e_1_1_scene_1_1_action>`*, const :ref:`ActionType<doxid-class_e_e_1_1_scene_1_1_action_1adabaad7336d7b9b09aafcfae11d3d391>`&)> :ref:`ActionCallback<doxid-class_e_e_1_1_scene_1_1_action_1a236d5d8b4a0b0210e149e2b10398d317>`;
		typedef :ref:`Uint64<doxid-namespace_e_e_1ae05f59b032c290566852fe63cb26135c>` :ref:`UniqueID<doxid-class_e_e_1_1_scene_1_1_action_1ae3c3d93551fdf0154a7443d7f924dedf>`;

		// enums
	
		enum :ref:`ActionType<doxid-class_e_e_1_1_scene_1_1_action_1adabaad7336d7b9b09aafcfae11d3d391>`;

		// methods
	
		virtual void :ref:`start<doxid-class_e_e_1_1_scene_1_1_action_1a4e0f5a1c14da25d3e0dbca25109896e8>`() = 0;
		virtual void :ref:`stop<doxid-class_e_e_1_1_scene_1_1_action_1a5355008f8203ee02adc0981b545fcd41>`() = 0;
		virtual void :ref:`update<doxid-class_e_e_1_1_scene_1_1_action_1a3596d23c780f78198cba1d0f6d16cc78>`(const :ref:`Time<doxid-class_e_e_1_1_system_1_1_time>`& time) = 0;
		virtual bool :ref:`isDone<doxid-class_e_e_1_1_scene_1_1_action_1a872937113f0d83cc50c4dee8404c76d7>`() = 0;
		virtual :ref:`Float<doxid-namespace_e_e_1aebd0ddfb5fe01be63ea3e3a76330fef6>` :ref:`getCurrentProgress<doxid-class_e_e_1_1_scene_1_1_action_1ac2147d1f15bb7fc1998f94debd64520b>`() = 0;
		virtual :ref:`Time<doxid-class_e_e_1_1_system_1_1_time>` :ref:`getTotalTime<doxid-class_e_e_1_1_scene_1_1_action_1a3a8f0d63f79bf16496b6a6147cf67d4a>`() = 0;
		virtual :ref:`Action<doxid-class_e_e_1_1_scene_1_1_action>`* :ref:`clone<doxid-class_e_e_1_1_scene_1_1_action_1a48f42bea59447b62cfb156893187f6c3>`() const;
		virtual :ref:`Action<doxid-class_e_e_1_1_scene_1_1_action>`* :ref:`reverse<doxid-class_e_e_1_1_scene_1_1_action_1a65ad7b36c441f1bdd2cb68a13c3c8ec8>`() const;
		:ref:`Uint32<doxid-namespace_e_e_1acb11e434631749f2da0e0004d6038558>` :ref:`getFlags<doxid-class_e_e_1_1_scene_1_1_action_1ab17395e233598c3cff34350f2007a87c>`() const;
		void :ref:`setFlags<doxid-class_e_e_1_1_scene_1_1_action_1af7e0a9058430127834f919fafe872977>`(const :ref:`Uint32<doxid-namespace_e_e_1acb11e434631749f2da0e0004d6038558>`& flags);
		:ref:`UniqueID<doxid-class_e_e_1_1_scene_1_1_action_1ae3c3d93551fdf0154a7443d7f924dedf>` :ref:`getTag<doxid-class_e_e_1_1_scene_1_1_action_1a9df4e6f9ad45846b12fb1643156eb716>`() const;
		void :ref:`setTag<doxid-class_e_e_1_1_scene_1_1_action_1a163c50a6dbadb4062125d04cd4c3edcb>`(const :ref:`UniqueID<doxid-class_e_e_1_1_scene_1_1_action_1ae3c3d93551fdf0154a7443d7f924dedf>`& tag);
		:ref:`Node<doxid-class_e_e_1_1_scene_1_1_node>`* :ref:`getTarget<doxid-class_e_e_1_1_scene_1_1_action_1a64ac6a00634474cd5d9d5d768780a0f0>`() const;
		:ref:`Uint32<doxid-namespace_e_e_1acb11e434631749f2da0e0004d6038558>` :ref:`addEventListener<doxid-class_e_e_1_1_scene_1_1_action_1ae5133cc9b3ab7f519944166d965d14df>`(const :ref:`ActionType<doxid-class_e_e_1_1_scene_1_1_action_1adabaad7336d7b9b09aafcfae11d3d391>`& actionType, const :ref:`ActionCallback<doxid-class_e_e_1_1_scene_1_1_action_1a236d5d8b4a0b0210e149e2b10398d317>`& callback);
		:ref:`Action<doxid-class_e_e_1_1_scene_1_1_action>`* :ref:`on<doxid-class_e_e_1_1_scene_1_1_action_1a963751d7f67bdec82564b1e9cd6d1d23>`(const :ref:`ActionType<doxid-class_e_e_1_1_scene_1_1_action_1adabaad7336d7b9b09aafcfae11d3d391>`& actionType, const :ref:`ActionCallback<doxid-class_e_e_1_1_scene_1_1_action_1a236d5d8b4a0b0210e149e2b10398d317>`& callback);
		void :ref:`removeEventListener<doxid-class_e_e_1_1_scene_1_1_action_1a5f99e8f2c571d95e5f9135785dbf7fe1>`(const :ref:`Uint32<doxid-namespace_e_e_1acb11e434631749f2da0e0004d6038558>`& callbackId);
		void :ref:`sendEvent<doxid-class_e_e_1_1_scene_1_1_action_1a441341242c87adce9dbe18f22d867e7c>`(const :ref:`ActionType<doxid-class_e_e_1_1_scene_1_1_action_1adabaad7336d7b9b09aafcfae11d3d391>`& actionType);
		void :ref:`setTarget<doxid-class_e_e_1_1_scene_1_1_action_1a5475fa5de3dc9a9287b13ddc9ad9dcb0>`(:ref:`Node<doxid-class_e_e_1_1_scene_1_1_node>`* target);
		void :ref:`setId<doxid-class_e_e_1_1_scene_1_1_action_1a156a3353959d057df50043de895193d4>`(const :ref:`Action::UniqueID<doxid-class_e_e_1_1_scene_1_1_action_1ae3c3d93551fdf0154a7443d7f924dedf>`& id);
		const :ref:`Action::UniqueID<doxid-class_e_e_1_1_scene_1_1_action_1ae3c3d93551fdf0154a7443d7f924dedf>`& :ref:`getId<doxid-class_e_e_1_1_scene_1_1_action_1a7d2de98df89ad50aca54c31ed57b1e2c>`();

.. _details-class_e_e_1_1_scene_1_1_actions_1_1_tint:

Detailed Documentation
~~~~~~~~~~~~~~~~~~~~~~



Methods
-------

.. index:: pair: function; start
.. _doxid-class_e_e_1_1_scene_1_1_actions_1_1_tint_1a9c73f218f78affed1cda148d3b69d98d:

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

	virtual void start()

Starts the action.

.. index:: pair: function; stop
.. _doxid-class_e_e_1_1_scene_1_1_actions_1_1_tint_1ab4800087ef2b79fdbb64c0a0d9781c71:

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

	virtual void stop()

Stops the actions (pause it, it will not reset the animation state).

.. index:: pair: function; update
.. _doxid-class_e_e_1_1_scene_1_1_actions_1_1_tint_1afb0f0dc18acb5df828fe29ea26510d34:

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

	virtual void update(const :ref:`Time<doxid-class_e_e_1_1_system_1_1_time>`& time)

Update the action state (shouldn't be called manually unless you actually now what you are doing)

.. index:: pair: function; isDone
.. _doxid-class_e_e_1_1_scene_1_1_actions_1_1_tint_1a20fd3bcc177adad47c26f8c35bf13a28:

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

	virtual bool isDone()



.. rubric:: Returns:

If the action is completed.

.. index:: pair: function; clone
.. _doxid-class_e_e_1_1_scene_1_1_actions_1_1_tint_1a2f0b6a9545dff77e8d1f45c8f42fbb1a:

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

	virtual :ref:`Action<doxid-class_e_e_1_1_scene_1_1_action>`* clone() const

Clones the action.

.. index:: pair: function; reverse
.. _doxid-class_e_e_1_1_scene_1_1_actions_1_1_tint_1ab0eeb80583226f663acc8bd338974408:

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

	virtual :ref:`Action<doxid-class_e_e_1_1_scene_1_1_action>`* reverse() const

Clones and reverse the action sequence. Note: not all actions can be reversed.

.. index:: pair: function; getCurrentProgress
.. _doxid-class_e_e_1_1_scene_1_1_actions_1_1_tint_1a2be714e52eb454558880ef7edc10951d:

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

	virtual :ref:`Float<doxid-namespace_e_e_1aebd0ddfb5fe01be63ea3e3a76330fef6>` getCurrentProgress()



.. rubric:: Returns:

The current progress percentage. Normalized between 0 and 1.

.. index:: pair: function; getTotalTime
.. _doxid-class_e_e_1_1_scene_1_1_actions_1_1_tint_1a886cf7334951c31959a95aabc330aa10:

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

	virtual :ref:`Time<doxid-class_e_e_1_1_system_1_1_time>` getTotalTime()

The total action time.