TMXTiledMap knows how to parse and render a TMX map. More...

#include <CCTMXTiledMap.h>

Inheritance diagram for TMXTiledMap:

Public Member Functions
	TMXTiledMap ()
virtual	~TMXTiledMap ()
bool	initWithTMXFile (const char *tmxFile)
	initializes a TMX Tiled Map with a TMX file More...

bool	initWithXML (const char tmxString, const char resourcePath)
	initializes a TMX Tiled Map with a TMX formatted XML string and a path to TMX resources More...

TMXLayer *	getLayer (const char *layerName) const
	return the TMXLayer for the specific layer More...

local	getLayer ( local layerName)
	return the TMXLayer for the specific layer More...

CC_DEPRECATED_ATTRIBUTE TMXLayer *	layerNamed (const char *layerName) const
TMXObjectGroup *	getObjectGroup (const char *groupName) const
	return the TMXObjectGroup for the specific group More...

CC_DEPRECATED_ATTRIBUTE TMXObjectGroup *	objectGroupNamed (const char *groupName) const
String *	getProperty (const char *propertyName) const
	return the value for the specific property name More...

CC_DEPRECATED_ATTRIBUTE String *	propertyNamed (const char *propertyName) const
Dictionary *	getPropertiesForGID (int GID) const
	return properties dictionary for tile GID More...

local	getPropertiesForGID ( local GID)
	return properties dictionary for tile GID More...

CC_DEPRECATED_ATTRIBUTE Dictionary *	propertiesForGID (int GID) const
local	propertiesForGID ( local GID)
const Size &	getMapSize () const
	the map's size property measured in tiles More...

void	setMapSize (const Size &mapSize)
const Size &	getTileSize () const
	the tiles's size property measured in pixels More...

void	setTileSize (const Size &tileSize)
local	setTileSize ( local tileSize)
int	getMapOrientation () const
	map orientation More...

void	setMapOrientation (int mapOrientation)
Array *	getObjectGroups () const
	object groups More...

void	setObjectGroups (Array *groups)
Dictionary *	getProperties () const
	properties More...

local	getProperties ()
	properties More...

void	setProperties (Dictionary *properties)
Public Member Functions inherited from Node
virtual Camera *	getCamera ()
	Returns a camera object that lets you move the node using a gluLookAt. More...

virtual bool	isRunning () const
	Returns whether or not the node accepts event callbacks. More...

void	scheduleUpdateWithPriorityLua (int handler, int priority)
	Schedules for lua script. More...

virtual void	cleanup ()
	Stops all running actions and schedulers. More...

var	cleanup ()
	Stops all running actions and schedulers. More...

local	cleanup ()
	Stops all running actions and schedulers. More...

virtual void	draw ()
	Override this method to draw your own node. More...

local	draw ()
	Override this method to draw your own node. More...

virtual void	visit ()
	Visits this node's children and draw them recursively. More...

local	visit ()
	Visits this node's children and draw them recursively. More...

virtual Rect	getBoundingBox () const
	Returns a "local" axis aligned bounding box of the node. More...

local	getBoundingBox ()
	Returns a "local" axis aligned bounding box of the node. More...

virtual CC_DEPRECATED_ATTRIBUTE Rect	boundingBox () const
local	boundingBox ()
virtual void	setZOrder (int zOrder)
	Sets the Z order which stands for the drawing order, and reorder this node in its parent's children array. More...

local	setZOrder ( local zOrder)
	Sets the Z order which stands for the drawing order, and reorder this node in its parent's children array. More...

virtual void	_setZOrder (int z)
	Sets the z order which stands for the drawing order. More...

virtual int	getZOrder () const
	Gets the Z order of this node. More...

virtual void	setVertexZ (float vertexZ)
	Sets the real OpenGL Z vertex. More...

local	setVertexZ ( local vertexZ)
	Sets the real OpenGL Z vertex. More...

virtual float	getVertexZ () const
	Gets OpenGL Z vertex of this node. More...

virtual void	setScaleX (float scaleX)
	Changes the scale factor on X axis of this node. More...

var	setScaleX ( var scaleX)
	Changes the scale factor on X axis of this node. More...

local	setScaleX ( local scaleX)
	Changes the scale factor on X axis of this node. More...

virtual float	getScaleX () const
	Returns the scale factor on X axis of this node. More...

virtual void	setScaleY (float scaleY)
	Changes the scale factor on Y axis of this node. More...

var	setScaleY ( var scaleY)
	Changes the scale factor on Y axis of this node. More...

local	setScaleY ( local scaleY)
	Changes the scale factor on Y axis of this node. More...

virtual float	getScaleY () const
	Returns the scale factor on Y axis of this node. More...

virtual void	setScale (float scale)
	Changes both X and Y scale factor of the node. More...

local	setScale ( local scale)
	Changes both X and Y scale factor of the node. More...

virtual float	getScale () const
	Gets the scale factor of the node, when X and Y have the same scale factor. More...

virtual void	setPosition (const Point &position)
	Changes the position (x,y) of the node in OpenGL coordinates. More...

virtual const Point &	getPosition () const
	Gets the position (x,y) of the node in OpenGL coordinates. More...

local	getPosition ()
	Gets the position (x,y) of the node in OpenGL coordinates. More...

virtual void	setPosition (float x, float y)
	Sets position in a more efficient way. More...

virtual void	getPosition (float x, float y) const
	Gets position in a more efficient way, returns two number instead of a Point object. More...

virtual void	setPositionX (float x)
	Gets/Sets x or y coordinate individually for position. More...

virtual float	getPositionX (void) const
local	getPositionX ()
virtual void	setPositionY (float y)
local	setPositionY ( local y)
virtual float	getPositionY (void) const
local	getPositionY ()
virtual void	setSkewX (float fSkewX)
	Changes the X skew angle of the node in degrees. More...

virtual float	getSkewX () const
	Returns the X skew angle of the node in degrees. More...

virtual void	setSkewY (float fSkewY)
	Changes the Y skew angle of the node in degrees. More...

local	setSkewY ( local fSkewY)
	Changes the Y skew angle of the node in degrees. More...

virtual float	getSkewY () const
	Returns the Y skew angle of the node in degrees. More...

virtual void	setAnchorPoint (const Point &anchorPoint)
	Sets the anchor point in percent. More...

local	setAnchorPoint ( local anchorPoint)
	Sets the anchor point in percent. More...

virtual const Point &	getAnchorPoint () const
	Returns the anchor point in percent. More...

local	getAnchorPoint ()
	Returns the anchor point in percent. More...

virtual const Point &	getAnchorPointInPoints () const
	Returns the anchorPoint in absolute pixels. More...

virtual void	setContentSize (const Size &contentSize)
	Sets the untransformed size of the node. More...

local	setContentSize ( local contentSize)
	Sets the untransformed size of the node. More...

virtual const Size &	getContentSize () const
	Returns the untransformed size of the node. More...

virtual void	setVisible (bool visible)
	Sets whether the node is visible. More...

local	setVisible ( local visible)
	Sets whether the node is visible. More...

virtual bool	isVisible () const
	Determines if the node is visible. More...

var	isVisible ()
	Determines if the node is visible. More...

local	isVisible ()
	Determines if the node is visible. More...

virtual void	setRotation (float rotation)
	Sets the rotation (angle) of the node in degrees. More...

virtual float	getRotation () const
	Returns the rotation of the node in degrees. More...

virtual void	setRotationX (float rotationX)
	Sets the X rotation (angle) of the node in degrees which performs a horizontal rotational skew. More...

local	setRotationX ( local rotationX)
	Sets the X rotation (angle) of the node in degrees which performs a horizontal rotational skew. More...

virtual float	getRotationX () const
	Gets the X rotation (angle) of the node in degrees which performs a horizontal rotation skew. More...

virtual void	setRotationY (float rotationY)
	Sets the Y rotation (angle) of the node in degrees which performs a vertical rotational skew. More...

local	setRotationY ( local rotationY)
	Sets the Y rotation (angle) of the node in degrees which performs a vertical rotational skew. More...

virtual float	getRotationY () const
	Gets the Y rotation (angle) of the node in degrees which performs a vertical rotational skew. More...

virtual void	setOrderOfArrival (int orderOfArrival)
	Sets the arrival order when this node has a same ZOrder with other children. More...

var	setOrderOfArrival ( var orderOfArrival)
	Sets the arrival order when this node has a same ZOrder with other children. More...

local	setOrderOfArrival ( local orderOfArrival)
	Sets the arrival order when this node has a same ZOrder with other children. More...

virtual int	getOrderOfArrival () const
	Returns the arrival order, indecates which children is added previously. More...

CC_DEPRECATED_ATTRIBUTE void	setGLServerState (int serverState)
CC_DEPRECATED_ATTRIBUTE int	getGLServerState () const
virtual void	ignoreAnchorPointForPosition (bool ignore)
	Sets whether the anchor point will be (0,0) when you position this node. More...

virtual bool	isIgnoreAnchorPointForPosition () const
	Gets whether the anchor point will be (0,0) when you position this node. More...

virtual void	addChild (Node *child)
	Adds a child to the container with z-order as 0. More...

virtual void	addChild (Node *child, int zOrder)
	Adds a child to the container with a z-order. More...

virtual void	addChild (Node *child, int zOrder, int tag)
	Adds a child to the container with z order and tag. More...

Node *	getChildByTag (int tag)
	Gets a child from the container with its tag. More...

virtual Array *	getChildren ()
	Return an array of children. More...

virtual const Array *	getChildren () const
unsigned int	getChildrenCount () const
	Get the amount of children. More...

local	getChildrenCount ()
	Get the amount of children. More...

virtual void	setParent (Node *parent)
	Sets the parent node. More...

var	setParent ( var parent)
	Sets the parent node. More...

local	setParent ( local parent)
	Sets the parent node. More...

virtual Node *	getParent ()
	Returns a pointer to the parent node. More...

var	getParent ()
	Returns a pointer to the parent node. More...

local	getParent ()
	Returns a pointer to the parent node. More...

virtual const Node *	getParent () const
local	getParent ()
virtual void	removeFromParent ()
	Removes this node itself from its parent node with a cleanup. More...

local	removeFromParent ()
	Removes this node itself from its parent node with a cleanup. More...

virtual void	removeFromParentAndCleanup (bool cleanup)
	Removes this node itself from its parent node. More...

local	removeFromParent ( local cleanup)
	Removes this node itself from its parent node. More...

virtual void	removeChild (Node *child, bool cleanup=true)
	Removes a child from the container. More...

var	removeChild ( var child, var true)
	Removes a child from the container. More...

local	removeChild ( local child, local true)
	Removes a child from the container. More...

virtual void	removeChildByTag (int tag, bool cleanup=true)
	Removes a child from the container by tag value. More...

local	removeChildByTag ( local tag, local true)
	Removes a child from the container by tag value. More...

virtual void	removeAllChildren ()
	Removes all children from the container with a cleanup. More...

virtual void	removeAllChildrenWithCleanup (bool cleanup)
	Removes all children from the container, and do a cleanup to all running actions depending on the cleanup parameter. More...

local	removeAllChildren ( local cleanup)
	Removes all children from the container, and do a cleanup to all running actions depending on the cleanup parameter. More...

virtual void	reorderChild (Node *child, int zOrder)
	Reorders a child according to a new z value. More...

var	reorderChild ( var child, var zOrder)
	Reorders a child according to a new z value. More...

local	reorderChild ( local child, local zOrder)
	Reorders a child according to a new z value. More...

virtual void	sortAllChildren ()
	Sorts the children array once before drawing, instead of every time when a child is added or reordered. More...

virtual GridBase *	getGrid ()
	Returns a grid object that is used when applying effects. More...

local	getGrid ()
	Returns a grid object that is used when applying effects. More...

virtual const GridBase *	getGrid () const
local	getGrid ()
virtual void	setGrid (GridBase *grid)
	Changes a grid object that is used when applying effects. More...

local	setGrid ( local grid)
	Changes a grid object that is used when applying effects. More...

virtual int	getTag () const
	Returns a tag that is used to identify the node easily. More...

virtual void	setTag (int tag)
	Changes the tag that is used to identify the node easily. More...

var	setTag ( var tag)
	Changes the tag that is used to identify the node easily. More...

local	setTag ( local tag)
	Changes the tag that is used to identify the node easily. More...

virtual void *	getUserData ()
	Returns a custom user data pointer. More...

virtual const void *	getUserData () const
virtual void	setUserData (void *userData)
	Sets a custom user data pointer. More...

virtual Object *	getUserObject ()
	Returns a user assigned Object. More...

virtual const Object *	getUserObject () const
virtual void	setUserObject (Object *userObject)
	Returns a user assigned Object. More...

local	setUserObject ( local userObject)
	Returns a user assigned Object. More...

virtual GLProgram *	getShaderProgram ()
	Return the shader program currently used for this node. More...

virtual const GLProgram *	getShaderProgram () const
local	getShaderProgram ()
virtual void	setShaderProgram (GLProgram *shaderProgram)
	Sets the shader program for this node. More...

var	setShaderProgram ( var shaderProgram)
	Sets the shader program for this node. More...

local	setShaderProgram ( local shaderProgram)
	Sets the shader program for this node. More...

virtual void	onEnter ()
	Event callback that is invoked every time when Node enters the 'stage'. More...

virtual void	onEnterTransitionDidFinish ()
	Event callback that is invoked when the Node enters in the 'stage'. More...

virtual void	onExit ()
	Event callback that is invoked every time the Node leaves the 'stage'. More...

virtual void	onExitTransitionDidStart ()
	Event callback that is called every time the Node leaves the 'stage'. More...

virtual void	setActionManager (ActionManager *actionManager)
	Sets the ActionManager object that is used by all actions. More...

virtual ActionManager *	getActionManager ()
	Gets the ActionManager object that is used by all actions. More...

local	getActionManager ()
	Gets the ActionManager object that is used by all actions. More...

virtual const ActionManager *	getActionManager () const
Action *	runAction (Action *action)
	Executes an action, and returns the action that is executed. More...

local	runAction ( local action)
	Executes an action, and returns the action that is executed. More...

void	stopAllActions ()
	Stops and removes all actions from the running action list . More...

void	stopAction (Action *action)
	Stops and removes an action from the running action list. More...

void	stopActionByTag (int tag)
	Removes an action from the running action list by its tag. More...

Action *	getActionByTag (int tag)
	Gets an action from the running action list by its tag. More...

unsigned int	getNumberOfRunningActions () const
	Returns the numbers of actions that are running plus the ones that are schedule to run (actions in actionsToAdd and actions arrays). More...

local	getNumberOfRunningActions ()
	Returns the numbers of actions that are running plus the ones that are schedule to run (actions in actionsToAdd and actions arrays). More...

CC_DEPRECATED_ATTRIBUTE unsigned int	numberOfRunningActions () const
local	numberOfRunningActions ()
virtual void	setScheduler (Scheduler *scheduler)
	Sets a Scheduler object that is used to schedule all "updates" and timers. More...

virtual Scheduler *	getScheduler ()
	Gets a Sheduler object. More...

virtual const Scheduler *	getScheduler () const
local	getScheduler ()
bool	isScheduled (SEL_SCHEDULE selector)
	Checks whether a selector is scheduled. More...

void	scheduleUpdate (void)
	Schedules the "update" method. More...

void	scheduleUpdateWithPriority (int priority)
	Schedules the "update" method with a custom priority. More...

void	unscheduleUpdate (void)
void	schedule (SEL_SCHEDULE selector, float interval, unsigned int repeat, float delay)
	Schedules a custom selector. More...

void	schedule (SEL_SCHEDULE selector, float interval)
	Schedules a custom selector with an interval time in seconds. More...

void	scheduleOnce (SEL_SCHEDULE selector, float delay)
	Schedules a selector that runs only once, with a delay of 0 or larger. More...

void	schedule (SEL_SCHEDULE selector)
	Schedules a custom selector, the scheduled selector will be ticked every frame. More...

void	unschedule (SEL_SCHEDULE selector)
	Unschedules a custom selector. More...

void	unscheduleAllSelectors (void)
	Unschedule all scheduled selectors: custom selectors, and the 'update' selector. More...

void	resumeSchedulerAndActions (void)
	Resumes all scheduled selectors and actions. More...

local	resumeSchedulerAndActions ()
	Resumes all scheduled selectors and actions. More...

void	pauseSchedulerAndActions (void)
	Pauses all scheduled selectors and actions. More...

virtual void	update (float delta)
local	update ( local delta)
void	transform ()
	Performs OpenGL view-matrix transformation based on position, scale, rotation and other attributes. More...

void	transformAncestors ()
	Performs OpenGL view-matrix transformation of it's ancestors. More...

virtual void	updateTransform ()
	Calls children's updateTransform() method recursively. More...

virtual const AffineTransform &	getNodeToParentTransform () const
	Returns the matrix that transform the node's (local) space coordinates into the parent's space coordinates. More...

local	getNodeToParentTransform ()
	Returns the matrix that transform the node's (local) space coordinates into the parent's space coordinates. More...

virtual CC_DEPRECATED_ATTRIBUTE AffineTransform	nodeToParentTransform () const
local	nodeToParentTransform ()
virtual const AffineTransform &	getParentToNodeTransform () const
	Returns the matrix that transform parent's space coordinates to the node's (local) space coordinates. More...

virtual CC_DEPRECATED_ATTRIBUTE AffineTransform	parentToNodeTransform () const
local	parentToNodeTransform ()
virtual AffineTransform	getNodeToWorldTransform () const
	Returns the world affine transform matrix. More...

local	getNodeToWorldTransform ()
	Returns the world affine transform matrix. More...

virtual CC_DEPRECATED_ATTRIBUTE AffineTransform	nodeToWorldTransform () const
local	nodeToWorldTransform ()
virtual AffineTransform	getWorldToNodeTransform () const
	Returns the inverse world affine transform matrix. More...

local	getWorldToNodeTransform ()
	Returns the inverse world affine transform matrix. More...

virtual CC_DEPRECATED_ATTRIBUTE AffineTransform	worldToNodeTransform () const
local	worldToNodeTransform ()
Point	convertToNodeSpace (const Point &worldPoint) const
	Converts a Point to node (local) space coordinates. More...

Point	convertToWorldSpace (const Point &nodePoint) const
	Converts a Point to world space coordinates. More...

Point	convertToNodeSpaceAR (const Point &worldPoint) const
	Converts a Point to node (local) space coordinates. More...

Point	convertToWorldSpaceAR (const Point &nodePoint) const
	Converts a local Point to world space coordinates.The result is in Points. More...

Point	convertTouchToNodeSpace (Touch *touch) const
	convenience methods which take a Touch instead of Point More...

Point	convertTouchToNodeSpaceAR (Touch *touch) const
	converts a Touch (world coordinates) into a local coordinate. More...

void	setAdditionalTransform (const AffineTransform &additionalTransform)
	Sets the additional transform. More...

Component *	getComponent (const char *pName)
	gets a component by its name More...

virtual bool	addComponent (Component *pComponent)
	adds a component More...

local	addComponent ( local pComponent)
	adds a component More...

virtual bool	removeComponent (const char *pName)
	removes a component by its name More...

virtual void	removeAllComponents ()
	removes all components More...

	Node (void)
	Default constructor. More...

virtual	~Node (void)
	Default destructor. More...

virtual bool	init ()
	Initializes the instance of Node. More...

const char *	description (void) const
	Gets the description string. More...

Public Member Functions inherited from Object
	Object ()
	Constructor. More...

virtual	~Object ()
void	release ()
	Release the ownership immediately. More...

void	retain ()
	Retains the ownership. More...

Object *	autorelease ()
	Release the ownership sometime soon automatically. More...

bool	isSingleReference () const
	Returns a boolean value that indicates whether there is only one reference to the object. More...

unsigned int	retainCount () const
	Returns the object's current reference count. More...

virtual bool	isEqual (const Object *object)
	Returns a boolean value that indicates whether this object and a given object are equal. More...

virtual void	acceptVisitor (DataVisitor &visitor)

Static Public Member Functions
static TMXTiledMap *	create (const char *tmxFile)
	creates a TMX Tiled Map with a TMX file. More...

var	create ( var tmxFile)
	creates a TMX Tiled Map with a TMX file. More...

local	create ( local tmxFile)
	creates a TMX Tiled Map with a TMX file. More...

static TMXTiledMap *	createWithXML (const char tmxString, const char resourcePath)
	initializes a TMX Tiled Map with a TMX formatted XML string and a path to TMX resources More...

local	createWithXML ( local tmxString, local resourcePath)
	initializes a TMX Tiled Map with a TMX formatted XML string and a path to TMX resources More...

Static Public Member Functions inherited from Node
static Node *	create (void)
	Allocates and initializes a node. More...

Protected Attributes
Size	_mapSize
	the map's size property measured in tiles More...

Size	_tileSize
	the tiles's size property measured in pixels More...

var	_tileSize
	the tiles's size property measured in pixels More...

local	_tileSize
	the tiles's size property measured in pixels More...

int	_mapOrientation
	map orientation More...

var	_mapOrientation
	map orientation More...

local	_mapOrientation
	map orientation More...

Array *	_objectGroups
	object groups More...

Dictionary *	_properties
	properties More...

var	_properties
	properties More...

local	_properties
	properties More...

Dictionary *	_tileProperties
	tile properties More...

var	_tileProperties
	tile properties More...

local	_tileProperties
	tile properties More...

Protected Attributes inherited from Node
float	_rotationX
	rotation angle on x-axis More...

float	_rotationY
	rotation angle on y-axis More...

var	_rotationY
	rotation angle on y-axis More...

local	_rotationY
	rotation angle on y-axis More...

float	_scaleX
	scaling factor on x-axis More...

var	_scaleX
	scaling factor on x-axis More...

local	_scaleX
	scaling factor on x-axis More...

float	_scaleY
	scaling factor on y-axis More...

var	_scaleY
	scaling factor on y-axis More...

local	_scaleY
	scaling factor on y-axis More...

float	_vertexZ
	OpenGL real Z vertex. More...

Point	_position
	position of the node More...

float	_skewX
	skew angle on x-axis More...

var	_skewX
	skew angle on x-axis More...

local	_skewX
	skew angle on x-axis More...

float	_skewY
	skew angle on y-axis More...

var	_skewY
	skew angle on y-axis More...

local	_skewY
	skew angle on y-axis More...

Point	_anchorPointInPoints
	anchor point in points More...

var	_anchorPointInPoints
	anchor point in points More...

local	_anchorPointInPoints
	anchor point in points More...

Point	_anchorPoint
	anchor point normalized (NOT in points) More...

Size	_contentSize
	untransformed size of the node More...

local	_contentSize
	untransformed size of the node More...

AffineTransform	_additionalTransform
	transform More...

AffineTransform	_transform
	transform More...

var	_transform
	transform More...

local	_transform
	transform More...

AffineTransform	_inverse
	inverse transform More...

var	_inverse
	inverse transform More...

local	_inverse
	inverse transform More...

bool	_additionalTransformDirty
	The flag to check whether the additional transform is dirty. More...

bool	_transformDirty
	transform dirty flag More...

var	_transformDirty
	transform dirty flag More...

local	_transformDirty
	transform dirty flag More...

bool	_inverseDirty
	inverse transform dirty flag More...

var	_inverseDirty
	inverse transform dirty flag More...

local	_inverseDirty
	inverse transform dirty flag More...

Camera *	_camera
	a camera More...

GridBase *	_grid
	a grid More...

int	_ZOrder
	z-order value that affects the draw order More...

Array *	_children
	array of children nodes More...

var	_children
	array of children nodes More...

local	_children
	array of children nodes More...

Node *	_parent
	weak reference to parent node More...

int	_tag
	a tag. Can be any number you assigned just to identify this node More...

var	_tag
	a tag. Can be any number you assigned just to identify this node More...

local	_tag
	a tag. Can be any number you assigned just to identify this node More...

void *	_userData
	A user assingned void pointer, Can be point to any cpp object. More...

Object *	_userObject
	A user assigned Object. More...

local	_userObject
	A user assigned Object. More...

GLProgram *	_shaderProgram
	OpenGL shader. More...

int	_orderOfArrival
	used to preserve sequence while sorting children with the same zOrder More...

Scheduler *	_scheduler
	scheduler used to schedule timers and updates More...

ActionManager *	_actionManager
	a pointer to ActionManager singleton, which is used to handle all the actions More...

var	_actionManager
	a pointer to ActionManager singleton, which is used to handle all the actions More...

local	_actionManager
	a pointer to ActionManager singleton, which is used to handle all the actions More...

bool	_running
	is running More...

bool	_visible
	is this node visible More...

bool	_ignoreAnchorPointForPosition
	true if the Anchor Point will be (0,0) when you position the Node, false otherwise. More...

var	_ignoreAnchorPointForPosition
	true if the Anchor Point will be (0,0) when you position the Node, false otherwise. More...

local	_ignoreAnchorPointForPosition
	true if the Anchor Point will be (0,0) when you position the Node, false otherwise. More...

bool	_reorderChildDirty
	children order dirty flag More...

local	_reorderChildDirty
	children order dirty flag More...

bool	_isTransitionFinished
	flag to indicate whether the transition was finished More...

var	_isTransitionFinished
	flag to indicate whether the transition was finished More...

local	_isTransitionFinished
	flag to indicate whether the transition was finished More...

int	_scriptHandler
	script handler for onEnter() & onExit(), used in Javascript binding and Lua binding. More...

int	_updateScriptHandler
	script handler for update() callback per frame, which is invoked from lua & javascript. More...

var	_updateScriptHandler
	script handler for update() callback per frame, which is invoked from lua & javascript. More...

local	_updateScriptHandler
	script handler for update() callback per frame, which is invoked from lua & javascript. More...

ccScriptType	_scriptType
	type of script binding, lua or javascript More...

ComponentContainer *	_componentContainer
	Dictionary of components. More...

var	_componentContainer
	Dictionary of components. More...

local	_componentContainer
	Dictionary of components. More...

int	_eventPriority
	The scene graph based priority of event listener. More...

int	_oldEventPriority
	The old scene graph based priority of event listener. More...

var	_oldEventPriority
	The old scene graph based priority of event listener. More...

local	_oldEventPriority
	The old scene graph based priority of event listener. More...

Protected Attributes inherited from Object
unsigned int	_reference
	count of references More...

var	_reference
	count of references More...

local	_reference
	count of references More...

unsigned int	_autoReleaseCount
	count of autorelease More...

var	_autoReleaseCount
	count of autorelease More...

local	_autoReleaseCount
	count of autorelease More...

Additional Inherited Members
Public Attributes inherited from Object
unsigned int	_ID
	object id, ScriptSupport need public _ID More...

int	_luaID
	Lua reference id. More...

Static Public Attributes inherited from Node
static const int	INVALID_TAG = -1
	Default tag used for all the nodes. More...

var	INVALID_TAG = -1
	Default tag used for all the nodes. More...

local	INVALID_TAG = -1
	Default tag used for all the nodes. More...

Protected Member Functions inherited from Node
void	updateEventPriorityIndex ()
	Upates event priority for this node. More...

void	removeAllEventListeners ()
	Removes all event listeners that associated with this node. More...

void	setDirtyForAllEventListeners ()
	Sets dirty for event listener. More...

void	childrenAlloc (void)
	lazy allocs More...

void	insertChild (Node *child, int z)
	helper that reorder a child More...

void	detachChild (Node *child, int index, bool doCleanup)
	Removes a child, call child->onExit(), do cleanup, remove it from children array. More...

Point	convertToWindowSpace (const Point &nodePoint) const
	Convert cocos2d coordinates to UI windows coordinate. More...

Static Protected Attributes inherited from Node
static int	_globalEventPriorityIndex
	The index of global event priority. More...

Detailed Description

TMXTiledMap knows how to parse and render a TMX map.

It adds support for the TMX tiled map format used by http://www.mapeditor.org It supports isometric, hexagonal and orthogonal tiles. It also supports object groups, objects, and properties.

Features:

Each tile will be treated as an Sprite
The sprites are created on demand. They will be created only when you call "layer->tileAt(position)"
Each tile can be rotated / moved / scaled / tinted / "opaqued", since each tile is a Sprite
Tiles can be added/removed in runtime
The z-order of the tiles can be modified in runtime
Each tile has an anchorPoint of (0,0)
The anchorPoint of the TMXTileMap is (0,0)
The TMX layers will be added as a child
The TMX layers will be aliased by default
The tileset image will be loaded using the TextureCache
Each tile will have a unique tag
Each tile will have a unique z value. top-left: z=1, bottom-right: z=max z
Each object group will be treated as an MutableArray
Object class which will contain all the properties in a dictionary
Properties can be assigned to the Map, Layer, Object Group, and Object

Limitations:

It only supports one tileset per layer.
Embedded images are not supported
It only supports the XML format (the JSON format is not supported)

Technical description: Each layer is created using an TMXLayer (subclass of SpriteBatchNode). If you have 5 layers, then 5 TMXLayer will be created, unless the layer visibility is off. In that case, the layer won't be created at all. You can obtain the layers (TMXLayer objects) at runtime by:

map->getChildByTag(tag_number); // 0=1st layer, 1=2nd layer, 2=3rd layer, etc...
map->getLayer(name_of_the_layer);

Each object group is created using a TMXObjectGroup which is a subclass of MutableArray. You can obtain the object groups at runtime by:

map->getObjectGroup(name_of_the_object_group);

Each object is a TMXObject.

Each property is stored as a key-value pair in an MutableDictionary. You can obtain the properties at runtime by:

map->getProperty(name_of_the_property); layer->getProperty(name_of_the_property); objectGroup->getProperty(name_of_the_property); object->getProperty(name_of_the_property);

Since: v0.8.1

Constructor & Destructor Documentation

TMXTiledMap ( )

var ctor ( )

local TMXTiledMap ( )

virtual ~TMXTiledMap ( )

virtual

Member Function Documentation

static TMXTiledMap* create ( const char * tmxFile)

static

creates a TMX Tiled Map with a TMX file.

var create ( var tmxFile)

static

creates a TMX Tiled Map with a TMX file.

local create ( local tmxFile)

static

creates a TMX Tiled Map with a TMX file.

static TMXTiledMap* createWithXML	(	const char *	tmxString,
		const char *	resourcePath
	)

static

initializes a TMX Tiled Map with a TMX formatted XML string and a path to TMX resources

var createWithXML	(	var	tmxString,
		var	resourcePath
	)

static

initializes a TMX Tiled Map with a TMX formatted XML string and a path to TMX resources

local createWithXML	(	local	tmxString,
		local	resourcePath
	)

static

initializes a TMX Tiled Map with a TMX formatted XML string and a path to TMX resources

TMXLayer* getLayer ( const char * layerName) const

return the TMXLayer for the specific layer

var getLayer ( var layerName)

return the TMXLayer for the specific layer

local getLayer ( local layerName)

return the TMXLayer for the specific layer

int getMapOrientation ( ) const

inline

map orientation

var getMapOrientation ( )

inline

map orientation

local getMapOrientation ( )

inline

map orientation

const Size& getMapSize ( ) const

inline

the map's size property measured in tiles

var getMapSize ( )

inline

the map's size property measured in tiles

local getMapSize ( )

inline

the map's size property measured in tiles

TMXObjectGroup* getObjectGroup ( const char * groupName) const

return the TMXObjectGroup for the specific group

var getObjectGroup ( var groupName)

return the TMXObjectGroup for the specific group

local getObjectGroup ( local groupName)

return the TMXObjectGroup for the specific group

Array* getObjectGroups ( ) const

inline

object groups

var getObjectGroups ( )

inline

object groups

local getObjectGroups ( )

inline

object groups

Dictionary* getProperties ( ) const

inline

properties

var getProperties ( )

inline

properties

local getProperties ( )

inline

properties

Dictionary* getPropertiesForGID ( int GID) const

return properties dictionary for tile GID

var getPropertiesForGID ( var GID)

return properties dictionary for tile GID

local getPropertiesForGID ( local GID)

return properties dictionary for tile GID

String* getProperty ( const char * propertyName) const

return the value for the specific property name

var getProperty ( var propertyName)

return the value for the specific property name

local getProperty ( local propertyName)

return the value for the specific property name

const Size& getTileSize ( ) const

inline

the tiles's size property measured in pixels

var getTileSize ( )

inline

the tiles's size property measured in pixels

local getTileSize ( )

inline

the tiles's size property measured in pixels

bool initWithTMXFile ( const char * tmxFile)

initializes a TMX Tiled Map with a TMX file

var initWithTMXFile ( var tmxFile)

initializes a TMX Tiled Map with a TMX file

local initWithTMXFile ( local tmxFile)

initializes a TMX Tiled Map with a TMX file

bool initWithXML	(	const char *	tmxString,
		const char *	resourcePath
	)

initializes a TMX Tiled Map with a TMX formatted XML string and a path to TMX resources

var initWithXML	(	var	tmxString,
		var	resourcePath
	)

initializes a TMX Tiled Map with a TMX formatted XML string and a path to TMX resources

local initWithXML	(	local	tmxString,
		local	resourcePath
	)

initializes a TMX Tiled Map with a TMX formatted XML string and a path to TMX resources

CC_DEPRECATED_ATTRIBUTE
TMXLayer* layerNamed ( const char * layerName) const

inline

CC_DEPRECATED_ATTRIBUTE
TMXObjectGroup*
objectGroupNamed ( const char * groupName) const

inline

CC_DEPRECATED_ATTRIBUTE
Dictionary* propertiesForGID ( int GID) const

inline

var propertiesForGID ( var GID)

inline

local propertiesForGID ( local GID)

inline

CC_DEPRECATED_ATTRIBUTE String*
propertyNamed ( const char * propertyName) const

inline

void setMapOrientation ( int mapOrientation)

inline

var setMapOrientation ( var mapOrientation)

inline

local setMapOrientation ( local mapOrientation)

inline

void setMapSize ( const Size & mapSize)

inline

var setMapSize ( var mapSize)

inline

local setMapSize ( local mapSize)

inline

void setObjectGroups ( Array * groups)

inline

var setObjectGroups ( var groups)

inline

local setObjectGroups ( local groups)

inline

void setProperties ( Dictionary * properties)

inline

var setProperties ( var properties)

inline

local setProperties ( local properties)

inline

void setTileSize ( const Size & tileSize)

inline

var setTileSize ( var tileSize)

inline

local setTileSize ( local tileSize)

inline

Member Data Documentation

int _mapOrientation

protected

map orientation

var _mapOrientation

protected

map orientation

local _mapOrientation

protected

map orientation

Size _mapSize

protected

the map's size property measured in tiles

var _mapSize

protected

the map's size property measured in tiles

local _mapSize

protected

the map's size property measured in tiles

Array* _objectGroups

protected

object groups

var _objectGroups

protected

object groups

local _objectGroups

protected

object groups

Dictionary* _properties

protected

properties

var _properties

protected

properties

local _properties

protected

properties

Dictionary* _tileProperties

protected

tile properties

var _tileProperties

protected

tile properties

local _tileProperties

protected

tile properties

Size _tileSize

protected

the tiles's size property measured in pixels

var _tileSize

protected

the tiles's size property measured in pixels

local _tileSize

protected

the tiles's size property measured in pixels

The documentation for this class was generated from the following file:

/Users/cocos2d/MyWork/cocos2d-x-develop/cocos2dx/tilemap_parallax_nodes/CCTMXTiledMap.h

Public Member Functions

Static Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation