Files
file	CCVertex.h

Namespaces
namespace	cocos2d

Classes
class	CCArray

class	CCBool

class	CCDictElement
	CCDictElement is used for traversing CCDictionary. More...

class	CCDictionary
	CCDictionary is a class like NSDictionary in Obj-C . More...

class	CCDouble

class	CCFloat

class	CCPoint

class	CCSize

class	CCRect

class	CCInteger

class	CCSet

class	CCString

struct	CCStringCompare

class	CCZone

Macros
#define	CCARRAY_FOREACH(__array__, __object__)
	A convenience macro to iterate over a CCArray using.

#define	CCARRAY_FOREACH_REVERSE(__array__, __object__)

#define	CCARRAY_VERIFY_TYPE(__array__, __type__) void(0)

#define	arrayMakeObjectsPerformSelector(pArray, func, elementType)

#define	arrayMakeObjectsPerformSelectorWithObject(pArray, func, pObject, elementType)

#define	CCDICT_FOREACH(__dict__, __el__)
	The macro for traversing dictionary.

#define	CCPointMake(x, y) CCPoint((float)(x), (float)(y))

#define	CCSizeMake(width, height) CCSize((float)(width), (float)(height))

#define	CCRectMake(x, y, width, height) CCRect((float)(x), (float)(y), (float)(width), (float)(height))

#define	CCStringMake(str) CCString::create(str)

#define	ccs CCStringMake

#define	ccp(__X__, __Y__) cocos2d::CCPointMake((float)(__X__), (float)(__Y__))
	Helper macro that creates a CCPoint.

Typedefs
typedef std::set< CCObject * > ::iterator	CCSetIterator

Functions
CCRect CC_DLL	CCRectFromString (const char *pszContent)
	Returns a Core Graphics rectangle structure corresponding to the data in a given string.

CCPoint CC_DLL	CCPointFromString (const char *pszContent)
	Returns a Core Graphics point structure corresponding to the data in a given string.

CCSize CC_DLL	CCSizeFromString (const char *pszContent)
	Returns a Core Graphics size structure corresponding to the data in a given string.

float CC_DLL	ccpLength (const CCPoint &v)
	Calculates distance between point an origin.

float CC_DLL	ccpDistance (const CCPoint &v1, const CCPoint &v2)
	Calculates the distance between two points.

CCPoint CC_DLL	ccpNormalize (const CCPoint &v)
	Returns point multiplied to a length of 1.

CCPoint CC_DLL	ccpForAngle (const float a)
	Converts radians to a normalized vector.

float CC_DLL	ccpToAngle (const CCPoint &v)
	Converts a vector to radians.

float CC_DLL	clampf (float value, float min_inclusive, float max_inclusive)
	Clamp a value between from and to.

CCPoint CC_DLL	ccpClamp (const CCPoint &p, const CCPoint &from, const CCPoint &to)
	Clamp a point between from and to.

CCPoint CC_DLL	ccpFromSize (const CCSize &s)
	Quickly convert CCSize to a CCPoint.

CCPoint CC_DLL	ccpCompOp (const CCPoint &p, float(*opFunc)(float))
	Run a math operation function on each point component absf, fllorf, ceilf, roundf any function that has the signature: float func(float); For example: let's try to take the floor of x,y ccpCompOp(p,floorf);.

CCPoint CC_DLL	ccpLerp (const CCPoint &a, const CCPoint &b, float alpha)
	Linear Interpolation between two points a and b.

bool CC_DLL	ccpFuzzyEqual (const CCPoint &a, const CCPoint &b, float variance)

CCPoint CC_DLL	ccpCompMult (const CCPoint &a, const CCPoint &b)
	Multiplies a and b components, a.xb.x, a.yb.y.

float CC_DLL	ccpAngleSigned (const CCPoint &a, const CCPoint &b)

float CC_DLL	ccpAngle (const CCPoint &a, const CCPoint &b)

CCPoint CC_DLL	ccpRotateByAngle (const CCPoint &v, const CCPoint &pivot, float angle)
	Rotates a point counter clockwise by the angle around a pivot.

bool CC_DLL	ccpLineIntersect (const CCPoint &p1, const CCPoint &p2, const CCPoint &p3, const CCPoint &p4, float s, float t)
	A general line-line intersection test.

bool CC_DLL	ccpSegmentIntersect (const CCPoint &A, const CCPoint &B, const CCPoint &C, const CCPoint &D)

CCPoint CC_DLL	ccpIntersectPoint (const CCPoint &A, const CCPoint &B, const CCPoint &C, const CCPoint &D)

void CC_DLL	ccVertexLineToPolygon (CCPoint points, float stroke, ccVertex2F vertices, unsigned int offset, unsigned int nuPoints)
	converts a line to a polygon

bool CC_DLL	ccVertexLineIntersect (float Ax, float Ay, float Bx, float By, float Cx, float Cy, float Dx, float Dy, float *T)
	returns whether or not the line intersects

Variables
const CCPoint	CCPointZero = CCPoint((float)( 0 ), (float)( 0 ))

const CCSize	CCSizeZero = CCSize((float)( 0 ), (float)( 0 ))

const CCRect	CCRectZero = CCRect((float)( 0 ), (float)( 0 ), (float)( 0 ), (float)( 0 ))

Detailed Description

Macro Definition Documentation

#define arrayMakeObjectsPerformSelector	(	pArray,
		func,
		elementType
	)

Value:

do {                                                                  \
    if(pArray && pArray->count() > 0)                                 \
    {                                                                 \
        CCObject* child;                                              \
        CCARRAY_FOREACH(pArray, child)                                \
        {                                                             \
            elementType pNode = (elementType) child;                  \
            if(pNode)                                                 \
            {                                                         \
                pNode->func();                                        \
            }                                                         \
        }                                                             \
    }                                                                 \
}                                                                     \
while(false)

#define arrayMakeObjectsPerformSelectorWithObject	(	pArray,
		func,
		pObject,
		elementType
	)

Value:

do {                                                                  \
    if(pArray && pArray->count() > 0)                                 \
    {                                                                 \
        CCObject* child = NULL;                                       \
        CCARRAY_FOREACH(pArray, child)                                \
        {                                                             \
            elementType pNode = (elementType) child;                  \
            if(pNode)                                                 \
            {                                                         \
                pNode->func(pObject);                                 \
            }                                                         \
        }                                                             \
    }                                                                 \
}                                                                     \
while(false)

#define CCARRAY_FOREACH	(	__array__,
		__object__
	)

Value:

if ((__array__) && (__array__)->data->num > 0)                                                                     \
    for(CCObject** __arr__ = (__array__)->data->arr, **__end__ = (__array__)->data->arr + (__array__)->data->num-1;    \
    __arr__ <= __end__ && (((__object__) = *__arr__) != NULL/* || true*/);                                             \
    __arr__++)

A convenience macro to iterate over a CCArray using.

It is faster than the "fast enumeration" interface.

Since: v0.99.4

#define CCARRAY_FOREACH_REVERSE	(	__array__,
		__object__
	)

Value:

if ((__array__) && (__array__)->data->num > 0)                                                                      \
    for(CCObject** __arr__ = (__array__)->data->arr + (__array__)->data->num-1, **__end__ = (__array__)->data->arr;     \
    __arr__ >= __end__ && (((__object__) = *__arr__) != NULL/* || true*/);                                              \
    __arr__--)

#define CCARRAY_VERIFY_TYPE	(	__array__,
		__type__
	)	void(0)

#define CCDICT_FOREACH	(	__dict__,
		__el__
	)

Value:

CCDictElement* pTmp##__dict__##__el__ = NULL; \

HASH_ITER(hh, (__dict__)->m_pElements, __el__, pTmp##__dict__##__el__)

The macro for traversing dictionary.

Note: It's faster than getting all keys and traversing keys to get objects by objectForKey. It's also safe to remove elements while traversing.

#define ccp	(	__X__,
		__Y__
	)	cocos2d::CCPointMake((float)(__X__), (float)(__Y__))

Helper macro that creates a CCPoint.

Returns: CCPoint

Since: v0.7.2

#define CCPointMake	(	x,
		y
	)	CCPoint((float)(x), (float)(y))

#define CCRectMake	(	x,
		y,
		width,
		height
	)	CCRect((float)(x), (float)(y), (float)(width), (float)(height))

#define ccs CCStringMake

#define CCSizeMake	(	width,
		height
	)	CCSize((float)(width), (float)(height))

#define CCStringMake ( str ) CCString::create(str)

Typedef Documentation

typedef std::set<CCObject *>::iterator CCSetIterator

Function Documentation

float CC_DLL cocos2d::ccpAngle	(	const CCPoint &	a,
		const CCPoint &	b
	)

Returns: the angle in radians between two vector directions

Since: v0.99.1

float CC_DLL cocos2d::ccpAngleSigned	(	const CCPoint &	a,
		const CCPoint &	b
	)

Returns: the signed angle in radians between two vector directions

Since: v0.99.1

CCPoint CC_DLL cocos2d::ccpClamp	(	const CCPoint &	p,
		const CCPoint &	from,
		const CCPoint &	to
	)

Clamp a point between from and to.

Since: v0.99.1

CCPoint CC_DLL cocos2d::ccpCompMult	(	const CCPoint &	a,
		const CCPoint &	b
	)

Multiplies a and b components, a.x*b.x, a.y*b.y.

Returns: a component-wise multiplication

Since: v0.99.1

CCPoint CC_DLL cocos2d::ccpCompOp	(	const CCPoint &	p,
		float(*)(float)	opFunc
	)

Run a math operation function on each point component absf, fllorf, ceilf, roundf any function that has the signature: float func(float); For example: let's try to take the floor of x,y ccpCompOp(p,floorf);.

Since: v0.99.1

float CC_DLL cocos2d::ccpDistance	(	const CCPoint &	v1,
		const CCPoint &	v2
	)

Calculates the distance between two points.

Returns: float

Since: v0.7.2

CCPoint CC_DLL cocos2d::ccpForAngle ( const float a )

Converts radians to a normalized vector.

Returns: CCPoint

Since: v0.7.2

CCPoint CC_DLL cocos2d::ccpFromSize ( const CCSize & s )

Quickly convert CCSize to a CCPoint.

Since: v0.99.1

bool CC_DLL cocos2d::ccpFuzzyEqual	(	const CCPoint &	a,
		const CCPoint &	b,
		float	variance
	)

Returns: if points have fuzzy equality which means equal with some degree of variance.

Since: v0.99.1

CCPoint CC_DLL cocos2d::ccpIntersectPoint	(	const CCPoint &	A,
		const CCPoint &	B,
		const CCPoint &	C,
		const CCPoint &	D
	)

float CC_DLL cocos2d::ccpLength ( const CCPoint & v )

Calculates distance between point an origin.

Returns: float

Since: v0.7.2

CCPoint CC_DLL cocos2d::ccpLerp	(	const CCPoint &	a,
		const CCPoint &	b,
		float	alpha
	)

Linear Interpolation between two points a and b.

Returns: alpha == 0 ? a alpha == 1 ? b otherwise a value between a..b

Since: v0.99.1

bool CC_DLL cocos2d::ccpLineIntersect	(	const CCPoint &	p1,
		const CCPoint &	p2,
		const CCPoint &	p3,
		const CCPoint &	p4,
		float *	s,
		float *	t
	)

A general line-line intersection test.

Parameters

p1	is the startpoint for the first line P1 = (p1 - p2)
p2	is the endpoint for the first line P1 = (p1 - p2)
p3	is the startpoint for the second line P2 = (p3 - p4)
p4	is the endpoint for the second line P2 = (p3 - p4)
s	is the range for a hitpoint in P1 (pa = p1 + s*(p2 - p1))
t	is the range for a hitpoint in P3 (pa = p2 + t*(p4 - p3))

Returns: bool indicating successful intersection of a line note that to truly test intersection for segments we have to make sure that s & t lie within [0..1] and for rays, make sure s & t > 0 the hit point is p3 + t * (p4 - p3); the hit point also is p1 + s * (p2 - p1);

Since: v0.99.1

CCPoint CC_DLL cocos2d::ccpNormalize ( const CCPoint & v )

Returns point multiplied to a length of 1.

Returns: CCPoint

Since: v0.7.2

CCPoint CC_DLL cocos2d::CCPointFromString ( const char * pszContent )

Returns a Core Graphics point structure corresponding to the data in a given string.

Parameters

pszContent A string object whose contents are of the form "{x,y}", where x is the x coordinate and y is the y coordinate. The x and y values can represent integer or float values. An example of a valid string is "{3.0,2.5}". The string is not localized, so items are always separated with a comma.

Returns: A Core Graphics structure that represents a point. If the string is not well-formed, the function returns CCPointZero.

CCPoint CC_DLL cocos2d::ccpRotateByAngle	(	const CCPoint &	v,
		const CCPoint &	pivot,
		float	angle
	)

Rotates a point counter clockwise by the angle around a pivot.

Parameters

v	is the point to rotate
pivot	is the pivot, naturally
angle	is the angle of rotation cw in radians

Returns: the rotated point

Since: v0.99.1

bool CC_DLL cocos2d::ccpSegmentIntersect	(	const CCPoint &	A,
		const CCPoint &	B,
		const CCPoint &	C,
		const CCPoint &	D
	)

float CC_DLL cocos2d::ccpToAngle ( const CCPoint & v )

Converts a vector to radians.

Returns: float

Since: v0.7.2

CCRect CC_DLL cocos2d::CCRectFromString ( const char * pszContent )

Returns a Core Graphics rectangle structure corresponding to the data in a given string.

Parameters

pszContent A string object whose contents are of the form "{{x,y},{w, h}}", where x is the x coordinate, y is the y coordinate, w is the width, and h is the height. These components can represent integer or float values. An example of a valid string is "{{3,2},{4,5}}". The string is not localized, so items are always separated with a comma.

Returns: A Core Graphics structure that represents a rectangle. If the string is not well-formed, the function returns CCRectZero.

CCSize CC_DLL cocos2d::CCSizeFromString ( const char * pszContent )

Returns a Core Graphics size structure corresponding to the data in a given string.

Parameters

pszContent A string object whose contents are of the form "{w, h}", where w is the width and h is the height. The w and h values can be integer or float values. An example of a valid string is "{3.0,2.5}". The string is not localized, so items are always separated with a comma.

Returns: A Core Graphics structure that represents a size. If the string is not well-formed, the function returns CCSizeZero.

bool CC_DLL cocos2d::ccVertexLineIntersect	(	float	Ax,
		float	Ay,
		float	Bx,
		float	By,
		float	Cx,
		float	Cy,
		float	Dx,
		float	Dy,
		float *	T
	)

returns whether or not the line intersects

void CC_DLL cocos2d::ccVertexLineToPolygon	(	CCPoint *	points,
		float	stroke,
		ccVertex2F *	vertices,
		unsigned int	offset,
		unsigned int	nuPoints
	)

converts a line to a polygon

float CC_DLL cocos2d::clampf	(	float	value,
		float	min_inclusive,
		float	max_inclusive
	)

Clamp a value between from and to.

Since: v0.99.1

Variable Documentation

const CCPoint CCPointZero = CCPoint((float)( 0 ), (float)( 0 ))

const CCRect CCRectZero = CCRect((float)( 0 ), (float)( 0 ), (float)( 0 ), (float)( 0 ))

const CCSize CCSizeZero = CCSize((float)( 0 ), (float)( 0 ))

Stable Releases

Follow us

Visitors

Friends

Files

Namespaces

Classes

Macros

Typedefs

Functions

Variables

Detailed Description

Macro Definition Documentation

Typedef Documentation

Function Documentation

Variable Documentation