CCTMXLayer represents the TMX layer. More...

#include <CCTMXLayer.h>

Inheritance diagram for CCTMXLayer:

Collaboration diagram for CCTMXLayer:

Public Member Functions
virtual const CCSize &	getLayerSize (void)

virtual void	setLayerSize (const CCSize &var)

virtual const CCSize &	getMapTileSize (void)

virtual void	setMapTileSize (const CCSize &var)

virtual unsigned int *	getTiles (void)

virtual void	setTiles (unsigned int *var)

virtual CCTMXTilesetInfo *	getTileSet (void)

virtual void	setTileSet (CCTMXTilesetInfo *var)

virtual unsigned int	getLayerOrientation (void)

virtual void	setLayerOrientation (unsigned int var)

virtual CCDictionary *	getProperties (void)

virtual void	setProperties (CCDictionary *var)

	CCTMXLayer ()
	ctor NA More...

virtual	~CCTMXLayer ()
	NA NA. More...

bool	initWithTilesetInfo (CCTMXTilesetInfo tilesetInfo, CCTMXLayerInfo layerInfo, CCTMXMapInfo *mapInfo)
	initializes a CCTMXLayer with a tileset info, a layer info and a map info NA More...

void	releaseMap ()
	dealloc the map that contains the tile position from memory. More...

CCSprite *	tileAt (const CCPoint &tileCoordinate)
	returns the tile (CCSprite) at a given a tile coordinate. More...

unsigned int	tileGIDAt (const CCPoint &tileCoordinate)
	returns the tile gid at a given tile coordinate. More...

unsigned int	tileGIDAt (const CCPoint &tileCoordinate, ccTMXTileFlags *flags)
	returns the tile gid at a given tile coordinate. More...

void	setTileGID (unsigned int gid, const CCPoint &tileCoordinate)
	sets the tile gid (gid = tile global id) at a given tile coordinate. More...

void	setTileGID (unsigned int gid, const CCPoint &tileCoordinate, ccTMXTileFlags flags)
	sets the tile gid (gid = tile global id) at a given tile coordinate. More...

void	removeTileAt (const CCPoint &tileCoordinate)
	removes a tile at given tile coordinate More...

CCPoint	positionAt (const CCPoint &tileCoordinate)
	returns the position in points of a given tile coordinate getPositionAt More...

CCString *	propertyNamed (const char *propertyName)
	return the value for the specific property name getProperty More...

void	setupTiles ()
	Creates the tiles. More...

virtual void	addChild (CCNode *child, int zOrder, int tag)
	CCTMXLayer doesn't support adding a CCSprite manually. More...

void	removeChild (CCNode *child, bool cleanup)
	super method NA More...

const char *	getLayerName ()

void	setLayerName (const char *layerName)

Public Member Functions inherited from CCSpriteBatchNode
	CCSpriteBatchNode ()
	ctor More...

	~CCSpriteBatchNode ()
	NA NA. More...

CCTextureAtlas *	getTextureAtlas (void)

void	setTextureAtlas (CCTextureAtlas *textureAtlas)

CCArray *	getDescendants (void)

bool	initWithTexture (CCTexture2D *tex, unsigned int capacity)
	initializes a CCSpriteBatchNode with a texture2d and capacity of children. More...

bool	initWithFile (const char *fileImage, unsigned int capacity)
	initializes a CCSpriteBatchNode with a file image (.png, .jpeg, .pvr, etc) and a capacity of children. More...

bool	init ()
	Initializes the instance of CCNode. More...

void	increaseAtlasCapacity ()

void	removeChildAtIndex (unsigned int index, bool doCleanup)
	removes a child given a certain index. More...

void	insertChild (CCSprite *child, unsigned int index)

void	appendChild (CCSprite *sprite)

void	removeSpriteFromAtlas (CCSprite *sprite)

unsigned int	rebuildIndexInOrder (CCSprite *parent, unsigned int index)

unsigned int	highestAtlasIndexInChild (CCSprite *sprite)

unsigned int	lowestAtlasIndexInChild (CCSprite *sprite)

unsigned int	atlasIndexForChild (CCSprite *sprite, int z)

void	reorderBatch (bool reorder)

virtual CCTexture2D *	getTexture (void)
	Returns the currently used texture. More...

virtual void	setTexture (CCTexture2D *texture)
	Sets a new texuture. More...

virtual void	setBlendFunc (ccBlendFunc blendFunc)
	Sets the source blending function. More...

virtual ccBlendFunc	getBlendFunc (void)
	NA. More...

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

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

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

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

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

virtual void	removeChild (CCNode *child, bool cleanup)
	Removes a child from the container. 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...

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

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

Public Member Functions inherited from CCNode
virtual	~CCNode (void)
	Default destructor NA NA. More...

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

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

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

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

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

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

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

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

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

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

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

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

virtual void	setGLServerState (ccGLServerState glServerState)
	Sets the state of OpenGL server side. More...

virtual ccGLServerState	getGLServerState ()
	Returns the state of OpenGL server side. More...

virtual void	ignoreAnchorPointForPosition (bool ignore)
	Sets whether the anchor point will be (0,0) when you position this node. More...

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

virtual void	removeChild (CCNode *child)
	Removes a child from the container with a cleanup. More...

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

virtual void	removeChildByTag (int tag)
	Removes a child from the container by tag value with a cleanup. More...

virtual void	removeChildByTag (int tag, bool cleanup)
	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...

virtual void	reorderChild (CCNode *child, int 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 CCCamera *	getCamera ()
	Returns a camera object that lets you move the node using a gluLookAt. More...

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

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

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

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

CCRect	boundingBox (void)
	Returns a "local" axis aligned bounding box of the node. More...

virtual CCAffineTransform	nodeToWorldTransform (void)
	Returns the world affine transform matrix. More...

virtual CCAffineTransform	worldToNodeTransform (void)
	Returns the inverse world affine transform matrix. More...

	CCNode (void)
	Default constructor ctor. More...

	CCNode (const CCNode &)

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...

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

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

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

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

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

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

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

virtual float	getScaleY ()
	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...

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

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

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

virtual const CCPoint &	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)
	Gets position in a more efficient way, returns two number instead of a CCPoint object. More...

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

virtual float	getPositionX (void)
	Sets the Z order which stands for the drawing order, and reorder this node in its parent's children array. More...

virtual void	setPositionY (float y)
	Sets the Z order which stands for the drawing order, and reorder this node in its parent's children array. More...

virtual float	getPositionY (void)
	Sets the Z order which stands for the drawing order, and reorder this node in its parent's children array. More...

virtual void	setSkewX (float fSkewX)
	Changes the X skew angle of the node in degrees. More...

virtual float	getSkewX ()
	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...

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

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

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

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

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

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

virtual CCSize	getScaledContentSize (void)

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

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

virtual unsigned int	getChildrenCount (void) const
	Get the amount of children. More...

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

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

virtual void	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...

virtual void	removeMeAndCleanup (void)

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

virtual void	setGrid (CCGridBase *pGrid)
	Changes a grid object that is used when applying effects. More...

virtual void *	getUserData ()
	Returns a tag that is used to identify the node easily. More...

virtual void	setUserData (void *pUserData)
	Sets a custom user data pointer. More...

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

virtual void	setUserObject (CCObject *pUserObject)
	Returns a user assigned CCObject. More...

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

virtual void	setShaderProgram (CCGLProgram *pShaderProgram)
	Sets the shader program for this node. More...

virtual void	registerScriptHandler (int handler)
	Registers a script function that will be called in onEnter() & onExit() seires functions. More...

virtual void	unregisterScriptHandler (void)
	Unregisters a script function that will be called in onEnter() & onExit() series functions. More...

int	getScriptHandler ()
	Gets script handler for onEnter/onExit event. More...

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

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

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

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

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

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

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

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

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

void	stopAction (CCAction *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...

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

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

virtual void	setScheduler (CCScheduler *scheduler)
	Sets a CCScheduler object that is used to schedule all "updates" and timers. More...

virtual CCScheduler *	getScheduler ()
	Gets a CCSheduler object. More...

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)
	Sets a CCScheduler object that is used to schedule all "updates" and timers. More...

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...

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

virtual void	update (float delta)
	Sets a CCScheduler object that is used to schedule all "updates" and timers. More...

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

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

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

virtual const CCAffineTransform	nodeToParentTransform (void)
	Returns the matrix that transform the node's (local) space coordinates into the parent's space coordinates. More...

virtual const CCAffineTransform	parentToNodeTransform (void)
	Returns the matrix that transform parent's space coordinates to the node's (local) space coordinates. More...

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

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

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

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

CCPoint	convertTouchToNodeSpace (CCTouch *touch)
	convenience methods which take a CCTouch instead of CCPoint More...

CCPoint	convertTouchToNodeSpaceAR (CCTouch *touch)
	converts a CCTouch (world coordinates) into a local coordinate. More...

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

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

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

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

virtual bool	removeComponent (CCComponent *pComponent)
	removes a component by its pointer More...

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

virtual void	updateTweenAction (float, const char *)

CCNode &	operator= (const CCNode &)

Public Member Functions inherited from CCObject
	CCObject (void)

virtual	~CCObject (void)
	NA. More...

void	release (void)

void	retain (void)

CCObject *	autorelease (void)

CCObject *	copy (void)

bool	isSingleReference (void) const

unsigned int	retainCount (void) const

virtual bool	isEqual (const CCObject *pObject)

virtual void	acceptVisitor (CCDataVisitor &visitor)

virtual void	update (float dt)

	CCObject (const CCObject &)

CCObject &	operator= (const CCObject &)

virtual void	encodeWithCoder (DS_Dictionary *)

virtual bool	canEncode ()

CCObjectType	getObjType () const

virtual int	getTag () const

virtual void	setTag (int nTag)

void	setObjType (CCObjectType)

Public Member Functions inherited from CCCopying
virtual CCObject *	copyWithZone (CCZone *pZone)

virtual CCTexture2D *	getTexture (void)=0
	Returns the currently used texture. More...

virtual void	setTexture (CCTexture2D *texture)=0
	Sets a new texuture. More...

virtual void	setBlendFunc (ccBlendFunc blendFunc)=0
	Sets the source blending function. More...

virtual ccBlendFunc	getBlendFunc (void)=0
	Returns the blending function that is currently being used. More...

Static Public Member Functions
static CCTMXLayer *	create (CCTMXTilesetInfo tilesetInfo, CCTMXLayerInfo layerInfo, CCTMXMapInfo *mapInfo)
	creates a CCTMXLayer with an tileset info, a layer info and a map info More...

Static Public Member Functions inherited from CCSpriteBatchNode
static CCSpriteBatchNode *	createWithTexture (CCTexture2D *tex, unsigned int capacity)
	creates a CCSpriteBatchNode with a texture2d and capacity of children. More...

static CCSpriteBatchNode *	createWithTexture (CCTexture2D *tex)

static CCSpriteBatchNode *	create (const char *fileImage, unsigned int capacity)
	creates a CCSpriteBatchNode with a file image (.png, .jpeg, .pvr, etc) and capacity of children. More...

static CCSpriteBatchNode *	create (const char *fileImage)

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

Static Public Member Functions inherited from CCObject
static CCObject *	createWithCoder (DS_Dictionary *)

Protected Attributes
CCSize	m_tLayerSize
	size of the layer in tiles More...

CCSize	m_tMapTileSize
	size of the map's tile (could be different from the tile's size) More...

unsigned int *	m_pTiles
	pointer to the map of tiles More...

CCTMXTilesetInfo *	m_pTileSet
	Tileset information for the layer. More...

unsigned int	m_uLayerOrientation
	Layer orientation, which is the same as the map orientation. More...

CCDictionary *	m_pProperties
	properties from the layer. More...

std::string	m_sLayerName
	name of the layer More...

unsigned char	m_cOpacity
	TMX Layer supports opacity. More...

unsigned int	m_uMinGID

unsigned int	m_uMaxGID

int	m_nVertexZvalue
	Only used when vertexZ is used. More...

bool	m_bUseAutomaticVertexZ

CCSprite *	m_pReusedTile
	used for optimization More...

ccCArray *	m_pAtlasIndexArray

float	m_fContentScaleFactor

Protected Attributes inherited from CCSpriteBatchNode
CCTextureAtlas *	m_pobTextureAtlas

ccBlendFunc	m_blendFunc

CCArray *	m_pobDescendants

bool	m_bManualSortChildren

bool	m_bManualSortAllChildrenDirty

Protected Attributes inherited from CCNode
float	m_fRotationX
	rotation angle on x-axis More...

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

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

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

float	m_fVertexZ
	OpenGL real Z vertex. More...

CCPoint	m_obPosition
	position of the node More...

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

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

CCPoint	m_obAnchorPointInPoints
	anchor point in points More...

CCPoint	m_obAnchorPoint
	anchor point normalized (NOT in points) More...

CCSize	m_obContentSize
	untransformed size of the node More...

CCAffineTransform	m_sAdditionalTransform
	transform More...

CCAffineTransform	m_sTransform
	transform More...

CCAffineTransform	m_sInverse
	transform More...

CCCamera *	m_pCamera
	a camera More...

CCGridBase *	m_pGrid
	a grid More...

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

CCArray *	m_pChildren
	array of children nodes More...

CCNode *	m_pParent
	weak reference to parent node More...

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

CCObject *	m_pUserObject
	A user assigned CCObject. More...

CCGLProgram *	m_pShaderProgram
	OpenGL shader. More...

ccGLServerState	m_eGLServerState
	OpenGL servier side state. More...

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

CCScheduler *	m_pScheduler
	scheduler used to schedule timers and updates More...

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

bool	m_bRunning
	is running More...

bool	m_bTransformDirty
	transform dirty flag More...

bool	m_bInverseDirty
	transform dirty flag More...

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

bool	m_bVisible
	is this node visible More...

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

bool	m_bReorderChildDirty
	children order dirty flag More...

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

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

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

CCComponentContainer *	m_pComponentContainer
	Dictionary of components. More...

Protected Attributes inherited from CCObject
unsigned int	m_uReference

unsigned int	m_uAutoReleaseCount

int	m_nTag

int	m_eObjType

unsigned int	m_uObjectIdxInArray

Additional Inherited Members
Public Attributes inherited from CCObject
unsigned int	m_uID

int	m_nLuaID

Protected Member Functions inherited from CCSpriteBatchNode
void	insertQuadFromSprite (CCSprite *sprite, unsigned int index)
	Inserts a quad at a certain index into the texture atlas. More...

void	updateQuadFromSprite (CCSprite *sprite, unsigned int index)
	Updates a quad at a certain index into the texture atlas. More...

CCSpriteBatchNode *	addSpriteWithoutQuad (CCSprite *child, unsigned int z, int aTag)

Detailed Description

CCTMXLayer represents the TMX layer.

It is a subclass of CCSpriteBatchNode. By default the tiles are rendered using a CCTextureAtlas. If you modify a tile on runtime, then, that tile will become a CCSprite, otherwise no CCSprite objects are created. The benefits of using CCSprite objects as tiles are:

tiles (CCSprite) can be rotated/scaled/moved with a nice API

If the layer contains a property named "cc_vertexz" with an integer (in can be positive or negative), then all the tiles belonging to the layer will use that value as their OpenGL vertex Z for depth.

On the other hand, if the "cc_vertexz" property has the "automatic" value, then the tiles will use an automatic vertex Z value. Also before drawing the tiles, GL_ALPHA_TEST will be enabled, and disabled after drawing them. The used alpha func will be:

glAlphaFunc( GL_GREATER, value )

"value" by default is 0, but you can change it from Tiled by adding the "cc_alpha_func" property to the layer. The value 0 should work for most cases, but if you have tiles that are semi-transparent, then you might want to use a different value, like 0.5.

For further information, please see the programming guide:

http://www.cocos2d-iphone.org/wiki/doku.php/prog_guide:tiled_maps

Since: v0.8.1 Tiles can have tile flags for additional properties. At the moment only flip horizontal and flip vertical are used. These bit flags are defined in CCTMXXMLParser.h.; 1.1

Constructor & Destructor Documentation

◆ CCTMXLayer()

CCTMXLayer ( )

ctor NA

◆ ~CCTMXLayer()

virtual ~CCTMXLayer ( )

virtual

NA NA.

Member Function Documentation

◆ addChild()

virtual void addChild	(	CCNode *	child,
		int	zOrder,
		int	tag
	)

virtual

CCTMXLayer doesn't support adding a CCSprite manually.

Warning: addchild(z, tag); is not supported on CCTMXLayer. Instead of setTileGID. NA

Reimplemented from CCSpriteBatchNode.

◆ create()

static CCTMXLayer * create	(	CCTMXTilesetInfo *	tilesetInfo,
		CCTMXLayerInfo *	layerInfo,
		CCTMXMapInfo *	mapInfo
	)

static

creates a CCTMXLayer with an tileset info, a layer info and a map info

◆ getLayerName()

const char * getLayerName ( )

inline

◆ getLayerOrientation()

virtual unsigned int getLayerOrientation ( void )

virtual

◆ getLayerSize()

virtual const CCSize & getLayerSize ( void )

virtual

◆ getMapTileSize()

virtual const CCSize & getMapTileSize ( void )

virtual

◆ getProperties()

virtual CCDictionary * getProperties ( void )

virtual

◆ getTiles()

virtual unsigned int * getTiles ( void )

virtual

◆ getTileSet()

virtual CCTMXTilesetInfo * getTileSet ( void )

virtual

◆ initWithTilesetInfo()

bool initWithTilesetInfo	(	CCTMXTilesetInfo *	tilesetInfo,
		CCTMXLayerInfo *	layerInfo,
		CCTMXMapInfo *	mapInfo
	)

initializes a CCTMXLayer with a tileset info, a layer info and a map info NA

◆ positionAt()

CCPoint positionAt ( const CCPoint & tileCoordinate )

returns the position in points of a given tile coordinate getPositionAt

◆ propertyNamed()

CCString * propertyNamed ( const char * propertyName )

return the value for the specific property name getProperty

◆ releaseMap()

void releaseMap ( )

dealloc the map that contains the tile position from memory.

Unless you want to know at runtime the tiles positions, you can safely call this method. If you are going to call layer->tileGIDAt() then, don't release the map

◆ removeChild()

void removeChild	(	CCNode *	child,
		bool	cleanup
	)

virtual

super method NA

Reimplemented from CCSpriteBatchNode.

◆ removeTileAt()

void removeTileAt ( const CCPoint & tileCoordinate )

removes a tile at given tile coordinate

◆ setLayerName()

void setLayerName ( const char * layerName )

inline

◆ setLayerOrientation()

virtual void setLayerOrientation ( unsigned int var )

virtual

◆ setLayerSize()

virtual void setLayerSize ( const CCSize & var )

virtual

◆ setMapTileSize()

virtual void setMapTileSize ( const CCSize & var )

virtual

◆ setProperties()

virtual void setProperties ( CCDictionary * var )

virtual

◆ setTileGID() [1/2]

void setTileGID	(	unsigned int	gid,
		const CCPoint &	tileCoordinate
	)

sets the tile gid (gid = tile global id) at a given tile coordinate.

The Tile GID can be obtained by using the method "tileGIDAt" or by using the TMX editor -> Tileset Mgr +1. If a tile is already placed at that position, then it will be removed.

◆ setTileGID() [2/2]

void setTileGID	(	unsigned int	gid,
		const CCPoint &	tileCoordinate,
		ccTMXTileFlags	flags
	)

sets the tile gid (gid = tile global id) at a given tile coordinate.

The Tile GID can be obtained by using the method "tileGIDAt" or by using the TMX editor -> Tileset Mgr +1. If a tile is already placed at that position, then it will be removed.

Use withFlags if the tile flags need to be changed as well

◆ setTiles()

virtual void setTiles ( unsigned int * var )

virtual

◆ setTileSet()

virtual void setTileSet ( CCTMXTilesetInfo * var )

virtual

◆ setupTiles()

void setupTiles ( )

Creates the tiles.

◆ tileAt()

CCSprite * tileAt ( const CCPoint & tileCoordinate )

returns the tile (CCSprite) at a given a tile coordinate.

The returned CCSprite will be already added to the CCTMXLayer. Don't add it again. The CCSprite can be treated like any other CCSprite: rotated, scaled, translated, opacity, color, etc. You can remove either by calling:

layer->removeChild(sprite, cleanup);
or layer->removeTileAt(ccp(x,y)); getTileGIDAt

◆ tileGIDAt() [1/2]

unsigned int tileGIDAt ( const CCPoint & tileCoordinate )

returns the tile gid at a given tile coordinate.

if it returns 0, it means that the tile is empty. This method requires the the tile map has not been previously released (eg. don't call layer->releaseMap()) tileGIDAt

◆ tileGIDAt() [2/2]

unsigned int tileGIDAt	(	const CCPoint &	tileCoordinate,
		ccTMXTileFlags *	flags
	)

returns the tile gid at a given tile coordinate.

It also returns the tile flags. This method requires the the tile map has not been previously released (eg. don't call [layer releaseMap]) tileGIDAt NA

Member Data Documentation

◆ m_bUseAutomaticVertexZ

bool m_bUseAutomaticVertexZ

protected

◆ m_cOpacity

unsigned char m_cOpacity

protected

TMX Layer supports opacity.

◆ m_fContentScaleFactor

float m_fContentScaleFactor

protected

◆ m_nVertexZvalue

int m_nVertexZvalue

protected

Only used when vertexZ is used.

◆ m_pAtlasIndexArray

ccCArray* m_pAtlasIndexArray

protected

◆ m_pProperties

CCDictionary* m_pProperties

protected

properties from the layer.

They can be added using Tiled

◆ m_pReusedTile

CCSprite* m_pReusedTile

protected

used for optimization

◆ m_pTiles

unsigned int* m_pTiles

protected

pointer to the map of tiles

◆ m_pTileSet

CCTMXTilesetInfo* m_pTileSet

protected

Tileset information for the layer.

◆ m_sLayerName

std::string m_sLayerName

protected

name of the layer

◆ m_tLayerSize

CCSize m_tLayerSize

protected

size of the layer in tiles

◆ m_tMapTileSize

CCSize m_tMapTileSize

protected

size of the map's tile (could be different from the tile's size)

◆ m_uLayerOrientation

unsigned int m_uLayerOrientation

protected

Layer orientation, which is the same as the map orientation.

◆ m_uMaxGID

unsigned int m_uMaxGID

protected

◆ m_uMinGID

unsigned int m_uMinGID

protected

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

/home/runner/work/cocos-headers/cocos-headers/cocos2dx/tilemap_parallax_nodes/CCTMXLayer.h

Public Member Functions

Static Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ CCTMXLayer()

◆ ~CCTMXLayer()

Member Function Documentation

◆ addChild()

◆ create()

◆ getLayerName()

◆ getLayerOrientation()

◆ getLayerSize()

◆ getMapTileSize()

◆ getProperties()

◆ getTiles()

◆ getTileSet()

◆ initWithTilesetInfo()

◆ positionAt()

◆ propertyNamed()

◆ releaseMap()

◆ removeChild()

◆ removeTileAt()

◆ setLayerName()

◆ setLayerOrientation()

◆ setLayerSize()

◆ setMapTileSize()

◆ setProperties()

◆ setTileGID() [1/2]

◆ setTileGID() [2/2]

◆ setTiles()

◆ setTileSet()

◆ setupTiles()

◆ tileAt()

◆ tileGIDAt() [1/2]

◆ tileGIDAt() [2/2]

Member Data Documentation

◆ m_bUseAutomaticVertexZ

◆ m_cOpacity

◆ m_fContentScaleFactor

◆ m_nVertexZvalue

◆ m_pAtlasIndexArray

◆ m_pProperties

◆ m_pReusedTile

◆ m_pTiles

◆ m_pTileSet

◆ m_sLayerName

◆ m_tLayerSize

◆ m_tMapTileSize

◆ m_uLayerOrientation

◆ m_uMaxGID

◆ m_uMinGID