fixed #72, complete CCTMXLayerInfo

This commit is contained in:
Walzer 2010-08-27 10:07:37 +00:00
parent 2367ceed67
commit 408a34603b
2 changed files with 627 additions and 3 deletions

View File

@ -23,10 +23,153 @@ THE SOFTWARE.
****************************************************************************/ ****************************************************************************/
#ifndef __CC_TM_XML_PARSER__ #ifndef __CC_TM_XML_PARSER__
#define __CC_TM_XML_PARSER__ #define __CC_TM_XML_PARSER__
#include "Cocos2dDefine.h"
#include "NSMutableArray.h"
#include "CGGeometry.h"
#include <map>
namespace cocos2d { namespace cocos2d {
typedef std::map<std::string, std::string> StringToStringDictionary;
typedef std::pair<std::string, std::string> StringToStringPair;
/*
* Internal TMX parser
*
* IMPORTANT: These classed should not be documented using doxygen strings
* since the user should not use them.
*
*/
enum {
TMXLayerAttribNone = 1 << 0,
TMXLayerAttribBase64 = 1 << 1,
TMXLayerAttribGzip = 1 << 2,
};
enum {
TMXPropertyNone,
TMXPropertyMap,
TMXPropertyLayer,
TMXPropertyObjectGroup,
TMXPropertyObject,
TMXPropertyTile
};
/* CCTMXLayerInfo 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 CCX_DLL CCTMXLayerInfo : public NSObject
{
public:
std::string m_sName;
CGSize m_tLayerSize;
unsigned int *m_pTiles;
bool m_bVisible;
unsigned char m_cOpacity;
bool m_bOwnTiles;
unsigned int m_uMinGID;
unsigned int m_uMaxGID;
StringToStringDictionary *m_pProperties;
CGPoint m_tOffset;
public:
CCTMXLayerInfo();
virtual ~CCTMXLayerInfo();
};
/* CCTMXTilesetInfo contains the information about the tilesets like:
- Tileset name
- Tilset spacing
- Tileset margin
- size of the tiles
- Image used for the tiles
- Image size
This information is obtained from the TMX file.
*/
class CCX_DLL CCTMXTilesetInfo : public NSObject
{
public:
std::string m_sName;
unsigned int m_uFirstGid;
CGSize m_tTileSize;
unsigned int m_uSpacing;
unsigned int m_uMargin;
// filename containing the tiles (should be spritesheet / texture atlas)
std::string m_sSourceImage;
// size in pixels of the image
CGSize m_tImageSize;
public:
CCTMXTilesetInfo(){}
virtual ~CCTMXTilesetInfo();
CGRect rectForGID(unsigned int gid);
};
/* CCTMXMapInfo 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 CCX_DLL CCTMXMapInfo : public NSObject
{
// tmx filename
CCX_SYNTHESIZE(std::string, m_sFilename, Filename);
// map orientation
CCX_SYNTHESIZE(int, m_nOrientation, Orientation);
// map width & height
CCX_SYNTHESIZE(CGSize, m_tMapSize, MapSize);
// tiles width & height
CCX_SYNTHESIZE(CGSize, m_tTileSize, TileSize);
// Layers
CCX_SYNTHESIZE(NSMutableArray<CCTMXLayerInfo*>*, m_pLayers, Layers);
// tilesets
CCX_SYNTHESIZE(NSMutableArray<CCTMXTilesetInfo*>*, m_pTilesets, Tilesets);
// ObjectGroups
CCX_SYNTHESIZE(NSMutableArray<void*>*, m_pObjectGroups, ObjectGroups);
// parent element
CCX_SYNTHESIZE(int, m_nParentElement, ParentElement);
// parent GID
CCX_SYNTHESIZE(unsigned int, m_uParentGID, ParentGID);
// layer attribs
CCX_SYNTHESIZE(int, m_nLayerAttribs, LayerAttribs);
// current string
CCX_SYNTHESIZE(std::string, m_sCurrentString, CurrentString);
// is stroing characters?
CCX_SYNTHESIZE(bool, m_bStoringCharacters, StoringCharacters);
public:
CCTMXMapInfo(){}
virtual ~CCTMXMapInfo();
/** creates a TMX Format with a tmx file */
static CCTMXMapInfo * formatWithTMXFile(const char *tmxFile);
/** initializes a TMX format witha tmx file */
bool initWithTMXFile(const char *tmxFile);
/* initalises parsing of an XML file, either a tmx (Map) file or tsx (Tileset) file */
bool parseXMLFile(const char *xmlFilename);
inline StringToStringDictionary* getProperties(){return m_pProperties;}
inline void setProperties(StringToStringDictionary * var){m_pProperties = var;}
inline std::map<int, StringToStringDictionary*>* getTileProperties(){return m_pTileProperties;}
inline void setTileProperties(std::map<int, StringToStringDictionary*> * var){m_pTileProperties = var;}
protected:
// properties
StringToStringDictionary* m_pProperties;
// tile properties
std::map<int, StringToStringDictionary*>* m_pTileProperties;
};
}// namespace cocos2d }// namespace cocos2d
#endif //__CC_TM_XML_PARSER__ #endif //__CC_TM_XML_PARSER__

View File

@ -21,4 +21,485 @@ 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 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE. THE SOFTWARE.
****************************************************************************/ ****************************************************************************/
#include "CCTMXXMLParser.h" #include <libxml/parser.h>
#include <libxml/tree.h>
#include <libxml/xmlmemory.h>
#include "CCTMXXMLParser.h"
#include "ccMacros.h"
#include "CCXFileUtils.h"
#include "CGPointExtension.h"
#include "support/base64.h"
#include "platform/platform.h"
namespace cocos2d {
void startElement(void *ctx, const xmlChar *name, const xmlChar **atts);
void endElement(void *ctx, const xmlChar *name);
void characters(void *ctx, const xmlChar *ch, int len);
const char * valueForKey(std::string key, StringToStringDictionary dict);
// implementation CCTMXLayerInfo
CCTMXLayerInfo::CCTMXLayerInfo()
{
m_bOwnTiles = true;
m_uMinGID = 100000;
m_uMaxGID = 0;
m_sName = "";
m_pTiles = NULL;
m_tOffset = CGPointZero;
m_pProperties= new StringToStringDictionary();;
}
CCTMXLayerInfo::~CCTMXLayerInfo()
{
CCLOGINFO("cocos2d: deallocing.");
CCX_SAFE_DELETE(m_pProperties);
if( m_bOwnTiles && m_pTiles )
{
delete [] m_pTiles;
m_pTiles = NULL;
}
}
// implementation CCTMXTilesetInfo
CCTMXTilesetInfo::~CCTMXTilesetInfo()
{
CCLOGINFO("cocos2d: deallocing.");
}
CGRect CCTMXTilesetInfo::rectForGID(unsigned int gid)
{
CGRect rect;
rect.size = m_tTileSize;
gid = gid - m_uFirstGid;
int max_x = (int)((m_tImageSize.width - m_uMargin*2 + m_uSpacing) / (m_tTileSize.width + m_uSpacing));
// int max_y = (imageSize.height - margin*2 + spacing) / (tileSize.height + spacing);
rect.origin.x = (gid % max_x) * (m_tTileSize.width + m_uSpacing) + m_uMargin;
rect.origin.y = (gid / max_x) * (m_tTileSize.height + m_uSpacing) + m_uMargin;
return rect;
}
// implementation CCTMXMapInfo
CCTMXMapInfo * CCTMXMapInfo::formatWithTMXFile(const char *tmxFile)
{
CCTMXMapInfo *pRet = new CCTMXMapInfo();
if(pRet->initWithTMXFile(tmxFile))
{
pRet->autorelease();
return pRet;
}
CCX_SAFE_DELETE(pRet);
return NULL;
}
bool CCTMXMapInfo::initWithTMXFile(const char *tmxFile)
{
m_pTilesets = new NSMutableArray<CCTMXTilesetInfo *>();
m_pLayers = new NSMutableArray<CCTMXLayerInfo *>();
m_sFilename = CCFileUtils::fullPathFromRelativePath(tmxFile);
m_pObjectGroups = new NSMutableArray<void *>();
m_pProperties = new StringToStringDictionary();
m_pTileProperties = new std::map<int, StringToStringDictionary*>();
// tmp vars
m_sCurrentString = "";
m_bStoringCharacters = false;
m_nLayerAttribs = TMXLayerAttribNone;
m_nParentElement = TMXPropertyNone;
return parseXMLFile(m_sFilename.c_str());
}
CCTMXMapInfo::~CCTMXMapInfo()
{
CCLOGINFO("cocos2d: deallocing.");
m_pTilesets->release();
m_pLayers->release();
m_pObjectGroups->release();
CCX_SAFE_DELETE(m_pProperties);
CCX_SAFE_DELETE(m_pTileProperties);
}
bool CCTMXMapInfo::parseXMLFile(const char *xmlFilename)
{
FILE *fp = NULL;
if( !(fp = fopen(xmlFilename, "r")) )
{
return NULL;
}
fseek(fp,0,SEEK_END);
int size = ftell(fp);
fseek(fp,0,SEEK_SET);
char *buffer = new char[size+1];
fread(buffer,sizeof(char),size,fp);
fclose(fp);
/*
* this initialize the library and check potential ABI mismatches
* between the version it was compiled for and the actual shared
* library used.
*/
LIBXML_TEST_VERSION
xmlSAXHandler saxHandler;
memset( &saxHandler, 0, sizeof(saxHandler) );
// Using xmlSAXVersion( &saxHandler, 2 ) generate crash as it sets plenty of other pointers...
saxHandler.initialized = XML_SAX2_MAGIC; // so we do this to force parsing as SAX2.
saxHandler.startElement = &startElement;
saxHandler.endElement = &endElement;
saxHandler.characters = &characters;
int result = xmlSAXUserParseMemory( &saxHandler, this, buffer, size );
if ( result != 0 )
{
return false;
}
/*
* Cleanup function for the XML library.
*/
xmlCleanupParser();
/*
* this is to debug memory for regression tests
*/
xmlMemoryDump();
delete []buffer;
return true;
}
/** Possible oritentations of the TMX map */
enum
{
/** Orthogonal orientation */
CCTMXOrientationOrtho,
/** Hexagonal orientation */
CCTMXOrientationHex,
/** Isometric orientation */
CCTMXOrientationIso,
};/// @todo to be deleted
const char * valueForKey(std::string key, StringToStringDictionary dict)
{
StringToStringDictionary::iterator it = dict.find(key);
return it!=dict.end() ? it->second.c_str() : "";
}
// the XML parser calls here with all the elements
void startElement(void *ctx, const xmlChar *name, const xmlChar **atts)
{
CCTMXMapInfo *pTMXMapInfo = (CCTMXMapInfo*)(ctx);
std::string elementName = (char*)name;
StringToStringDictionary attributeDict;
if(atts && atts[0])
{
for(int i = 0; atts[i]; i += 2)
{
std::string key = (char*)atts[i];
std::string value = (char*)atts[i+1];
attributeDict.insert(StringToStringPair(key, value));
}
}
if(elementName == "map")
{
std::string version = valueForKey("version", attributeDict);
if ( version != "1.0")
{
CCLOG("cocos2d: TMXFormat: Unsupported TMX version: %@", version);
}
std::string orientationStr = valueForKey("orientation", attributeDict);
if( orientationStr == "orthogonal")
pTMXMapInfo->setOrientation(CCTMXOrientationOrtho);
else if ( orientationStr == "isometric")
pTMXMapInfo->setOrientation(CCTMXOrientationIso);
else if( orientationStr == "hexagonal")
pTMXMapInfo->setOrientation(CCTMXOrientationHex);
else
CCLOG("cocos2d: TMXFomat: Unsupported orientation: %d", pTMXMapInfo->getOrientation());
CGSize s;
s.width = (float)atof(valueForKey("width", attributeDict));
s.height = (float)atof(valueForKey("height", attributeDict));
pTMXMapInfo->setMapSize(s);
s.width = (float)atof(valueForKey("tilewidth", attributeDict));
s.height = (float)atof(valueForKey("tileheight", attributeDict));
pTMXMapInfo->setTileSize(s);
// The parent element is now "map"
pTMXMapInfo->setParentElement(TMXPropertyMap);
}
else if(elementName == "tileset")
{
// If this is an external tileset then start parsing that
std::string externalTilesetFilename = valueForKey("source", attributeDict);
if (externalTilesetFilename != "")
{
externalTilesetFilename = CCFileUtils::fullPathFromRelativePath(externalTilesetFilename.c_str());
pTMXMapInfo->parseXMLFile(externalTilesetFilename.c_str());
}
else
{
CCTMXTilesetInfo *tileset = new CCTMXTilesetInfo();
tileset->m_sName = valueForKey("name", attributeDict);
tileset->m_uFirstGid = (unsigned int)atoi(valueForKey("firstgid", attributeDict));
tileset->m_uSpacing = (unsigned int)atoi(valueForKey("spacing", attributeDict));
tileset->m_uMargin = (unsigned int)atoi(valueForKey("margin", attributeDict));
CGSize s;
s.width = (float)atof(valueForKey("tilewidth", attributeDict));
s.height = (float)atof(valueForKey("tileheight", attributeDict));
tileset->m_tTileSize = s;
pTMXMapInfo->getTilesets()->addObject(tileset);
tileset->release();
}
}
else if(elementName == "tile")
{
CCTMXTilesetInfo* info = pTMXMapInfo->getTilesets()->getLastObject();
StringToStringDictionary *dict = new StringToStringDictionary();
pTMXMapInfo->setParentGID(info->m_uFirstGid + atoi(valueForKey("id", attributeDict)));
pTMXMapInfo->getTileProperties()->insert(std::pair<int, StringToStringDictionary*>(pTMXMapInfo->getParentGID(), dict));
pTMXMapInfo->setParentElement(TMXPropertyTile);
}
else if(elementName == "layer")
{
CCTMXLayerInfo *layer = new CCTMXLayerInfo();
layer->m_sName = valueForKey("name", attributeDict);
CGSize s;
s.width = (float)atof(valueForKey("width", attributeDict));
s.height = (float)atof(valueForKey("height", attributeDict));
layer->m_tLayerSize = s;
std::string visible = valueForKey("visible", attributeDict);
layer->m_bVisible = !(visible == "0");
std::string opacity = valueForKey("opacity", attributeDict);
if( opacity != "" )
{
layer->m_cOpacity = (unsigned char)(255 * atof(opacity.c_str()));
}
else
{
layer->m_cOpacity = 255;
}
float x = (float)atof(valueForKey("x", attributeDict));
float y = (float)atof(valueForKey("y", attributeDict));
layer->m_tOffset = ccp(x,y);
pTMXMapInfo->getLayers()->addObject(layer);
layer->release();
// The parent element is now "layer"
pTMXMapInfo->setParentElement(TMXPropertyLayer);
}
else if(elementName == "objectgroup")
{
/** @todo CCTMXObjectGroup *objectGroup = [[CCTMXObjectGroup alloc] init];
objectGroup.groupName = [attributeDict valueForKey:@"name"];
CGPoint positionOffset;
positionOffset.x = [[attributeDict valueForKey:@"x"] intValue] * tileSize_.width;
positionOffset.y = [[attributeDict valueForKey:@"y"] intValue] * tileSize_.height;
objectGroup.positionOffset = positionOffset;
[objectGroups_ addObject:objectGroup];
[objectGroup release];
// The parent element is now "objectgroup"
parentElement = TMXPropertyObjectGroup;*/
}
else if(elementName == "image")
{
CCTMXTilesetInfo *tileset = pTMXMapInfo->getTilesets()->getLastObject();
// build full path
std::string imagename = valueForKey("source", attributeDict);
tileset->m_sSourceImage = CCFileUtils::fullPathFromRelativePath(imagename.c_str());
}
else if(elementName == "data")
{
std::string encoding = valueForKey("encoding", attributeDict);
std::string compression = valueForKey("compression", attributeDict);
if( encoding == "base64" )
{
int layerAttribs = pTMXMapInfo->getLayerAttribs();
pTMXMapInfo->setLayerAttribs(layerAttribs | TMXLayerAttribBase64);
pTMXMapInfo->setStoringCharacters(true);
if( compression == "gzip" )
{
layerAttribs = pTMXMapInfo->getLayerAttribs();
pTMXMapInfo->setLayerAttribs(layerAttribs | TMXLayerAttribGzip);
}
NSAssert( compression == "gzip", "TMX: unsupported compression method" );
}
NSAssert( pTMXMapInfo->getLayerAttribs() != TMXLayerAttribNone, "TMX tile map: Only base64 and/or gzip maps are supported" );
}
else if(elementName == "object")
{
/** @todo CCTMXObjectGroup *objectGroup = [objectGroups_ lastObject];
// The value for "type" was blank or not a valid class name
// Create an instance of TMXObjectInfo to store the object and its properties
NSMutableDictionary *dict = [[NSMutableDictionary alloc] initWithCapacity:5];
// Set the name of the object to the value for "name"
[dict setValue:[attributeDict valueForKey:@"name"] forKey:@"name"];
// Assign all the attributes as key/name pairs in the properties dictionary
[dict setValue:[attributeDict valueForKey:@"type"] forKey:@"type"];
int x = [[attributeDict valueForKey:@"x"] intValue] + objectGroup.positionOffset.x;
[dict setValue:[NSNumber numberWithInt:x] forKey:@"x"];
int y = [[attributeDict valueForKey:@"y"] intValue] + objectGroup.positionOffset.y;
// Correct y position. (Tiled uses Flipped, cocos2d uses Standard)
y = (mapSize_.height * tileSize_.height) - y - [[attributeDict valueForKey:@"height"] intValue];
[dict setValue:[NSNumber numberWithInt:y] forKey:@"y"];
[dict setValue:[attributeDict valueForKey:@"width"] forKey:@"width"];
[dict setValue:[attributeDict valueForKey:@"height"] forKey:@"height"];
// Add the object to the objectGroup
[[objectGroup objects] addObject:dict];
[dict release];
// The parent element is now "object"
parentElement = TMXPropertyObject;*/
}
else if(elementName == "property")
{
if ( pTMXMapInfo->getParentElement() == TMXPropertyNone )
{
CCLOG( "TMX tile map: Parent element is unsupported. Cannot add property named '%s' with value '%s'",
valueForKey("name", attributeDict), valueForKey("value",attributeDict) );
}
else if ( pTMXMapInfo->getParentElement() == TMXPropertyMap )
{
// The parent element is the map
std::string value = valueForKey("value", attributeDict);
std::string key = valueForKey("name", attributeDict);
pTMXMapInfo->getProperties()->insert(StringToStringPair(key, value));
}
else if ( pTMXMapInfo->getParentElement() == TMXPropertyLayer )
{
// The parent element is the last layer
CCTMXLayerInfo *layer = pTMXMapInfo->getLayers()->getLastObject();
std::string value = valueForKey("value", attributeDict);
std::string key = valueForKey("name", attributeDict);
// Add the property to the layer
layer->m_pProperties->insert(StringToStringPair(key, value));
}
else if ( pTMXMapInfo->getParentElement() == TMXPropertyObjectGroup )
{
// The parent element is the last object group
/** @todo CCTMXObjectGroup *objectGroup = [objectGroups_ lastObject];
[[objectGroup properties] setValue:[attributeDict valueForKey:@"value"] forKey:[attributeDict valueForKey:@"name"]];*/
}
else if ( pTMXMapInfo->getParentElement() == TMXPropertyObject )
{
// The parent element is the last object
/** @todo CCTMXObjectGroup *objectGroup = [objectGroups_ lastObject];
NSMutableDictionary *dict = [[objectGroup objects] lastObject];
NSString *propertyName = [attributeDict valueForKey:@"name"];
NSString *propertyValue = [attributeDict valueForKey:@"value"];
[dict setValue:propertyValue forKey:propertyName];*/
}
else if ( pTMXMapInfo->getParentElement() == TMXPropertyTile )
{
StringToStringDictionary *dict;
dict = pTMXMapInfo->getTileProperties()->find(pTMXMapInfo->getParentGID())->second;
std::string propertyName = valueForKey("name", attributeDict);
std::string propertyValue = valueForKey("value", attributeDict);
dict->insert(StringToStringPair(propertyName, propertyValue));
}
}
}
void endElement(void *ctx, const xmlChar *name)
{
CCTMXMapInfo *pTMXMapInfo = (CCTMXMapInfo*)(ctx);
std::string elementName = (char*)name;
int len = 0;
if(elementName == "data" && pTMXMapInfo->getLayerAttribs()&TMXLayerAttribBase64)
{
pTMXMapInfo->setStoringCharacters(false);
CCTMXLayerInfo *layer = pTMXMapInfo->getLayers()->getLastObject();
std::string currentString = pTMXMapInfo->getCurrentString();
unsigned char *buffer;
len = base64Decode((unsigned char*)currentString.c_str(), currentString.length(), &buffer);
if( ! buffer )
{
CCLOG("cocos2d: TiledMap: decode data error");
return;
}
if( pTMXMapInfo->getLayerAttribs() & TMXLayerAttribGzip )
{
unsigned char *deflated;
ZipUtils::inflateMemory(buffer, len, &deflated);
free( buffer );
if( ! deflated )
{
CCLOG("cocos2d: TiledMap: inflate data error");
return;
}
layer->m_pTiles = (unsigned int*) deflated;
}
else
{
layer->m_pTiles = (unsigned int*) buffer;
}
pTMXMapInfo->setCurrentString("");
}
else if (elementName == "map")
{
// The map element has ended
pTMXMapInfo->setParentElement(TMXPropertyNone);
}
else if (elementName == "layer")
{
// The layer element has ended
pTMXMapInfo->setParentElement(TMXPropertyNone);
}
else if (elementName == "objectgroup")
{
// The objectgroup element has ended
pTMXMapInfo->setParentElement(TMXPropertyNone);
}
else if (elementName == "object")
{
// The object element has ended
pTMXMapInfo->setParentElement(TMXPropertyNone);
}
}
void characters(void *ctx, const xmlChar *ch, int len)
{
CCTMXMapInfo *pTMXMapInfo = (CCTMXMapInfo*)(ctx);
std::string pText((char*)ch,0,len);
if (pTMXMapInfo->getStoringCharacters())
{
std::string currentString = pTMXMapInfo->getCurrentString();
currentString += pText;
pTMXMapInfo->setCurrentString(currentString);
}
}
}//namespace cocos2d