.. index:: pair: class; EE::Scene::Actions::MarginMove
.. _doxid-class_e_e_1_1_scene_1_1_actions_1_1_margin_move:

class EE::Scene::Actions::MarginMove
====================================

.. toctree::
	:hidden:

	enum_EE_Scene_Actions_MarginMove_InterpolateFlag.rst

Overview
~~~~~~~~




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

	#include <marginmove.hpp>
	
	class MarginMove: public :ref:`EE::Scene::Action<doxid-class_e_e_1_1_scene_1_1_action>` {
	public:
		// enums
	
		enum :ref:`InterpolateFlag<doxid-class_e_e_1_1_scene_1_1_actions_1_1_margin_move_1aab5729a61ce667f83280f58ebe45b91e>`;

		// methods
	
		static MarginMove* :target:`New<doxid-class_e_e_1_1_scene_1_1_actions_1_1_margin_move_1a7b75b647c830e328133a25bfe7462481>`(const :ref:`Rect<doxid-namespace_e_e_1_1_math_1a6838c6a3b6d1d708b92920852358b3b8>`& start, const :ref:`Rect<doxid-namespace_e_e_1_1_math_1a6838c6a3b6d1d708b92920852358b3b8>`& end, 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:`Uint32<doxid-namespace_e_e_1acb11e434631749f2da0e0004d6038558>`& interpolateFlag = InterpolateFlag::All);
		virtual void :ref:`start<doxid-class_e_e_1_1_scene_1_1_actions_1_1_margin_move_1ac09aeb718b3fe87a90fdfe8faa02429f>`();
		virtual void :ref:`stop<doxid-class_e_e_1_1_scene_1_1_actions_1_1_margin_move_1a04c8c5ef03747f3e47735e4f532da3cb>`();
		virtual void :ref:`update<doxid-class_e_e_1_1_scene_1_1_actions_1_1_margin_move_1a5af6bc645df602c8b0e2a83860a1d12e>`(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_margin_move_1a02747836e5e5afa4468736976089ff36>`();
		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_margin_move_1a1bb0023507aa0bfa9866341f41564597>`() 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_margin_move_1a1e6b36a48a80b96cf824a2c81c46a204>`() const;
		virtual :ref:`Float<doxid-namespace_e_e_1aebd0ddfb5fe01be63ea3e3a76330fef6>` :ref:`getCurrentProgress<doxid-class_e_e_1_1_scene_1_1_actions_1_1_margin_move_1ae468ff2861c3968a19e9faca28c79325>`();
		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_margin_move_1a85d9076704d024c257b3fa4491c314fa>`();
		:ref:`Interpolation1d<doxid-class_e_e_1_1_math_1_1_interpolation1d>` :target:`getInterpolationLeft<doxid-class_e_e_1_1_scene_1_1_actions_1_1_margin_move_1adb3e47b5d2e24a5a3120f8c859ab9985>`() const;
		void :target:`setInterpolationLeft<doxid-class_e_e_1_1_scene_1_1_actions_1_1_margin_move_1ab3e4e2e395f9f35297b0a19820e700e0>`(const :ref:`Interpolation1d<doxid-class_e_e_1_1_math_1_1_interpolation1d>`& interpolationLeft);
		:ref:`Interpolation1d<doxid-class_e_e_1_1_math_1_1_interpolation1d>` :target:`getInterpolationRight<doxid-class_e_e_1_1_scene_1_1_actions_1_1_margin_move_1ae4bdeffdd04f133ecffb501016006f0f>`() const;
		void :target:`setInterpolationRight<doxid-class_e_e_1_1_scene_1_1_actions_1_1_margin_move_1af1262631f682c40fc0145e6d72bbfc36>`(const :ref:`Interpolation1d<doxid-class_e_e_1_1_math_1_1_interpolation1d>`& interpolationRight);
		:ref:`Interpolation1d<doxid-class_e_e_1_1_math_1_1_interpolation1d>` :target:`getInterpolationTop<doxid-class_e_e_1_1_scene_1_1_actions_1_1_margin_move_1ae1cabcade47df12d197bafeb6b795a10>`() const;
		void :target:`setInterpolationTop<doxid-class_e_e_1_1_scene_1_1_actions_1_1_margin_move_1a1e6c36025ab77cf277b20979b5d459cd>`(const :ref:`Interpolation1d<doxid-class_e_e_1_1_math_1_1_interpolation1d>`& interpolationTop);
		:ref:`Interpolation1d<doxid-class_e_e_1_1_math_1_1_interpolation1d>` :target:`getInterpolationBottom<doxid-class_e_e_1_1_scene_1_1_actions_1_1_margin_move_1a1baac50d189e849a79f05069b9d66091>`() const;
		void :target:`setInterpolationBottom<doxid-class_e_e_1_1_scene_1_1_actions_1_1_margin_move_1a76977b7171daf8f9bf5b873798b6dbf5>`(const :ref:`Interpolation1d<doxid-class_e_e_1_1_math_1_1_interpolation1d>`& interpolationBottom);
	};

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

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



Methods
-------

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

.. 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_margin_move_1a04c8c5ef03747f3e47735e4f532da3cb:

.. 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_margin_move_1a5af6bc645df602c8b0e2a83860a1d12e:

.. 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_margin_move_1a02747836e5e5afa4468736976089ff36:

.. 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_margin_move_1a1bb0023507aa0bfa9866341f41564597:

.. 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_margin_move_1a1e6b36a48a80b96cf824a2c81c46a204:

.. 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_margin_move_1ae468ff2861c3968a19e9faca28c79325:

.. 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_margin_move_1a85d9076704d024c257b3fa4491c314fa:

.. 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.