Added tmx animated tile support, with test case.

cocos/2d/CCTMXLayer.h

@@ -36,8 +36,11 @@ NS_CC_BEGIN
 class TMXMapInfo;
 class TMXLayerInfo;
 class TMXTilesetInfo;
+class TMXTileAnimManager;
 struct _ccCArray;
 
+
+
 /**
  * @addtogroup _2d
  * @{
@@ -294,6 +297,22 @@ class CC_DLL TMXLayer : public SpriteBatchNode
     */
     virtual std::string getDescription() const override;
 
+    /** Map from gid of animated tile to its instance.
+     *
+     * @return Map from gid of animated tile to its instance.
+     */
+    const std::map<uint32_t, std::vector<Vec2>>* getAnimTileCoord() {
+        return &_animTileCoord;
+    }
+
+    bool hasTileAnimation() {
+        return !_animTileCoord.empty();
+    }
+
+    TMXTileAnimManager* getTileAnimManager() {
+        return _tileAnimManager;
+    }
+
 protected:
     Vec2 getPositionForIsoAt(const Vec2& pos);
     Vec2 getPositionForOrthoAt(const Vec2& pos);
@@ -353,6 +372,55 @@ class CC_DLL TMXLayer : public SpriteBatchNode
     int _hexSideLength;
     /** properties from the layer. They can be added using Tiled */
     ValueMap _properties;
+
+    /** map from gid of animated tile to its instance. Also useful for optimization*/
+    std::map<uint32_t, std::vector<Vec2>> _animTileCoord;
+    /** pointer to the tile animation manager of this layer */
+    TMXTileAnimManager *_tileAnimManager = nullptr;
+};
+
+/** @brief TMXTileAnimTask represents the frame-tick task of an animated tile.
+ * It is a assistant class for TMXTileAnimTicker.
+ */
+class TMXTileAnimTask
+{
+public:
+    TMXTileAnimTask(TMXLayer *layer, TMXTileAnimInfo *animation, Vec2 &tilePos);
+    void tick(float dt);
+    void scheduleNextTick();
+    void unschedule();
+
+protected:
+    bool _started;
+    /** key of schedule task for specific animated tile */
+    std::string _key;
+    TMXLayer *_layer;
+    /** position of the animated tile */
+    Vec2 _tilePosition;
+    /** AnimationInfo on this tile */
+    TMXTileAnimInfo *_animation;
+    /** Index of the frame that should be drawn currently */
+    uint32_t _currentFrame;
+    uint32_t _frameCount;
+};
+
+/** @brief TMXTileAnimManager controls all tile animation of a layer.
+ */
+class TMXTileAnimManager : public Ref
+{
+public:
+    static TMXTileAnimManager * create(TMXLayer *layer);
+    explicit TMXTileAnimManager(TMXLayer *layer);
+
+    /** start tile animations */
+    void start();
+    /** stop tile animations */
+    void stop();
+
+    bool _started = false;
+    /** vector contains all tasks of this layer */
+    std::vector<TMXTileAnimTask> _tasks;
+    TMXLayer* _layer;
 };
 
 // end of tilemap_parallax_nodes group

cocos/2d/CCTMXTiledMap.cpp

@@ -273,4 +273,22 @@ int TMXTiledMap::getLayerNum()
     return _tmxLayerNum;
 }
 
+void TMXTiledMap::setTileAnimEnabled(bool enabled)
+{
+    for (auto& child : _children)
+    {
+        TMXLayer* layer = dynamic_cast<TMXLayer*>(child);
+        if(layer)
+        {
+            if(layer->hasTileAnimation())
+            {
+                if(enabled)
+                    layer->getTileAnimManager()->start();
+                else
+                    layer->getTileAnimManager()->stop();
+            }
+        }
+    }
+}
+
 NS_CC_END

cocos/2d/CCTMXTiledMap.h

@@ -276,6 +276,11 @@ class CC_DLL TMXTiledMap : public Node
     int  getLayerNum();
     const std::string& getResourceFile() const { return _tmxFile; }
 
+    /** Set all tile animations enabled or not.
+     *  animations are not enabled by default
+     */
+    void setTileAnimEnabled(bool enabled);
+
 CC_CONSTRUCTOR_ACCESS:
     /**
      * @js ctor

cocos/2d/CCTMXXMLParser.cpp

@@ -672,6 +672,21 @@ void TMXMapInfo::startElement(void* /*ctx*/, const char *name, const char **atts
             dict["polylinePoints"] = Value(pointsArray);
         }
     }
+    else if(elementName == "animation")
+    {
+        TMXTilesetInfo* info = tmxMapInfo->getTilesets().back();
+        info->_animationInfo.insert(tmxMapInfo->getParentGID(), TMXTileAnimInfo::create(tmxMapInfo->getParentGID()));
+        //tmxMapInfo->setParentGID(info->_firstGid + attributeDict["id"].asInt());
+        //tmxMapInfo->getTileProperties()[tmxMapInfo->getParentGID()] = Value(ValueMap());
+        tmxMapInfo->setParentElement(TMXPropertyAnimation);
+    }
+    else if(elementName == "frame")
+    {
+        TMXTilesetInfo* info = tmxMapInfo->getTilesets().back();
+        auto animInfo = info->_animationInfo.at(tmxMapInfo->getParentGID());
+        // calculate gid of frame
+        animInfo->_frames.emplace_back(TMXTileAnimFrame(info->_firstGid + attributeDict["tileid"].asInt(), attributeDict["duration"].asFloat()));
+    }
 }
 
 void TMXMapInfo::endElement(void* /*ctx*/, const char *name)
@@ -792,6 +807,10 @@ void TMXMapInfo::endElement(void* /*ctx*/, const char *name)
     {
         _recordFirstGID = true;
     }
+    else if (elementName == "animation")
+    {
+        tmxMapInfo->setParentElement(TMXPropertyNone);
+    }
 }
 
 void TMXMapInfo::textHandler(void* /*ctx*/, const char *ch, size_t len)
@@ -807,4 +826,30 @@ void TMXMapInfo::textHandler(void* /*ctx*/, const char *ch, size_t len)
     }
 }
 
+TMXTileAnimFrame::TMXTileAnimFrame(uint32_t tileID, float duration)
+{
+    _tileID = tileID;
+    _duration = duration;
+}
+
+TMXTileAnimInfo::TMXTileAnimInfo(uint32_t tileID)
+{
+    _tileID = tileID;
+}
+
+TMXTileAnimInfo *TMXTileAnimInfo::create(uint32_t tileID)
+{
+    TMXTileAnimInfo *ret = new (std::nothrow) TMXTileAnimInfo(tileID);
+    if (ret)
+    {
+        ret->autorelease();
+        return ret;
+    }
+    CC_SAFE_DELETE(ret);
+    return nullptr;
+}
+
 NS_CC_END
+
+
+

cocos/2d/CCTMXXMLParser.h

@@ -36,6 +36,7 @@ THE SOFTWARE.
 #include "platform/CCSAXParser.h"
 #include "base/CCVector.h"
 #include "base/CCValue.h"
+#include "base/CCMap.h"
 #include "2d/CCTMXObjectGroup.h" // needed for Vector<TMXObjectGroup*> for binding
 
 #include <string>
@@ -72,7 +73,8 @@ enum {
     TMXPropertyLayer,
     TMXPropertyObjectGroup,
     TMXPropertyObject,
-    TMXPropertyTile
+    TMXPropertyTile,
+    TMXPropertyAnimation
 };
 
 typedef enum TMXTileFlags_ {
@@ -119,6 +121,35 @@ class CC_DLL TMXLayerInfo : public Ref
     Vec2               _offset;
 };
 
+/** @brief TMXTileAnimFrame contains the information about the frame of a animated tile like:
+- Frame gid
+- duration of this frame
+
+This information is obtained from the TMX file.
+*/
+struct TMXTileAnimFrame
+{
+    TMXTileAnimFrame(uint32_t tileID, float duration);
+    /** gid of the frame */
+    uint32_t _tileID;
+    /** duration of the frame */
+    float _duration;
+};
+
+/** @brief TMXTileAnimInfo contains the information about the animated tile like:
+- Animated Tile gid
+- frames the animated tile contains
+
+This information is obtained from the TMX file.
+*/
+struct TMXTileAnimInfo : public Ref
+{
+    static TMXTileAnimInfo * create(uint32_t  tileID);
+    explicit TMXTileAnimInfo(uint32_t  tileID);
+    uint32_t _tileID;
+    std::vector<TMXTileAnimFrame> _frames;
+};
+
 /** @brief TMXTilesetInfo contains the information about the tilesets like:
 - Tileset name
 - Tileset spacing
@@ -144,6 +175,9 @@ class CC_DLL TMXTilesetInfo : public Ref
     Size            _imageSize;
     std::string     _originSourceImage;
 
+    //! map from gid of animated tile to its animation info
+    Map<uint32_t, TMXTileAnimInfo*> _animationInfo;
+
 public:
     /**
      * @js ctor

tests/cpp-tests/Classes/TileMapTest/TileMapTest.cpp

@@ -80,6 +80,7 @@ TileMapTests::TileMapTests()
     ADD_TEST_CASE(TMXHexAxisXTest);
     ADD_TEST_CASE(Issue16105Test);
     ADD_TEST_CASE(Issue16512Test);
+    ADD_TEST_CASE(TileAnimTest);
 }
 
 TileDemo::TileDemo()
@@ -1722,3 +1723,35 @@ std::string Issue16512Test::title() const
 {
     return "Github Issue #16512. Should not crash";
 }
+
+//------------------------------------------------------------------
+//
+// TileAnimationTest
+//
+//------------------------------------------------------------------
+TileAnimTest::TileAnimTest()
+{
+
+    map = TMXTiledMap::create("TileMaps/tile_animation_test.tmx");
+    addChild(map, 0, kTagTileMap);
+
+    auto listener = EventListenerTouchAllAtOnce::create();
+    listener->onTouchesBegan= CC_CALLBACK_2(TileAnimTest::onTouchBegan, this);
+    _eventDispatcher->addEventListenerWithSceneGraphPriority(listener, this);
+
+    Size CC_UNUSED s = map->getContentSize();
+    CCLOG("ContentSize: %f, %f", s.width,s.height);
+
+    map->setTileAnimEnabled(true);
+}
+
+std::string TileAnimTest::title() const
+{
+    return "Tile animation test. Click to toggle the animation";
+}
+
+void TileAnimTest::onTouchBegan(const std::vector<cocos2d::Touch*>& touches, cocos2d::Event* event)
+{
+    _animStarted = !_animStarted;
+    map->setTileAnimEnabled(_animStarted);
+}

tests/cpp-tests/Classes/TileMapTest/TileMapTest.h

@@ -412,4 +412,16 @@ class Issue16512Test : public TileDemo
 
 };
 
+class TileAnimTest : public TileDemo
+{
+public:
+    CREATE_FUNC(TileAnimTest);
+    TileAnimTest();
+    virtual std::string title() const override;
+
+    cocos2d::TMXTiledMap* map;
+    bool _animStarted = false;
+    void onTouchBegan(const std::vector<cocos2d::Touch*>& touches, cocos2d::Event* event);
+};
+
 #endif

tests/cpp-tests/Resources/TileMaps/tile_animation_test.tmx

@@ -0,0 +1,33 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<map version="1.2" tiledversion="1.2.5" orientation="orthogonal" renderorder="right-down" width="10" height="10" tilewidth="32" tileheight="32" infinite="0" nextlayerid="4" nextobjectid="1">
+ <tileset firstgid="1" name="tileset" tilewidth="32" tileheight="32" spacing="1" margin="1" tilecount="48" columns="8">
+  <image source="./tmw_desert_spacing.png" width="265" height="199"/>
+  <tile id="0">
+   <animation>
+    <frame tileid="37" duration="200"/>
+    <frame tileid="39" duration="200"/>
+   </animation>
+  </tile>
+  <tile id="1">
+   <animation>
+    <frame tileid="46" duration="200"/>
+    <frame tileid="47" duration="200"/>
+   </animation>
+  </tile>
+ </tileset>
+ <layer id="1" name="Tile Layer 1" width="10" height="10">
+  <data encoding="base64" compression="zlib">
+   eJyTY2BgkBvFgwYDAEFHC7k=
+  </data>
+ </layer>
+ <layer id="2" name="Tile Layer 2" width="10" height="10">
+  <data encoding="base64" compression="zlib">
+   eJxjYCAeMBLAtFI3kgAAHeAAGQ==
+  </data>
+ </layer>
+ <layer id="3" name="Tile Layer 3" width="10" height="10">
+  <data encoding="base64" compression="zlib">
+   eJxjYBg+gIkAppU6agIAHDAAMQ==
+  </data>
+ </layer>
+</map>