2019-11-23 20:27:39 +08:00
|
|
|
/****************************************************************************
|
|
|
|
Copyright (c) 2009-2010 Ricardo Quesada
|
|
|
|
Copyright (c) 2010-2012 cocos2d-x.org
|
|
|
|
Copyright (c) 2011 Zynga Inc.
|
|
|
|
Copyright (c) 2013-2016 Chukong Technologies Inc.
|
|
|
|
Copyright (c) 2017-2018 Xiamen Yaji Software Co., Ltd.
|
|
|
|
|
|
|
|
http://www.cocos2d-x.org
|
|
|
|
|
|
|
|
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
|
|
of this software and associated documentation files (the "Software"), to deal
|
|
|
|
in the Software without restriction, including without limitation the rights
|
|
|
|
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
|
|
copies of the Software, and to permit persons to whom the Software is
|
|
|
|
furnished to do so, subject to the following conditions:
|
|
|
|
|
|
|
|
The above copyright notice and this permission notice shall be included in
|
|
|
|
all copies or substantial portions of the Software.
|
|
|
|
|
|
|
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
|
|
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
|
|
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
|
|
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
|
|
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
|
|
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
|
|
|
THE SOFTWARE.
|
|
|
|
****************************************************************************/
|
|
|
|
|
|
|
|
#ifndef __CC_TM_XML_PARSER__
|
|
|
|
#define __CC_TM_XML_PARSER__
|
|
|
|
|
|
|
|
/// @cond DO_NOT_SHOW
|
|
|
|
|
2021-10-23 23:27:14 +08:00
|
|
|
#include "math/CCMath.h"
|
2019-11-23 20:27:39 +08:00
|
|
|
#include "platform/CCSAXParser.h"
|
|
|
|
#include "base/CCVector.h"
|
2020-08-28 16:33:52 +08:00
|
|
|
#include "base/CCMap.h"
|
2019-11-23 20:27:39 +08:00
|
|
|
#include "base/CCValue.h"
|
2021-12-25 10:04:45 +08:00
|
|
|
#include "2d/CCTMXObjectGroup.h" // needed for Vector<TMXObjectGroup*> for binding
|
2019-11-23 20:27:39 +08:00
|
|
|
|
|
|
|
#include <string>
|
|
|
|
|
|
|
|
NS_CC_BEGIN
|
|
|
|
|
|
|
|
class TMXLayerInfo;
|
|
|
|
class TMXTilesetInfo;
|
|
|
|
|
|
|
|
/** @file
|
2021-12-25 10:04:45 +08:00
|
|
|
* Internal TMX parser
|
|
|
|
*
|
|
|
|
* IMPORTANT: These classed should not be documented using doxygen strings
|
|
|
|
* since the user should not use them.
|
|
|
|
*
|
|
|
|
*/
|
2019-11-23 20:27:39 +08:00
|
|
|
|
|
|
|
/**
|
|
|
|
* @addtogroup tilemap_parallax_nodes
|
|
|
|
* @{
|
|
|
|
*/
|
|
|
|
|
2021-12-25 10:04:45 +08:00
|
|
|
enum
|
|
|
|
{
|
|
|
|
TMXLayerAttribNone = 1 << 0,
|
2019-11-23 20:27:39 +08:00
|
|
|
TMXLayerAttribBase64 = 1 << 1,
|
2021-12-25 10:04:45 +08:00
|
|
|
TMXLayerAttribGzip = 1 << 2,
|
|
|
|
TMXLayerAttribZlib = 1 << 3,
|
|
|
|
TMXLayerAttribCSV = 1 << 4,
|
2019-11-23 20:27:39 +08:00
|
|
|
};
|
|
|
|
|
2021-12-25 10:04:45 +08:00
|
|
|
enum
|
|
|
|
{
|
2019-11-23 20:27:39 +08:00
|
|
|
TMXPropertyNone,
|
|
|
|
TMXPropertyMap,
|
|
|
|
TMXPropertyLayer,
|
|
|
|
TMXPropertyObjectGroup,
|
|
|
|
TMXPropertyObject,
|
2020-08-28 16:33:52 +08:00
|
|
|
TMXPropertyTile,
|
|
|
|
TMXPropertyAnimation
|
2019-11-23 20:27:39 +08:00
|
|
|
};
|
|
|
|
|
2021-12-25 10:04:45 +08:00
|
|
|
typedef enum TMXTileFlags_
|
|
|
|
{
|
|
|
|
kTMXTileHorizontalFlag = 0x80000000,
|
|
|
|
kTMXTileVerticalFlag = 0x40000000,
|
|
|
|
kTMXTileDiagonalFlag = 0x20000000,
|
|
|
|
kTMXFlipedAll = (kTMXTileHorizontalFlag | kTMXTileVerticalFlag | kTMXTileDiagonalFlag),
|
|
|
|
kTMXFlippedMask = ~(kTMXFlipedAll)
|
2019-11-23 20:27:39 +08:00
|
|
|
} TMXTileFlags;
|
|
|
|
|
2020-08-28 15:42:40 +08:00
|
|
|
/**
|
|
|
|
* @addtogroup _2d
|
|
|
|
* @{
|
|
|
|
*/
|
|
|
|
|
2021-12-25 10:04:45 +08:00
|
|
|
/** Possible orientations of the TMX map. */
|
2020-08-28 15:42:40 +08:00
|
|
|
enum
|
|
|
|
{
|
|
|
|
/** Orthogonal orientation. */
|
|
|
|
TMXOrientationOrtho,
|
|
|
|
|
|
|
|
/** Hexagonal orientation. */
|
|
|
|
TMXOrientationHex,
|
|
|
|
|
|
|
|
/** Isometric orientation. */
|
|
|
|
TMXOrientationIso,
|
|
|
|
|
|
|
|
/** Isometric staggered orientation. */
|
|
|
|
TMXOrientationStaggered,
|
|
|
|
};
|
|
|
|
|
|
|
|
/** Possible stagger axis of the TMX map. */
|
|
|
|
enum
|
|
|
|
{
|
|
|
|
/** Stagger Axis x. */
|
|
|
|
TMXStaggerAxis_X,
|
|
|
|
|
|
|
|
/** Stagger Axis y. */
|
|
|
|
TMXStaggerAxis_Y,
|
|
|
|
};
|
|
|
|
|
|
|
|
/** Possible stagger index of the TMX map. */
|
|
|
|
enum
|
|
|
|
{
|
|
|
|
/** Stagger Index: Odd */
|
|
|
|
TMXStaggerIndex_Odd,
|
|
|
|
|
|
|
|
/** Stagger Index: Even */
|
|
|
|
TMXStaggerIndex_Even,
|
|
|
|
};
|
|
|
|
|
2020-08-28 16:33:52 +08:00
|
|
|
/** @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 CC_DLL TMXTileAnimFrame
|
|
|
|
{
|
|
|
|
TMXTileAnimFrame(uint32_t tileID, float duration);
|
|
|
|
/** gid of the frame */
|
|
|
|
uint32_t _tileID = 0;
|
|
|
|
/** duration of the frame */
|
|
|
|
float _duration = 0.0f;
|
|
|
|
};
|
|
|
|
|
|
|
|
/** @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 CC_DLL TMXTileAnimInfo : public Ref
|
|
|
|
{
|
2021-12-25 10:04:45 +08:00
|
|
|
static TMXTileAnimInfo* create(uint32_t tileID);
|
|
|
|
explicit TMXTileAnimInfo(uint32_t tileID);
|
2020-08-28 16:33:52 +08:00
|
|
|
uint32_t _tileID = 0;
|
|
|
|
std::vector<TMXTileAnimFrame> _frames;
|
|
|
|
};
|
|
|
|
|
2019-11-23 20:27:39 +08:00
|
|
|
// Bits on the far end of the 32-bit global tile ID (GID's) are used for tile flags
|
|
|
|
|
|
|
|
/** @brief TMXLayerInfo contains the information about the layers like:
|
|
|
|
- Layer name
|
|
|
|
- Layer size
|
|
|
|
- Layer opacity at creation time (it can be modified at runtime)
|
|
|
|
- Whether the layer is visible (if it's not visible, then the CocosNode won't be created)
|
|
|
|
|
|
|
|
This information is obtained from the TMX file.
|
|
|
|
*/
|
|
|
|
class CC_DLL TMXLayerInfo : public Ref
|
|
|
|
{
|
|
|
|
public:
|
|
|
|
/**
|
|
|
|
* @js ctor
|
|
|
|
*/
|
|
|
|
TMXLayerInfo();
|
|
|
|
/**
|
|
|
|
* @js NA
|
|
|
|
* @lua NA
|
|
|
|
*/
|
|
|
|
virtual ~TMXLayerInfo();
|
|
|
|
|
|
|
|
void setProperties(ValueMap properties);
|
|
|
|
ValueMap& getProperties();
|
|
|
|
|
2021-12-25 10:04:45 +08:00
|
|
|
ValueMap _properties;
|
|
|
|
std::string _name;
|
|
|
|
Vec2 _layerSize;
|
|
|
|
uint32_t* _tiles;
|
|
|
|
bool _visible;
|
|
|
|
unsigned char _opacity;
|
|
|
|
bool _ownTiles;
|
|
|
|
Vec2 _offset;
|
2019-11-23 20:27:39 +08:00
|
|
|
};
|
|
|
|
|
|
|
|
/** @brief TMXTilesetInfo contains the information about the tilesets like:
|
|
|
|
- Tileset name
|
|
|
|
- Tileset spacing
|
|
|
|
- Tileset margin
|
|
|
|
- size of the tiles
|
|
|
|
- Image used for the tiles
|
|
|
|
- Image size
|
|
|
|
|
2021-12-25 10:04:45 +08:00
|
|
|
This information is obtained from the TMX file.
|
2019-11-23 20:27:39 +08:00
|
|
|
*/
|
|
|
|
class CC_DLL TMXTilesetInfo : public Ref
|
|
|
|
{
|
|
|
|
public:
|
2021-12-25 10:04:45 +08:00
|
|
|
std::string _name;
|
|
|
|
int _firstGid;
|
|
|
|
Vec2 _tileSize;
|
|
|
|
int _spacing;
|
|
|
|
int _margin;
|
|
|
|
Vec2 _tileOffset;
|
2019-11-23 20:27:39 +08:00
|
|
|
//! filename containing the tiles (should be spritesheet / texture atlas)
|
2021-12-25 10:04:45 +08:00
|
|
|
std::string _sourceImage;
|
2019-11-23 20:27:39 +08:00
|
|
|
//! size in pixels of the image
|
2021-12-25 10:04:45 +08:00
|
|
|
Vec2 _imageSize;
|
|
|
|
std::string _originSourceImage;
|
2020-08-28 16:33:52 +08:00
|
|
|
//! map from gid of animated tile to its animation info
|
|
|
|
Map<uint32_t, TMXTileAnimInfo*> _animationInfo;
|
2021-12-25 10:04:45 +08:00
|
|
|
|
2019-11-23 20:27:39 +08:00
|
|
|
public:
|
|
|
|
/**
|
|
|
|
* @js ctor
|
|
|
|
*/
|
|
|
|
TMXTilesetInfo();
|
|
|
|
/**
|
|
|
|
* @js NA
|
|
|
|
* @lua NA
|
|
|
|
*/
|
|
|
|
virtual ~TMXTilesetInfo();
|
|
|
|
Rect getRectForGID(uint32_t gid);
|
|
|
|
};
|
|
|
|
|
|
|
|
/** @brief TMXMapInfo contains the information about the map like:
|
|
|
|
- Map orientation (hexagonal, isometric or orthogonal)
|
|
|
|
- Tile size
|
|
|
|
- Map size
|
|
|
|
|
|
|
|
And it also contains:
|
|
|
|
- Layers (an array of TMXLayerInfo objects)
|
|
|
|
- Tilesets (an array of TMXTilesetInfo objects)
|
|
|
|
- ObjectGroups (an array of TMXObjectGroupInfo objects)
|
|
|
|
|
|
|
|
This information is obtained from the TMX file.
|
|
|
|
|
|
|
|
*/
|
|
|
|
class CC_DLL TMXMapInfo : public Ref, public SAXDelegator
|
2021-12-25 10:04:45 +08:00
|
|
|
{
|
|
|
|
public:
|
2019-11-23 20:27:39 +08:00
|
|
|
/** creates a TMX Format with a tmx file */
|
2021-12-25 10:04:45 +08:00
|
|
|
static TMXMapInfo* create(const std::string& tmxFile);
|
2019-11-23 20:27:39 +08:00
|
|
|
/** creates a TMX Format with an XML string and a TMX resource path */
|
2021-12-25 10:04:45 +08:00
|
|
|
static TMXMapInfo* createWithXML(const std::string& tmxString, const std::string& resourcePath);
|
|
|
|
|
2019-11-23 20:27:39 +08:00
|
|
|
/**
|
|
|
|
* @js ctor
|
|
|
|
*/
|
|
|
|
TMXMapInfo();
|
|
|
|
/**
|
|
|
|
* @js NA
|
|
|
|
* @lua NA
|
|
|
|
*/
|
|
|
|
virtual ~TMXMapInfo();
|
2021-12-25 10:04:45 +08:00
|
|
|
|
2019-11-23 20:27:39 +08:00
|
|
|
/** initializes a TMX format with a tmx file */
|
|
|
|
bool initWithTMXFile(const std::string& tmxFile);
|
|
|
|
/** initializes a TMX format with an XML string and a TMX resource path */
|
|
|
|
bool initWithXML(const std::string& tmxString, const std::string& resourcePath);
|
|
|
|
/** initializes parsing of an XML file, either a tmx (Map) file or tsx (Tileset) file */
|
|
|
|
bool parseXMLFile(const std::string& xmlFilename);
|
|
|
|
/* initializes parsing of an XML string, either a tmx (Map) string or tsx (Tileset) string */
|
|
|
|
bool parseXMLString(const std::string& xmlString);
|
|
|
|
|
|
|
|
ValueMapIntKey& getTileProperties() { return _tileProperties; };
|
2021-12-25 10:04:45 +08:00
|
|
|
void setTileProperties(const ValueMapIntKey& tileProperties) { _tileProperties = tileProperties; }
|
2019-11-23 20:27:39 +08:00
|
|
|
|
|
|
|
/// map orientation
|
|
|
|
int getOrientation() const { return _orientation; }
|
|
|
|
void setOrientation(int orientation) { _orientation = orientation; }
|
2021-12-25 10:04:45 +08:00
|
|
|
|
2019-11-23 20:27:39 +08:00
|
|
|
/// map staggeraxis
|
|
|
|
int getStaggerAxis() const { return _staggerAxis; }
|
|
|
|
void setStaggerAxis(int staggerAxis) { _staggerAxis = staggerAxis; }
|
|
|
|
|
|
|
|
/// map stagger index
|
|
|
|
int getStaggerIndex() const { return _staggerIndex; }
|
|
|
|
void setStaggerIndex(int staggerIndex) { _staggerIndex = staggerIndex; }
|
|
|
|
|
|
|
|
/// map hexsidelength
|
|
|
|
int getHexSideLength() const { return _hexSideLength; }
|
|
|
|
void setHexSideLength(int hexSideLength) { _hexSideLength = hexSideLength; }
|
|
|
|
|
|
|
|
/// map width & height
|
2021-10-23 23:27:14 +08:00
|
|
|
const Vec2& getMapSize() const { return _mapSize; }
|
|
|
|
void setMapSize(const Vec2& mapSize) { _mapSize = mapSize; }
|
2019-11-23 20:27:39 +08:00
|
|
|
|
|
|
|
/// tiles width & height
|
2021-10-23 23:27:14 +08:00
|
|
|
const Vec2& getTileSize() const { return _tileSize; }
|
|
|
|
void setTileSize(const Vec2& tileSize) { _tileSize = tileSize; }
|
2021-12-25 10:04:45 +08:00
|
|
|
|
2019-11-23 20:27:39 +08:00
|
|
|
/// Layers
|
|
|
|
const Vector<TMXLayerInfo*>& getLayers() const { return _layers; }
|
|
|
|
Vector<TMXLayerInfo*>& getLayers() { return _layers; }
|
2021-12-25 10:04:45 +08:00
|
|
|
void setLayers(const Vector<TMXLayerInfo*>& layers) { _layers = layers; }
|
2019-11-23 20:27:39 +08:00
|
|
|
|
|
|
|
/// tilesets
|
|
|
|
const Vector<TMXTilesetInfo*>& getTilesets() const { return _tilesets; }
|
|
|
|
Vector<TMXTilesetInfo*>& getTilesets() { return _tilesets; }
|
2021-12-25 10:04:45 +08:00
|
|
|
void setTilesets(const Vector<TMXTilesetInfo*>& tilesets) { _tilesets = tilesets; }
|
2019-11-23 20:27:39 +08:00
|
|
|
|
|
|
|
/// ObjectGroups
|
|
|
|
const Vector<TMXObjectGroup*>& getObjectGroups() const { return _objectGroups; }
|
|
|
|
Vector<TMXObjectGroup*>& getObjectGroups() { return _objectGroups; }
|
2021-12-25 10:04:45 +08:00
|
|
|
void setObjectGroups(const Vector<TMXObjectGroup*>& groups) { _objectGroups = groups; }
|
2019-11-23 20:27:39 +08:00
|
|
|
|
|
|
|
/// parent element
|
|
|
|
int getParentElement() const { return _parentElement; }
|
|
|
|
void setParentElement(int element) { _parentElement = element; }
|
|
|
|
|
|
|
|
/// parent GID
|
|
|
|
int getParentGID() const { return _parentGID; }
|
|
|
|
void setParentGID(int gid) { _parentGID = gid; }
|
|
|
|
|
|
|
|
/// layer attribs
|
|
|
|
int getLayerAttribs() const { return _layerAttribs; }
|
|
|
|
void setLayerAttribs(int layerAttribs) { _layerAttribs = layerAttribs; }
|
|
|
|
|
|
|
|
/// is storing characters?
|
|
|
|
bool isStoringCharacters() const { return _storingCharacters; }
|
|
|
|
void setStoringCharacters(bool storingCharacters) { _storingCharacters = storingCharacters; }
|
|
|
|
|
|
|
|
/// properties
|
|
|
|
const ValueMap& getProperties() const { return _properties; }
|
|
|
|
ValueMap& getProperties() { return _properties; }
|
2021-12-25 10:04:45 +08:00
|
|
|
void setProperties(const ValueMap& properties) { _properties = properties; }
|
|
|
|
|
2019-11-23 20:27:39 +08:00
|
|
|
// implement pure virtual methods of SAXDelegator
|
|
|
|
/**
|
|
|
|
* @js NA
|
|
|
|
* @lua NA
|
|
|
|
*/
|
2021-12-25 10:04:45 +08:00
|
|
|
void startElement(void* ctx, const char* name, const char** atts) override;
|
2019-11-23 20:27:39 +08:00
|
|
|
/**
|
|
|
|
* @js NA
|
|
|
|
* @lua NA
|
|
|
|
*/
|
2021-12-25 10:04:45 +08:00
|
|
|
void endElement(void* ctx, const char* name) override;
|
2019-11-23 20:27:39 +08:00
|
|
|
/**
|
|
|
|
* @js NA
|
|
|
|
* @lua NA
|
|
|
|
*/
|
2021-12-25 10:04:45 +08:00
|
|
|
void textHandler(void* ctx, const char* ch, size_t len) override;
|
|
|
|
|
2019-11-23 20:27:39 +08:00
|
|
|
const std::string& getCurrentString() const { return _currentString; }
|
2021-12-25 10:04:45 +08:00
|
|
|
void setCurrentString(const std::string& currentString) { _currentString = currentString; }
|
2019-11-23 20:27:39 +08:00
|
|
|
const std::string& getTMXFileName() const { return _TMXFileName; }
|
2021-12-25 10:04:45 +08:00
|
|
|
void setTMXFileName(const std::string& fileName) { _TMXFileName = fileName; }
|
2019-11-23 20:27:39 +08:00
|
|
|
const std::string& getExternalTilesetFileName() const { return _externalTilesetFilename; }
|
|
|
|
|
|
|
|
protected:
|
|
|
|
void internalInit(const std::string& tmxFileName, const std::string& resourcePath);
|
|
|
|
|
|
|
|
/// map orientation
|
2021-12-25 10:04:45 +08:00
|
|
|
int _orientation;
|
|
|
|
/// map staggerAxis
|
|
|
|
int _staggerAxis;
|
|
|
|
/// map staggerIndex
|
|
|
|
int _staggerIndex;
|
|
|
|
/// map hexsidelength
|
|
|
|
int _hexSideLength;
|
2019-11-23 20:27:39 +08:00
|
|
|
/// map width & height
|
2021-10-23 23:27:14 +08:00
|
|
|
Vec2 _mapSize;
|
2019-11-23 20:27:39 +08:00
|
|
|
/// tiles width & height
|
2021-10-23 23:27:14 +08:00
|
|
|
Vec2 _tileSize;
|
2019-11-23 20:27:39 +08:00
|
|
|
/// Layers
|
|
|
|
Vector<TMXLayerInfo*> _layers;
|
|
|
|
/// tilesets
|
|
|
|
Vector<TMXTilesetInfo*> _tilesets;
|
|
|
|
/// ObjectGroups
|
|
|
|
Vector<TMXObjectGroup*> _objectGroups;
|
|
|
|
/// parent element
|
|
|
|
int _parentElement;
|
|
|
|
/// parent GID
|
|
|
|
int _parentGID;
|
|
|
|
/// layer attribs
|
|
|
|
int _layerAttribs;
|
|
|
|
/// is storing characters?
|
|
|
|
bool _storingCharacters;
|
|
|
|
/// properties
|
|
|
|
ValueMap _properties;
|
|
|
|
//! xml format tile index
|
|
|
|
int _xmlTileIndex;
|
2021-12-25 10:04:45 +08:00
|
|
|
|
2019-11-23 20:27:39 +08:00
|
|
|
//! tmx filename
|
|
|
|
std::string _TMXFileName;
|
|
|
|
// tmx resource path
|
|
|
|
std::string _resources;
|
|
|
|
//! current string
|
|
|
|
std::string _currentString;
|
|
|
|
//! tile properties
|
|
|
|
ValueMapIntKey _tileProperties;
|
|
|
|
int _currentFirstGID;
|
|
|
|
bool _recordFirstGID;
|
|
|
|
std::string _externalTilesetFilename;
|
|
|
|
};
|
|
|
|
|
|
|
|
// end of tilemap_parallax_nodes group
|
|
|
|
/// @}
|
|
|
|
|
|
|
|
NS_CC_END
|
|
|
|
|
|
|
|
/// @endcond
|
|
|
|
#endif
|