Cocos2d-x  v3.17
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Groups Pages
PointArray Class Reference

An Array that contain control points. More...

Inherits Ref, and Clonable.

Public Member Functions

bool initWithCapacity (ssize_t 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 (const Vec2 &controlPoint)
 Appends a control point. More...
 
local addControlPoint ( local controlPoint)
 Appends a control point. More...
 
void insertControlPoint (const Vec2 &controlPoint, ssize_t index)
 Inserts a controlPoint at index. More...
 
local insertControlPoint ( local controlPoint, local index)
 Inserts a controlPoint at index. More...
 
void replaceControlPoint (const Vec2 &controlPoint, ssize_t index)
 Replaces an existing controlPoint at index. More...
 
local replaceControlPoint ( local controlPoint, local index)
 Replaces an existing controlPoint at index. More...
 
const Vec2getControlPointAtIndex (ssize_t index) const
 Get the value of a controlPoint at a given index. More...
 
void removeControlPointAtIndex (ssize_t index)
 Deletes a control point at a given index. More...
 
ssize_t 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.
 
virtual PointArrayclone () const
 Returns a copy of the Ref. More...
 
- Public Member Functions inherited from Ref
void retain ()
 Retains the ownership. More...
 
void release ()
 Releases the ownership immediately. More...
 
local release ()
 Releases the ownership immediately. More...
 
Refautorelease ()
 Releases the ownership sometime soon automatically. More...
 
unsigned int getReferenceCount () const
 Returns the Ref's current reference count. More...
 
local getReferenceCount ()
 Returns the Ref's current reference count. More...
 
virtual ~Ref ()
 Destructor. More...
 
- Public Member Functions inherited from Clonable
Refcopy () const
 Returns a copy of the Ref. More...
 

Static Public Member Functions

static PointArraycreate (ssize_t 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 Ref
unsigned int _ID
 object id, ScriptSupport need public _ID
 
local _ID
 object id, ScriptSupport need public _ID
 
int _luaID
 Lua reference id.
 
local _luaID
 Lua reference id.
 
void * _scriptObject
 scriptObject, support for swift
 
local _scriptObject
 scriptObject, support for swift
 
bool _rooted
 When true, it means that the object was already rooted.
 
local _rooted
 When true, it means that the object was already rooted.
 

Detailed Description

An Array that contain control points.

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

Member Function Documentation

static PointArray* create ( ssize_t  capacity)
static

Creates and initializes a Points array with capacity.

@

local create ( local  capacity)
static

Creates and initializes a Points array with capacity.

@

bool initWithCapacity ( ssize_t  capacity)

Initializes a Catmull Rom config with a capacity hint.

@ @

local initWithCapacity ( local  capacity)

Initializes a Catmull Rom config with a capacity hint.

@ @

void addControlPoint ( const Vec2 controlPoint)

Appends a control point.

@

local addControlPoint ( local  controlPoint)

Appends a control point.

@

void insertControlPoint ( const Vec2 controlPoint,
ssize_t  index 
)

Inserts a controlPoint at index.

@ @

local insertControlPoint ( local  controlPoint,
local  index 
)

Inserts a controlPoint at index.

@ @

void replaceControlPoint ( const Vec2 controlPoint,
ssize_t  index 
)

Replaces an existing controlPoint at index.

@ @

local replaceControlPoint ( local  controlPoint,
local  index 
)

Replaces an existing controlPoint at index.

@ @

const Vec2& getControlPointAtIndex ( ssize_t  index) const

Get the value of a controlPoint at a given index.

@ @

local getControlPointAtIndex ( local  index)

Get the value of a controlPoint at a given index.

@ @

void removeControlPointAtIndex ( ssize_t  index)

Deletes a control point at a given index.

@

local removeControlPointAtIndex ( local  index)

Deletes a control point at a given index.

@

ssize_t count ( ) const

Returns the number of objects of the control point array.

@

local count ( )

Returns the number of objects of the control point array.

@

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.

@

virtual PointArray* clone ( ) const
virtual

Returns a copy of the Ref.

Implements Clonable.


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