cocos2d-x  3.0
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
TMXObjectGroup Class Reference

TMXObjectGroup represents the TMX object group. More...

#include <CCTMXObjectGroup.h>

Inheritance diagram for TMXObjectGroup:
Ref

Public Member Functions

 TMXObjectGroup ()
virtual ~TMXObjectGroup ()
const std::string & getGroupName ()
void setGroupName (const std::string &groupName)
Value getProperty (const std::string &propertyName) const
 return the value for the specific property name More...
 
CC_DEPRECATED_ATTRIBUTE Value propertyNamed (const std::string &propertyName) const
ValueMap getObject (const std::string &objectName) const
 return the dictionary for the specific object name. More...
 
CC_DEPRECATED_ATTRIBUTE ValueMap objectNamed (const std::string &objectName) const
const PointgetPositionOffset () const
 Gets the offset position of child objects. More...
 
void setPositionOffset (const Point &offset)
 Sets the offset position of child objects. More...
 
const ValueMapgetProperties () const
 Gets the list of properties stored in a dictionary. More...
 
ValueMapgetProperties ()
void setProperties (const ValueMap &properties)
 Sets the list of properties. More...
 
const ValueVectorgetObjects () const
 Gets the array of the objects. More...
 
ValueVectorgetObjects ()
void setObjects (const ValueVector &objects)
 Sets the array of the objects. More...
 
- Public Member Functions inherited from Ref
void retain ()
 Retains the ownership. More...
 
void release ()
 Release the ownership immediately. More...
 
Refautorelease ()
 Release the ownership sometime soon automatically. More...
 
unsigned int getReferenceCount () const
 Returns the Ref's current reference count. More...
 
virtual ~Ref ()

Protected Attributes

std::string _groupName
 name of the group More...
 
Point _positionOffset
 offset position of child objects More...
 
ValueMap _properties
 list of properties stored in a dictionary More...
 
ValueVector _objects
 array of the objects More...
 
- Protected Attributes inherited from Ref
unsigned int _referenceCount
 count of references More...
 

Additional Inherited Members

- Protected Member Functions inherited from Ref
 Ref ()
 Constructor. More...
 

Detailed Description

TMXObjectGroup represents the TMX object group.

Since
v0.99.0

Constructor & Destructor Documentation

virtual ~TMXObjectGroup ( )
virtual

Member Function Documentation

const std::string& getGroupName ( )
inline
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.

const ValueVector& getObjects ( ) const
inline

Gets the array of the objects.

ValueVector& getObjects ( )
inline
const Point& getPositionOffset ( ) const
inline

Gets the offset position of child objects.

const ValueMap& getProperties ( ) const
inline

Gets the list of properties stored in a dictionary.

ValueMap& getProperties ( )
inline
Value getProperty ( const std::string &  propertyName) const

return the value for the specific property name

CC_DEPRECATED_ATTRIBUTE
ValueMap objectNamed
( const std::string &  objectName) const
inline
CC_DEPRECATED_ATTRIBUTE Value
propertyNamed
( const std::string &  propertyName) const
inline
void setGroupName ( const std::string &  groupName)
inline
void setObjects ( const ValueVector objects)
inline

Sets the array of the objects.

void setPositionOffset ( const Point offset)
inline

Sets the offset position of child objects.

void setProperties ( const ValueMap properties)
inline

Sets the list of properties.

Member Data Documentation

std::string _groupName
protected

name of the group

ValueVector _objects
protected

array of the objects

Point _positionOffset
protected

offset position of child objects

ValueMap _properties
protected

list of properties stored in a dictionary


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