.. index:: pair: class; EE::Scene::Action
.. _doxid-class_e_e_1_1_scene_1_1_action:

class EE::Scene::Action
=======================

.. toctree::
	:hidden:

	enum_EE_Scene_Action_ActionType.rst

Overview
~~~~~~~~




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

	#include <action.hpp>
	
	class Action {
	public:
		// typedefs
	
		typedef std::function<void(Action*, const :ref:`ActionType<doxid-class_e_e_1_1_scene_1_1_action_1adabaad7336d7b9b09aafcfae11d3d391>`&)> :target:`ActionCallback<doxid-class_e_e_1_1_scene_1_1_action_1a236d5d8b4a0b0210e149e2b10398d317>`;
		typedef :ref:`Uint64<doxid-namespace_e_e_1ae05f59b032c290566852fe63cb26135c>` :target:`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>`;

		// construction
	
		virtual :target:`~Action<doxid-class_e_e_1_1_scene_1_1_action_1a1e6aaa4ef5db469e3367a726cb0f62c5>`();

		// 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 Action* :ref:`clone<doxid-class_e_e_1_1_scene_1_1_action_1a48f42bea59447b62cfb156893187f6c3>`() const;
		virtual 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);
		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_action:

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



Methods
-------

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

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

	virtual void start() = 0

Starts the action.

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

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

	virtual void stop() = 0

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_action_1a3596d23c780f78198cba1d0f6d16cc78:

.. 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) = 0

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_action_1a872937113f0d83cc50c4dee8404c76d7:

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

	virtual bool isDone() = 0



.. rubric:: Returns:

If the action is completed.

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

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

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



.. rubric:: Returns:

The current progress percentage. Normalized between 0 and 1.

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

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

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

The total action time.

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

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

	virtual Action* clone() const

Clones the action.

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

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

	virtual Action* reverse() const

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

.. index:: pair: function; getFlags
.. _doxid-class_e_e_1_1_scene_1_1_action_1ab17395e233598c3cff34350f2007a87c:

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

	:ref:`Uint32<doxid-namespace_e_e_1acb11e434631749f2da0e0004d6038558>` getFlags() const



.. rubric:: Returns:

The action custom flags.

.. index:: pair: function; setFlags
.. _doxid-class_e_e_1_1_scene_1_1_action_1af7e0a9058430127834f919fafe872977:

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

	void setFlags(const :ref:`Uint32<doxid-namespace_e_e_1acb11e434631749f2da0e0004d6038558>`& flags)

Sets the action custom flags.

.. index:: pair: function; getTag
.. _doxid-class_e_e_1_1_scene_1_1_action_1a9df4e6f9ad45846b12fb1643156eb716:

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

	:ref:`UniqueID<doxid-class_e_e_1_1_scene_1_1_action_1ae3c3d93551fdf0154a7443d7f924dedf>` getTag() const



.. rubric:: Returns:

The action tag.

.. index:: pair: function; setTag
.. _doxid-class_e_e_1_1_scene_1_1_action_1a163c50a6dbadb4062125d04cd4c3edcb:

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

	void setTag(const :ref:`UniqueID<doxid-class_e_e_1_1_scene_1_1_action_1ae3c3d93551fdf0154a7443d7f924dedf>`& tag)

Sets a tag to identify and filter actions.

.. index:: pair: function; getTarget
.. _doxid-class_e_e_1_1_scene_1_1_action_1a64ac6a00634474cd5d9d5d768780a0f0:

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

	:ref:`Node<doxid-class_e_e_1_1_scene_1_1_node>`* getTarget() const

The target node that the action is being applied.

.. index:: pair: function; addEventListener
.. _doxid-class_e_e_1_1_scene_1_1_action_1ae5133cc9b3ab7f519944166d965d14df:

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

	:ref:`Uint32<doxid-namespace_e_e_1acb11e434631749f2da0e0004d6038558>` addEventListener(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)

Adds an event listener for a specific :ref:`Action::ActionType <doxid-class_e_e_1_1_scene_1_1_action_1adabaad7336d7b9b09aafcfae11d3d391>`.



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- actionType

		- The action type to receive the event notification.

	*
		- callback

		- The callback to receive the event notification.



.. rubric:: Returns:

An unique event callback ID. This can be use to remove the event listener with :ref:`Action::removeEventListener <doxid-class_e_e_1_1_scene_1_1_action_1a5f99e8f2c571d95e5f9135785dbf7fe1>`.

.. index:: pair: function; on
.. _doxid-class_e_e_1_1_scene_1_1_action_1a963751d7f67bdec82564b1e9cd6d1d23:

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

	Action* on(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)

Same as :ref:`Action::addEventListener <doxid-class_e_e_1_1_scene_1_1_action_1ae5133cc9b3ab7f519944166d965d14df>`

.. index:: pair: function; removeEventListener
.. _doxid-class_e_e_1_1_scene_1_1_action_1a5f99e8f2c571d95e5f9135785dbf7fe1:

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

	void removeEventListener(const :ref:`Uint32<doxid-namespace_e_e_1acb11e434631749f2da0e0004d6038558>`& callbackId)

Removes an event listener previusly added.



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- callbackId

		- The ID of the event listener returned by the :ref:`Action::addEventListener <doxid-class_e_e_1_1_scene_1_1_action_1ae5133cc9b3ab7f519944166d965d14df>` call.

.. index:: pair: function; sendEvent
.. _doxid-class_e_e_1_1_scene_1_1_action_1a441341242c87adce9dbe18f22d867e7c:

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

	void sendEvent(const :ref:`ActionType<doxid-class_e_e_1_1_scene_1_1_action_1adabaad7336d7b9b09aafcfae11d3d391>`& actionType)

Manually emmit an event of type :ref:`Action::ActionType <doxid-class_e_e_1_1_scene_1_1_action_1adabaad7336d7b9b09aafcfae11d3d391>`.

.. index:: pair: function; setTarget
.. _doxid-class_e_e_1_1_scene_1_1_action_1a5475fa5de3dc9a9287b13ddc9ad9dcb0:

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

	void setTarget(:ref:`Node<doxid-class_e_e_1_1_scene_1_1_node>`* target)

Sets the action :ref:`EE::Scene::Node <doxid-class_e_e_1_1_scene_1_1_node>` target.

.. index:: pair: function; setId
.. _doxid-class_e_e_1_1_scene_1_1_action_1a156a3353959d057df50043de895193d4:

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

	void setId(const :ref:`Action::UniqueID<doxid-class_e_e_1_1_scene_1_1_action_1ae3c3d93551fdf0154a7443d7f924dedf>`& id)

Sets a unique ID to identify the action.

.. index:: pair: function; getId
.. _doxid-class_e_e_1_1_scene_1_1_action_1a7d2de98df89ad50aca54c31ed57b1e2c:

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

	const :ref:`Action::UniqueID<doxid-class_e_e_1_1_scene_1_1_action_1ae3c3d93551fdf0154a7443d7f924dedf>`& getId()



.. rubric:: Returns:

The unique action ID.