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

#include <CCArray.h>

Inheritance diagram for CCArray:
CCObject CCCopying CCArrayForObjectSorting

Public Member Functions

 ~CCArray ()
bool init ()
 Initializes an array. More...
 
bool initWithObject (CCObject *pObject)
 Initializes an array with one object. More...
 
bool initWithObjects (CCObject *pObject,...)
 Initializes an array with some objects. More...
 
bool initWithCapacity (unsigned int capacity)
 Initializes an array with capacity. More...
 
bool initWithArray (CCArray *otherArray)
 Initializes an array with an existing array. More...
 
unsigned int count () const
 Returns element count of the array. More...
 
unsigned int capacity () const
 Returns capacity of the array. More...
 
local capacity ()
 Returns capacity of the array. More...
 
unsigned int indexOfObject (CCObject *object) const
 Returns index of a certain object, return UINT_MAX if doesn't contain the object. More...
 
local indexOfObject ( local object)
 Returns index of a certain object, return UINT_MAX if doesn't contain the object. More...
 
CCObjectobjectAtIndex (unsigned int index)
 Returns an element with a certain index. More...
 
local objectAtIndex ( local index)
 Returns an element with a certain index. More...
 
CCObjectlastObject ()
 Returns last element. More...
 
CCObjectrandomObject ()
 Returns a random element. More...
 
local randomObject ()
 Returns a random element. More...
 
bool containsObject (CCObject *object) const
 Returns a Boolean value that indicates whether object is present in array. More...
 
local containsObject ( local object)
 Returns a Boolean value that indicates whether object is present in array. More...
 
bool isEqualToArray (CCArray *pOtherArray)
void addObject (CCObject *object)
 Add a certain object. More...
 
local addObject ( local object)
 Add a certain object. More...
 
void addObjectsFromArray (CCArray *otherArray)
 Add all elements of an existing array. More...
 
local addObjectsFromArray ( local otherArray)
 Add all elements of an existing array. More...
 
void insertObject (CCObject *object, unsigned int index)
 Insert a certain object at a certain index. More...
 
local insertObject ( local object, local index)
 Insert a certain object at a certain index. More...
 
void removeLastObject (bool bReleaseObj=true)
 Remove last object. More...
 
void removeObject (CCObject *object, bool bReleaseObj=true)
 Remove a certain object. More...
 
local removeObject ( local object, local true)
 Remove a certain object. More...
 
void removeObjectAtIndex (unsigned int index, bool bReleaseObj=true)
 Remove an element with a certain index. More...
 
local removeObjectAtIndex ( local index, local true)
 Remove an element with a certain index. More...
 
void removeObjectsInArray (CCArray *otherArray)
 Remove all elements. More...
 
local removeObjectsInArray ( local otherArray)
 Remove all elements. More...
 
void removeAllObjects ()
 Remove all objects. More...
 
local removeAllObjects ()
 Remove all objects. More...
 
void fastRemoveObject (CCObject *object)
 Fast way to remove a certain object. More...
 
local fastRemoveObject ( local object)
 Fast way to remove a certain object. More...
 
void fastRemoveObjectAtIndex (unsigned int index)
 Fast way to remove an element with a certain index. More...
 
local fastRemoveObjectAtIndex ( local index)
 Fast way to remove an element with a certain index. More...
 
void exchangeObject (CCObject *object1, CCObject *object2)
 Swap two elements. More...
 
local exchangeObject ( local object1, local object2)
 Swap two elements. More...
 
void exchangeObjectAtIndex (unsigned int index1, unsigned int index2)
 Swap two elements with certain indexes. More...
 
local exchangeObjectAtIndex ( local index1, local index2)
 Swap two elements with certain indexes. More...
 
void replaceObjectAtIndex (unsigned int uIndex, CCObject *pObject, bool bReleaseObject=true)
 Replace object at index with another object. More...
 
local replaceObjectAtIndex ( local uIndex, local pObject, local true)
 Replace object at index with another object. More...
 
void reverseObjects ()
 Revers the array. More...
 
void reduceMemoryFootprint ()
local reduceMemoryFootprint ()
virtual CCObjectcopyWithZone (CCZone *pZone)
 override functions More...
 
virtual void acceptVisitor (CCDataVisitor &visitor)
 CCArray ()
 CCArray (unsigned int capacity)
- Public Member Functions inherited from CCObject
 CCObject (void)
virtual ~CCObject (void)
void release (void)
void retain (void)
CCObjectautorelease (void)
CCObjectcopy (void)
bool isSingleReference (void) const
unsigned int retainCount (void) const
virtual bool isEqual (const CCObject *pObject)
virtual void update (float dt)

Static Public Member Functions

static CCArraycreate ()
 Create an array. More...
 
local create ()
 Create an array. More...
 
static CCArraycreate (CCObject *pObject,...)
 Create an array with some objects. More...
 
static CCArraycreateWithObject (CCObject *pObject)
 Create an array with one object. More...
 
local createWithObject ( local pObject)
 Create an array with one object. More...
 
static CCArraycreateWithCapacity (unsigned int capacity)
 Create an array with capacity. More...
 
local createWithCapacity ( local capacity)
 Create an array with capacity. More...
 
static CCArraycreateWithArray (CCArray *otherArray)
 Create an array with an existing array. More...
 
local createWithArray ( local otherArray)
 Create an array with an existing array. More...
 
static CCArraycreateWithContentsOfFile (const char *pFileName)
 Generate a CCArray pointer by file. More...
 
local createWithContentsOfFile ( local pFileName)
 Generate a CCArray pointer by file. More...
 
static CCArraycreateWithContentsOfFileThreadSafe (const char *pFileName)

Public Attributes

ccArray * data
- Public Attributes inherited from CCObject
unsigned int m_uID
int m_nLuaID

Additional Inherited Members

- Protected Attributes inherited from CCObject
unsigned int m_uReference
unsigned int m_uAutoReleaseCount

Constructor & Destructor Documentation

~CCArray ( )
CCArray ( )
CCArray ( unsigned int  capacity)

Member Function Documentation

virtual void acceptVisitor ( CCDataVisitor visitor)
virtual

Reimplemented from CCObject.

local acceptVisitor ( local  visitor)
virtual

Reimplemented from CCObject.

void addObject ( CCObject object)

Add a certain object.

local addObject ( local  object)

Add a certain object.

void addObjectsFromArray ( CCArray otherArray)

Add all elements of an existing array.

local addObjectsFromArray ( local  otherArray)

Add all elements of an existing array.

unsigned int capacity ( ) const

Returns capacity of the array.

local capacity ( )

Returns capacity of the array.

bool containsObject ( CCObject object) const

Returns a Boolean value that indicates whether object is present in array.

local containsObject ( local  object)

Returns a Boolean value that indicates whether object is present in array.

virtual CCObject* copyWithZone ( CCZone pZone)
virtual

override functions

Reimplemented from CCCopying.

unsigned int count ( ) const

Returns element count of the array.

local count ( )

Returns element count of the array.

static CCArray* create ( )
static

Create an array.

local create ( )
static

Create an array.

static CCArray* create ( CCObject pObject,
  ... 
)
static

Create an array with some objects.

static CCArray* createWithArray ( CCArray otherArray)
static

Create an array with an existing array.

local createWithArray ( local  otherArray)
static

Create an array with an existing array.

static CCArray* createWithCapacity ( unsigned int  capacity)
static

Create an array with capacity.

local createWithCapacity ( local  capacity)
static

Create an array with capacity.

static CCArray*
createWithContentsOfFile
( const char *  pFileName)
static

Generate a CCArray pointer by file.

Parameters
pFileNameThe file name of *.plist file
Returns
The CCArray pointer generated from the file
local createWithContentsOfFile ( local  pFileName)
static

Generate a CCArray pointer by file.

Parameters
pFileNameThe file name of *.plist file
Returns
The CCArray pointer generated from the file
static CCArray*
createWithContentsOfFileThreadSafe
( const char *  pFileName)
static
local
createWithContentsOfFileThreadSafe
( local  pFileName)
static
static CCArray* createWithObject ( CCObject pObject)
static

Create an array with one object.

local createWithObject ( local  pObject)
static

Create an array with one object.

void exchangeObject ( CCObject object1,
CCObject object2 
)

Swap two elements.

local exchangeObject ( local  object1,
local  object2 
)

Swap two elements.

void exchangeObjectAtIndex ( unsigned int  index1,
unsigned int  index2 
)

Swap two elements with certain indexes.

local exchangeObjectAtIndex ( local  index1,
local  index2 
)

Swap two elements with certain indexes.

void fastRemoveObject ( CCObject object)

Fast way to remove a certain object.

local fastRemoveObject ( local  object)

Fast way to remove a certain object.

void fastRemoveObjectAtIndex ( unsigned int  index)

Fast way to remove an element with a certain index.

local fastRemoveObjectAtIndex ( local  index)

Fast way to remove an element with a certain index.

unsigned int indexOfObject ( CCObject object) const

Returns index of a certain object, return UINT_MAX if doesn't contain the object.

local indexOfObject ( local  object)

Returns index of a certain object, return UINT_MAX if doesn't contain the object.

bool init ( )

Initializes an array.

bool initWithArray ( CCArray otherArray)

Initializes an array with an existing array.

bool initWithCapacity ( unsigned int  capacity)

Initializes an array with capacity.

bool initWithObject ( CCObject pObject)

Initializes an array with one object.

bool initWithObjects ( CCObject pObject,
  ... 
)

Initializes an array with some objects.

void insertObject ( CCObject object,
unsigned int  index 
)

Insert a certain object at a certain index.

local insertObject ( local  object,
local  index 
)

Insert a certain object at a certain index.

bool isEqualToArray ( CCArray pOtherArray)
Since
1.1
local isEqualToArray ( local  pOtherArray)
Since
1.1
CCObject* lastObject ( )

Returns last element.

local lastObject ( )

Returns last element.

CCObject* objectAtIndex ( unsigned int  index)

Returns an element with a certain index.

local objectAtIndex ( local  index)

Returns an element with a certain index.

CCObject* randomObject ( )

Returns a random element.

local randomObject ( )

Returns a random element.

void reduceMemoryFootprint ( )
local reduceMemoryFootprint ( )
void removeAllObjects ( )

Remove all objects.

local removeAllObjects ( )

Remove all objects.

void removeLastObject ( bool  bReleaseObj = true)

Remove last object.

local removeLastObject ( local  bReleaseObj = true)

Remove last object.

void removeObject ( CCObject object,
bool  bReleaseObj = true 
)

Remove a certain object.

local removeObject ( local  object,
local  bReleaseObj = true 
)

Remove a certain object.

void removeObjectAtIndex ( unsigned int  index,
bool  bReleaseObj = true 
)

Remove an element with a certain index.

local removeObjectAtIndex ( local  index,
local  bReleaseObj = true 
)

Remove an element with a certain index.

void removeObjectsInArray ( CCArray otherArray)

Remove all elements.

local removeObjectsInArray ( local  otherArray)

Remove all elements.

void replaceObjectAtIndex ( unsigned int  uIndex,
CCObject pObject,
bool  bReleaseObject = true 
)

Replace object at index with another object.

local replaceObjectAtIndex ( local  uIndex,
local  pObject,
local  bReleaseObject = true 
)

Replace object at index with another object.

void reverseObjects ( )

Revers the array.

local reverseObjects ( )

Revers the array.

Member Data Documentation

ccArray* data
local data

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