TMXObjectGroup represents the TMX object group. More...

#include <CCTMXObjectGroup.h>

Inheritance diagram for TMXObjectGroup:

Public Member Functions
	TMXObjectGroup ()
	ctor ()
	TMXObjectGroup ()
virtual	~TMXObjectGroup ()
const std::string &	getGroupName () const
	Get the group name. More...

var	getGroupName ()
	Get the group name. More...

local	getGroupName ()
	Get the group name. More...

void	setGroupName (const std::string &groupName)
	Set the group name. More...

var	setGroupName ( var groupName)
	Set the group name. More...

local	setGroupName ( local groupName)
	Set the group name. More...

Value	getProperty (const std::string &propertyName) const
	Return the value for the specific property name. More...

Value	propertyNamed (const std::string &propertyName) const
ValueMap	getObject (const std::string &objectName) const
	Return the dictionary for the specific object name. More...

local	getObject ( local objectName)
	Return the dictionary for the specific object name. More...

ValueMap	objectNamed (const std::string &objectName) const
const Vec2 &	getPositionOffset () const
	Gets the offset position of child objects. More...

void	setPositionOffset (const Vec2 &offset)
	Sets the offset position of child objects. More...

var	setPositionOffset ( var offset)
	Sets the offset position of child objects. More...

local	setPositionOffset ( local offset)
	Sets the offset position of child objects. More...

const ValueMap &	getProperties () const
	Gets the list of properties stored in a dictionary. More...

var	getProperties ()
	Gets the list of properties stored in a dictionary. More...

local	getProperties ()
	Gets the list of properties stored in a dictionary. More...

ValueMap &	getProperties ()
local	getProperties ()
void	setProperties (const ValueMap &properties)
	Sets the list of properties. More...

var	setProperties ( var properties)
	Sets the list of properties. More...

local	setProperties ( local properties)
	Sets the list of properties. More...

const ValueVector &	getObjects () const
	Gets the array of the objects. More...

local	getObjects ()
	Gets the array of the objects. More...

ValueVector &	getObjects ()
local	getObjects ()
void	setObjects (const ValueVector &objects)
	Sets the array of the objects. More...

var	setObjects ( var objects)
	Sets the array of the objects. More...

local	setObjects ( local objects)
	Sets the array of the objects. More...

Public Member Functions inherited from Ref
void	retain ()
	Retains the ownership. More...

void	release ()
	Releases the ownership immediately. More...

Ref *	autorelease ()
	Releases the ownership sometime soon automatically. More...

unsigned int	getReferenceCount () const
	Returns the Ref's current reference count. More...

virtual	~Ref ()
	Destructor. More...

Protected Attributes
std::string	_groupName
	name of the group More...

local	_groupName
	name of the group More...

Vec2	_positionOffset
	offset position of child objects More...

var	_positionOffset
	offset position of child objects More...

local	_positionOffset
	offset position of child objects More...

ValueMap	_properties
	list of properties stored in a dictionary More...

var	_properties
	list of properties stored in a dictionary More...

local	_properties
	list of properties stored in a dictionary More...

ValueVector	_objects
	array of the objects More...

var	_objects
	array of the objects More...

local	_objects
	array of the objects More...

Protected Attributes inherited from Ref
unsigned int	_referenceCount
	count of references More...

local	_referenceCount
	count of references More...

Additional Inherited Members
Protected Member Functions inherited from Ref
	Ref ()
	Constructor. More...

	Ref ()
	Constructor. More...

Detailed Description

TMXObjectGroup represents the TMX object group.

Since: v0.99.0

Constructor & Destructor Documentation

TMXObjectGroup ( )

var ctor ( )

local TMXObjectGroup ( )

virtual ~TMXObjectGroup ( )

virtual

Member Function Documentation

const std::string& getGroupName ( ) const

inline

Get the group name.

Returns: The group name.

var getGroupName ( )

inline

Get the group name.

Returns: The group name.

local getGroupName ( )

inline

Get the group name.

Returns: The group name.

ValueMap getObject ( const std::string & objectName ) const

Return the dictionary for the specific object name.

It will return the 1st object found on the array for the given name.

Returns: Return the dictionary for the specific object name.

var getObject ( var objectName )

Return the dictionary for the specific object name.

It will return the 1st object found on the array for the given name.

Returns: Return the dictionary for the specific object name.

local getObject ( local objectName )

Return the dictionary for the specific object name.

It will return the 1st object found on the array for the given name.

Returns: Return the dictionary for the specific object name.

const ValueVector& getObjects ( ) const

inline

Gets the array of the objects.

Returns: The array of the objects.

var getObjects ( )

inline

Gets the array of the objects.

Returns: The array of the objects.

local getObjects ( )

inline

Gets the array of the objects.

Returns: The array of the objects.

ValueVector& getObjects ( )

inline

var getObjects ( )

inline

local getObjects ( )

inline

const Vec2& getPositionOffset ( ) const

inline

Gets the offset position of child objects.

Returns: The offset position of child objects.

var getPositionOffset ( )

inline

Gets the offset position of child objects.

Returns: The offset position of child objects.

local getPositionOffset ( )

inline

Gets the offset position of child objects.

Returns: The offset position of child objects.

const ValueMap& getProperties ( ) const

inline

Gets the list of properties stored in a dictionary.

Returns: The list of properties stored in a dictionary.

var getProperties ( )

inline

Gets the list of properties stored in a dictionary.

Returns: The list of properties stored in a dictionary.

local getProperties ( )

inline

Gets the list of properties stored in a dictionary.

Returns: The list of properties stored in a dictionary.

ValueMap& getProperties ( )

inline

var getProperties ( )

inline

local getProperties ( )

inline

Value getProperty ( const std::string & propertyName ) const

Return the value for the specific property name.

Parameters

propertyName The specific property name.

Returns: Return the value for the specific property name.

var getProperty ( var propertyName )

Return the value for the specific property name.

Parameters

propertyName The specific property name.

Returns: Return the value for the specific property name.

local getProperty ( local propertyName )

Return the value for the specific property name.

Parameters

propertyName The specific property name.

Returns: Return the value for the specific property name.

ValueMap objectNamed ( const std::string & objectName ) const

inline

var objectNamed ( var objectName )

inline

local objectNamed ( local objectName )

inline

Value propertyNamed ( const std::string & propertyName ) const

inline

var propertyNamed ( var propertyName )

inline

local propertyNamed ( local propertyName )

inline

void setGroupName ( const std::string & groupName )

inline

Set the group name.

Parameters

groupname A string,it is used to set the group name.

var setGroupName ( var groupName )

inline

Set the group name.

Parameters

groupname A string,it is used to set the group name.

local setGroupName ( local groupName )

inline

Set the group name.

Parameters

groupname A string,it is used to set the group name.

void setObjects ( const ValueVector & objects )

inline

Sets the array of the objects.

Parameters

objects The array of the objects.

var setObjects ( var objects )

inline

Sets the array of the objects.

Parameters

objects The array of the objects.

local setObjects ( local objects )

inline

Sets the array of the objects.

Parameters

objects The array of the objects.

void setPositionOffset ( const Vec2 & offset )

inline

Sets the offset position of child objects.

Parameters

offset The offset position of child objects.

var setPositionOffset ( var offset )

inline

Sets the offset position of child objects.

Parameters

offset The offset position of child objects.

local setPositionOffset ( local offset )

inline

Sets the offset position of child objects.

Parameters

offset The offset position of child objects.

void setProperties ( const ValueMap & properties )

inline

Sets the list of properties.

Parameters

properties The list of properties.

var setProperties ( var properties )

inline

Sets the list of properties.

Parameters

properties The list of properties.

local setProperties ( local properties )

inline

Sets the list of properties.

Parameters

properties The list of properties.

Member Data Documentation

std::string _groupName

protected

name of the group

var _groupName

protected

name of the group

local _groupName

protected

name of the group

ValueVector _objects

protected

array of the objects

var _objects

protected

array of the objects

local _objects

protected

array of the objects

Vec2 _positionOffset

protected

offset position of child objects

var _positionOffset

protected

offset position of child objects

local _positionOffset

protected

offset position of child objects

ValueMap _properties

protected

list of properties stored in a dictionary

var _properties

protected

list of properties stored in a dictionary

local _properties

protected

list of properties stored in a dictionary

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

/Users/minggo/SourceCode/cocos2d-x/cocos/2d/CCTMXObjectGroup.h

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation