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

An Array that contain control points. More...

#include <CCActionCatmullRom.h>

Inheritance diagram for PointArray:
Object Clonable

Public Member Functions

virtual ~PointArray ()
 PointArray ()
bool initWithCapacity (unsigned int capacity)
 initializes a Catmull Rom config with a capacity hint More...
 
local initWithCapacity ( local capacity)
 initializes a Catmull Rom config with a capacity hint More...
 
void addControlPoint (Point controlPoint)
 appends a control point More...
 
void insertControlPoint (Point &controlPoint, unsigned int index)
 inserts a controlPoint at index More...
 
void replaceControlPoint (Point &controlPoint, unsigned int index)
 replaces an existing controlPoint at index More...
 
Point getControlPointAtIndex (unsigned int index)
 get the value of a controlPoint at a given index More...
 
void removeControlPointAtIndex (unsigned int index)
 deletes a control point at a given index More...
 
unsigned int count () const
 returns the number of objects of the control point array More...
 
local count ()
 returns the number of objects of the control point array More...
 
PointArrayreverse () const
 returns a new copy of the array reversed. More...
 
local reverse ()
 returns a new copy of the array reversed. More...
 
void reverseInline ()
 reverse the current control point array inline, without generating a new one More...
 
virtual PointArrayclone () const
 returns a copy of the object More...
 
const std::vector< Point * > * getControlPoints () const
local getControlPoints ()
void setControlPoints (std::vector< Point * > *controlPoints)
- Public Member Functions inherited from Object
 Object ()
 Constructor. More...
 
virtual ~Object ()
void release ()
 Release the ownership immediately. More...
 
void retain ()
 Retains the ownership. More...
 
Objectautorelease ()
 Release the ownership sometime soon automatically. More...
 
bool isSingleReference () const
 Returns a boolean value that indicates whether there is only one reference to the object. More...
 
unsigned int retainCount () const
 Returns the object's current reference count. More...
 
virtual bool isEqual (const Object *object)
 Returns a boolean value that indicates whether this object and a given object are equal. More...
 
virtual void acceptVisitor (DataVisitor &visitor)
virtual void update (float dt)
- Public Member Functions inherited from Clonable
virtual ~Clonable ()
CC_DEPRECATED_ATTRIBUTE Objectcopy () const
 returns a copy of the object. More...
 
local copy ()
 returns a copy of the object. More...
 

Static Public Member Functions

static PointArraycreate (unsigned int capacity)
 creates and initializes a Points array with capacity More...
 
local create ( local capacity)
 creates and initializes a Points array with capacity More...
 

Additional Inherited Members

- Public Attributes inherited from Object
unsigned int _ID
 object id, ScriptSupport need public _ID More...
 
int _luaID
 Lua reference id. More...
 
- Protected Attributes inherited from Object
unsigned int _reference
 count of references More...
 
var _reference
 count of references More...
 
local _reference
 count of references More...
 
unsigned int _autoReleaseCount
 count of autorelease More...
 
var _autoReleaseCount
 count of autorelease More...
 
local _autoReleaseCount
 count of autorelease More...
 

Detailed Description

An Array that contain control points.

Used by CardinalSplineTo and (By) and CatmullRomTo (and By) actions.

Constructor & Destructor Documentation

virtual ~PointArray ( )
virtual

Member Function Documentation

void addControlPoint ( Point  controlPoint)

appends a control point

local addControlPoint ( local  controlPoint)

appends a control point

virtual PointArray* clone ( ) const
virtual

returns a copy of the object

Implements Clonable.

unsigned int count ( ) const

returns the number of objects of the control point array

local count ( )

returns the number of objects of the control point array

static PointArray* create ( unsigned int  capacity)
static

creates and initializes a Points array with capacity

local create ( local  capacity)
static

creates and initializes a Points array with capacity

Point getControlPointAtIndex ( unsigned int  index)

get the value of a controlPoint at a given index

local getControlPointAtIndex ( local  index)

get the value of a controlPoint at a given index

const std::vector<Point*>
* getControlPoints
( ) const
local getControlPoints ( )
bool initWithCapacity ( unsigned int  capacity)

initializes a Catmull Rom config with a capacity hint

local initWithCapacity ( local  capacity)

initializes a Catmull Rom config with a capacity hint

void insertControlPoint ( Point controlPoint,
unsigned int  index 
)

inserts a controlPoint at index

local insertControlPoint ( local  controlPoint,
local  index 
)

inserts a controlPoint at index

void removeControlPointAtIndex ( unsigned int  index)

deletes a control point at a given index

local removeControlPointAtIndex ( local  index)

deletes a control point at a given index

void replaceControlPoint ( Point controlPoint,
unsigned int  index 
)

replaces an existing controlPoint at index

local replaceControlPoint ( local  controlPoint,
local  index 
)

replaces an existing controlPoint at index

PointArray* reverse ( ) const

returns a new copy of the array reversed.

User is responsible for releasing this copy

local reverse ( )

returns a new copy of the array reversed.

User is responsible for releasing this copy

void reverseInline ( )

reverse the current control point array inline, without generating a new one

local reverseInline ( )

reverse the current control point array inline, without generating a new one

void setControlPoints ( std::vector< Point * > *  controlPoints)
local setControlPoints ( local  controlPoints)

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