Merge pull request #129 from cschreib/animation

Tweak and fixes for animation

Author: cschreib

include/lxgui/gui_animated_texture.hpp

@@ -57,7 +57,7 @@ class animated_texture : public layered_region {
     float get_state() const;
 
     /**
-     * \brief Check if this animated_texture is paused
+     * \brief Check if this animated_texture is paused.
      * \return 'true' if paused, 'false' otherwise
      */
     float is_paused() const;
@@ -90,11 +90,35 @@ class animated_texture : public layered_region {
     void set_state(float state);
 
     /**
-     * \brief Check if this animated_texture is paused
-     * \return 'true' if paused, 'false' otherwise
+     * \brief Play or pause this animated_texture.
+     * \param is_paused 'true' to pause, 'false' to play
      */
     void set_paused(bool is_paused);
 
+    /**
+     * \brief Play this animated_texture.
+     * \note Has no effect if already playing
+     */
+    void play() {
+        set_paused(false);
+    }
+
+    /**
+     * \brief Pause this animated_texture.
+     * \note Has no effect if already paused
+     */
+    void pause() {
+        set_paused(true);
+    }
+
+    /**
+     * \brief Stop this animated_texture (stop playing and reset to start).
+     */
+    void stop() {
+        set_paused(true);
+        set_state(0.0f);
+    }
+
     /**
      * \brief Sets this texture's texture file.
      * \param file_name The file from which to read data

src/gui_animated_texture_glues.cpp

@@ -46,6 +46,18 @@ void animated_texture::register_on_lua(sol::state& lua) {
         return std::make_tuple(color.r, color.g, color.b, color.a);
     });
 
+    /** @function pause
+     */
+    type.set_function("pause", member_function<&animated_texture::pause>());
+
+    /** @function play
+     */
+    type.set_function("play", member_function<&animated_texture::play>());
+
+    /** @function stop
+     */
+    type.set_function("stop", member_function<&animated_texture::stop>());
+
     /** @function set_speed
      */
     type.set_function("set_speed", member_function<&animated_texture::set_speed>());