.. index:: pair: class; EE::UI::CSS::StyleSheetPropertyAnimation .. _doxid-class_e_e_1_1_u_i_1_1_c_s_s_1_1_style_sheet_property_animation: class EE::UI::CSS::StyleSheetPropertyAnimation ============================================== .. toctree:: :hidden: Overview ~~~~~~~~ .. ref-code-block:: cpp :class: doxyrest-overview-code-block #include class StyleSheetPropertyAnimation: public :ref:`EE::Scene::Action` { public: // fields static constexpr :ref:`String::HashType` :target:`ID` = :ref:`String::hash`("StyleSheetPropertyAnimation"); // methods static void :target:`tweenProperty`( :ref:`UIWidget`* widget, const :ref:`Float`& normalizedProgress, const :ref:`PropertyDefinition`* property, const std::string& startValue, const std::string& endValue, const :ref:`Ease::Interpolation`& timingFunction, const std::vector timingFunctionParameters, const :ref:`Uint32`& propertyIndex, const bool& isDone ); static StyleSheetPropertyAnimation* :target:`fromAnimationKeyframes`(const :ref:`AnimationDefinition`& animation, const :ref:`KeyframesDefinition`& keyframes, const :ref:`PropertyDefinition`* propertyDef, :ref:`UIWidget`* widget, const :ref:`Uint32`& propertyIndex, const :ref:`AnimationOrigin`& animationOrigin = :ref:`AnimationOrigin::Animation`); static bool :target:`animationSupported`(const :ref:`PropertyType`& type); static StyleSheetPropertyAnimation* :target:`New`(const :ref:`AnimationDefinition`& animation, const :ref:`PropertyDefinition`* propertyDef, std::vector states, std::vector<:ref:`Float`> animationStepsTime, const :ref:`Uint32`& propertyIndex, const :ref:`AnimationOrigin`& animationOrigin); static StyleSheetPropertyAnimation* :target:`New`( const :ref:`PropertyDefinition`* property, const std::string& startValue, const std::string& endValue, const :ref:`Uint32`& propertyIndex, const :ref:`Time`& duration, const :ref:`Time`& delay, const :ref:`Ease::Interpolation`& timingFunction, const std::vector& timingFunctionParameters, const :ref:`AnimationOrigin`& animationOrigin ); virtual void :ref:`start`(); virtual void :ref:`stop`(); virtual void :ref:`update`(const :ref:`Time`& time); virtual bool :ref:`isDone`(); virtual :ref:`Float` :ref:`getCurrentProgress`(); virtual :ref:`Time` :ref:`getTotalTime`(); virtual :ref:`Action`* :ref:`clone`() const; virtual :ref:`Action`* :ref:`reverse`() const; const :ref:`Uint32`& :target:`getPropertyIndex`() const; const std::string& :target:`getStartValue`() const; const std::string& :target:`getEndValue`() const; const :ref:`Time`& :target:`getElapsed`() const; void :target:`setElapsed`(const :ref:`Time`& elapsed); const :ref:`AnimationOrigin`& :target:`getAnimationOrigin`() const; void :target:`setRunning`(const bool& running); void :target:`setPaused`(const bool& paused); void :target:`notifyClose`(); const :ref:`AnimationDefinition`& :target:`getAnimation`() const; }; Inherited Members ----------------- .. ref-code-block:: cpp :class: doxyrest-overview-inherited-code-block public: // typedefs typedef std::function`*, const :ref:`ActionType`&)> :ref:`ActionCallback`; typedef :ref:`Uint64` :ref:`UniqueID`; // enums enum :ref:`ActionType`; // methods virtual void :ref:`start`() = 0; virtual void :ref:`stop`() = 0; virtual void :ref:`update`(const :ref:`Time`& time) = 0; virtual bool :ref:`isDone`() = 0; virtual :ref:`Float` :ref:`getCurrentProgress`() = 0; virtual :ref:`Time` :ref:`getTotalTime`() = 0; virtual :ref:`Action`* :ref:`clone`() const; virtual :ref:`Action`* :ref:`reverse`() const; :ref:`Uint32` :ref:`getFlags`() const; void :ref:`setFlags`(const :ref:`Uint32`& flags); :ref:`UniqueID` :ref:`getTag`() const; void :ref:`setTag`(const :ref:`UniqueID`& tag); :ref:`Node`* :ref:`getTarget`() const; :ref:`Uint32` :ref:`addEventListener`(const :ref:`ActionType`& actionType, const :ref:`ActionCallback`& callback); :ref:`Action`* :ref:`on`(const :ref:`ActionType`& actionType, const :ref:`ActionCallback`& callback); void :ref:`removeEventListener`(const :ref:`Uint32`& callbackId); void :ref:`sendEvent`(const :ref:`ActionType`& actionType); void :ref:`setTarget`(:ref:`Node`* target); void :ref:`setId`(const :ref:`Action::UniqueID`& id); const :ref:`Action::UniqueID`& :ref:`getId`(); .. _details-class_e_e_1_1_u_i_1_1_c_s_s_1_1_style_sheet_property_animation: Detailed Documentation ~~~~~~~~~~~~~~~~~~~~~~ Methods ------- .. index:: pair: function; start .. _doxid-class_e_e_1_1_u_i_1_1_c_s_s_1_1_style_sheet_property_animation_1a1b5292e46da31ab640c0e553e88889b4: .. 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_u_i_1_1_c_s_s_1_1_style_sheet_property_animation_1a1e0eeea4475413dd49a50e8ec5e8d22b: .. 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_u_i_1_1_c_s_s_1_1_style_sheet_property_animation_1a13777987817b027781994bd5bc1c51df: .. ref-code-block:: cpp :class: doxyrest-title-code-block virtual void update(const :ref:`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_u_i_1_1_c_s_s_1_1_style_sheet_property_animation_1a461df6dde6aa00f2791a81a9a7c0de91: .. ref-code-block:: cpp :class: doxyrest-title-code-block virtual bool isDone() .. rubric:: Returns: If the action is completed. .. index:: pair: function; getCurrentProgress .. _doxid-class_e_e_1_1_u_i_1_1_c_s_s_1_1_style_sheet_property_animation_1a8009d53a87ed87a64a1fb29c138d611b: .. ref-code-block:: cpp :class: doxyrest-title-code-block virtual :ref:`Float` getCurrentProgress() .. rubric:: Returns: The current progress percentage. Normalized between 0 and 1. .. index:: pair: function; getTotalTime .. _doxid-class_e_e_1_1_u_i_1_1_c_s_s_1_1_style_sheet_property_animation_1a6334a53047e98c1e0ab02648d3668764: .. ref-code-block:: cpp :class: doxyrest-title-code-block virtual :ref:`Time` getTotalTime() The total action time. .. index:: pair: function; clone .. _doxid-class_e_e_1_1_u_i_1_1_c_s_s_1_1_style_sheet_property_animation_1a7956a2c0850d304482b2a2666148ceba: .. ref-code-block:: cpp :class: doxyrest-title-code-block virtual :ref:`Action`* clone() const Clones the action. .. index:: pair: function; reverse .. _doxid-class_e_e_1_1_u_i_1_1_c_s_s_1_1_style_sheet_property_animation_1a5d9dd8fbbef4805d7097ef966d9929a1: .. ref-code-block:: cpp :class: doxyrest-title-code-block virtual :ref:`Action`* reverse() const Clones and reverse the action sequence. Note: not all actions can be reversed.