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

A 9-slice sprite for cocos2d. More...

#include <CCScale9Sprite.h>

Inheritance diagram for CCScale9Sprite:
CCNodeRGBA CCNode CCRGBAProtocol CCObject CCCopying

Public Member Functions

 CCScale9Sprite ()
virtual ~CCScale9Sprite ()
var ~CCScale9Sprite ()
local ~CCScale9Sprite ()
virtual CCSize getOriginalSize (void)
 getOriginalSize More...
 
var getOriginalSize ()
 getOriginalSize More...
 
local getOriginalSize ()
 getOriginalSize More...
 
virtual CCSize getPreferredSize (void)
 getPreferredSize More...
 
local getPreferredSize ()
 getPreferredSize More...
 
virtual void setPreferredSize (CCSize var)
 setPreferredSize More...
 
virtual CCRect getCapInsets (void)
 getCapInsets More...
 
var getCapInsets ()
 getCapInsets More...
 
local getCapInsets ()
 getCapInsets More...
 
virtual void setCapInsets (CCRect var)
 setCapInsets More...
 
var setCapInsets ( var var)
 setCapInsets More...
 
local setCapInsets ( local var)
 setCapInsets More...
 
virtual float getInsetLeft (void)
 getInsetLeft More...
 
var getInsetLeft ()
 getInsetLeft More...
 
local getInsetLeft ()
 getInsetLeft More...
 
virtual void setInsetLeft (float var)
 setInsetLeft More...
 
var setInsetLeft ( var var)
 setInsetLeft More...
 
local setInsetLeft ( local var)
 setInsetLeft More...
 
virtual float getInsetTop (void)
 getInsetTop More...
 
var getInsetTop ()
 getInsetTop More...
 
local getInsetTop ()
 getInsetTop More...
 
virtual void setInsetTop (float var)
 setInsetTop More...
 
var setInsetTop ( var var)
 setInsetTop More...
 
local setInsetTop ( local var)
 setInsetTop More...
 
virtual float getInsetRight (void)
 getInsetRight More...
 
local getInsetRight ()
 getInsetRight More...
 
virtual void setInsetRight (float var)
 setInsetRight More...
 
var setInsetRight ( var var)
 setInsetRight More...
 
local setInsetRight ( local var)
 setInsetRight More...
 
virtual float getInsetBottom (void)
 getInsetBottom More...
 
var getInsetBottom ()
 getInsetBottom More...
 
local getInsetBottom ()
 getInsetBottom More...
 
virtual void setInsetBottom (float var)
 setInsetBottom More...
 
var setInsetBottom ( var var)
 setInsetBottom More...
 
local setInsetBottom ( local var)
 setInsetBottom More...
 
virtual void setContentSize (const CCSize &size)
 Sets the untransformed size of the node. More...
 
local setContentSize ( local size)
 Sets the untransformed size of the node. More...
 
virtual void visit ()
 Visits this node's children and draw them recursively. More...
 
virtual bool init ()
 Initializes the instance of CCNode. More...
 
virtual bool initWithBatchNode (CCSpriteBatchNode *batchnode, CCRect rect, bool rotated, CCRect capInsets)
virtual bool initWithBatchNode (CCSpriteBatchNode *batchnode, CCRect rect, CCRect capInsets)
var initWithBatchNode ( var batchnode, var rect, var capInsets)
local initWithBatchNode ( local batchnode, local rect, local capInsets)
virtual bool initWithFile (const char *file, CCRect rect, CCRect capInsets)
 Initializes a 9-slice sprite with a texture file, a delimitation zone and with the specified cap insets. More...
 
var initWithFile ( var file, var rect, var capInsets)
 Initializes a 9-slice sprite with a texture file, a delimitation zone and with the specified cap insets. More...
 
local initWithFile ( local file, local rect, local capInsets)
 Initializes a 9-slice sprite with a texture file, a delimitation zone and with the specified cap insets. More...
 
virtual bool initWithFile (const char *file, CCRect rect)
 Initializes a 9-slice sprite with a texture file and a delimitation zone. More...
 
virtual bool initWithFile (CCRect capInsets, const char *file)
 Initializes a 9-slice sprite with a texture file and with the specified cap insets. More...
 
var initWithFile ( var capInsets, var file)
 Initializes a 9-slice sprite with a texture file and with the specified cap insets. More...
 
local initWithFile ( local capInsets, local file)
 Initializes a 9-slice sprite with a texture file and with the specified cap insets. More...
 
virtual bool initWithFile (const char *file)
 Initializes a 9-slice sprite with a texture file. More...
 
virtual bool initWithSpriteFrame (CCSpriteFrame *spriteFrame, CCRect capInsets)
 Initializes a 9-slice sprite with an sprite frame and with the specified cap insets. More...
 
virtual bool initWithSpriteFrame (CCSpriteFrame *spriteFrame)
 Initializes a 9-slice sprite with an sprite frame. More...
 
virtual bool initWithSpriteFrameName (const char *spriteFrameName, CCRect capInsets)
 Initializes a 9-slice sprite with an sprite frame name and with the specified cap insets. More...
 
virtual bool initWithSpriteFrameName (const char *spriteFrameName)
 Initializes a 9-slice sprite with an sprite frame name. More...
 
CCScale9SpriteresizableSpriteWithCapInsets (CCRect capInsets)
 Creates and returns a new sprite object with the specified cap insets. More...
 
virtual void setOpacityModifyRGB (bool bValue)
 sets the premultipliedAlphaOpacity property. More...
 
var setOpacityModifyRGB ( var bValue)
 sets the premultipliedAlphaOpacity property. More...
 
local setOpacityModifyRGB ( local bValue)
 sets the premultipliedAlphaOpacity property. More...
 
virtual bool isOpacityModifyRGB (void)
 returns whether or not the opacity will be applied using glColor(R,G,B,opacity) or glColor(opacity, opacity, opacity, opacity); More...
 
virtual void setOpacity (GLubyte opacity)
 Changes the opacity. More...
 
virtual GLubyte getOpacity ()
 Returns the opacity. More...
 
virtual void setColor (const ccColor3B &color)
 @ More...
 
var setColor ( var color)
 @ More...
 
local setColor ( local color)
 @ More...
 
virtual const ccColor3BgetColor ()
 Returns color that is currently used. More...
 
local getColor ()
 Returns color that is currently used. More...
 
virtual bool updateWithBatchNode (CCSpriteBatchNode *batchnode, CCRect rect, bool rotated, CCRect capInsets)
virtual void setSpriteFrame (CCSpriteFrame *spriteFrame)
local setSpriteFrame ( local spriteFrame)
virtual void updateDisplayedOpacity (GLubyte parentOpacity)
 recursive method that updates the displayed opacity. More...
 
virtual void updateDisplayedColor (const cocos2d::ccColor3B &parentColor)
var updateDisplayedColor ( var parentColor)
local updateDisplayedColor ( local parentColor)
- Public Member Functions inherited from CCNodeRGBA
 CCNodeRGBA ()
virtual ~CCNodeRGBA ()
virtual GLubyte getDisplayedOpacity ()
 Returns the displayed opacity. More...
 
virtual bool isCascadeOpacityEnabled ()
 whether or not opacity should be propagated to its children. More...
 
virtual void setCascadeOpacityEnabled (bool cascadeOpacityEnabled)
virtual const ccColor3BgetDisplayedColor ()
 Returns the displayed color. More...
 
virtual void updateDisplayedColor (const ccColor3B &parentColor)
 recursive method that updates display color More...
 
virtual bool isCascadeColorEnabled ()
 whether or not color should be propagated to its children. More...
 
virtual void setCascadeColorEnabled (bool cascadeColorEnabled)
- Public Member Functions inherited from CCNode
virtual CCCameragetCamera ()
 Returns a camera object that lets you move the node using a gluLookAt. More...
 
local getCamera ()
 Returns a camera object that lets you move the node using a gluLookAt. More...
 
virtual bool isRunning ()
 Returns whether or not the node accepts event callbacks. More...
 
local isRunning ()
 Returns whether or not the node accepts event callbacks. More...
 
virtual void cleanup (void)
 Stops all running actions and schedulers. More...
 
virtual void draw (void)
 Override this method to draw your own node. More...
 
local draw ()
 Override this method to draw your own node. More...
 
CCRect boundingBox (void)
 Returns a "local" axis aligned bounding box of the node. More...
 
local boundingBox ()
 Returns a "local" axis aligned bounding box of the node. More...
 
virtual void setZOrder (int zOrder)
 Sets the Z order which stands for the drawing order, and reorder this node in its parent's children array. More...
 
virtual void _setZOrder (int z)
 Sets the z order which stands for the drawing order. More...
 
local _setZOrder ( local z)
 Sets the z order which stands for the drawing order. More...
 
virtual int getZOrder ()
 Gets the Z order of this node. More...
 
local getZOrder ()
 Gets the Z order of this node. More...
 
virtual void setVertexZ (float vertexZ)
 Sets the real OpenGL Z vertex. More...
 
local setVertexZ ( local vertexZ)
 Sets the real OpenGL Z vertex. More...
 
virtual float getVertexZ ()
 Gets OpenGL Z vertex of this node. More...
 
local getVertexZ ()
 Gets OpenGL Z vertex of this node. More...
 
virtual void setScaleX (float fScaleX)
 Changes the scale factor on X axis of this node. More...
 
local setScaleX ( local fScaleX)
 Changes the scale factor on X axis of this node. More...
 
virtual float getScaleX ()
 Returns the scale factor on X axis of this node. More...
 
local getScaleX ()
 Returns the scale factor on X axis of this node. More...
 
virtual void setScaleY (float fScaleY)
 Changes the scale factor on Y axis of this node. More...
 
local setScaleY ( local fScaleY)
 Changes the scale factor on Y axis of this node. More...
 
virtual float getScaleY ()
 Returns the scale factor on Y axis of this node. More...
 
virtual void setScale (float scale)
 Changes both X and Y scale factor of the node. More...
 
local setScale ( local scale)
 Changes both X and Y scale factor of the node. More...
 
virtual float getScale ()
 Gets the scale factor of the node, when X and Y have the same scale factor. More...
 
virtual void setScale (float fScaleX, float fScaleY)
 Changes both X and Y scale factor of the node. More...
 
local setScale ( local fScaleX, local fScaleY)
 Changes both X and Y scale factor of the node. More...
 
virtual void setPosition (const CCPoint &position)
 Changes the position (x,y) of the node in OpenGL coordinates. More...
 
virtual const CCPointgetPosition ()
 Gets the position (x,y) of the node in OpenGL coordinates. More...
 
local getPosition ()
 Gets the position (x,y) of the node in OpenGL coordinates. More...
 
virtual void setPosition (float x, float y)
 Sets position in a more efficient way. More...
 
local setPosition ( local x, local y)
 Sets position in a more efficient way. More...
 
virtual void getPosition (float *x, float *y)
 Gets position in a more efficient way, returns two number instead of a CCPoint object. More...
 
local getPosition ( local x, local y)
 Gets position in a more efficient way, returns two number instead of a CCPoint object. More...
 
virtual void setPositionX (float x)
 Gets/Sets x or y coordinate individually for position. More...
 
local setPositionX ( local x)
 Gets/Sets x or y coordinate individually for position. More...
 
virtual float getPositionX (void)
local getPositionX ()
virtual void setPositionY (float y)
virtual float getPositionY (void)
virtual void setSkewX (float fSkewX)
 Changes the X skew angle of the node in degrees. More...
 
local setSkewX ( local fSkewX)
 Changes the X skew angle of the node in degrees. More...
 
virtual float getSkewX ()
 Returns the X skew angle of the node in degrees. More...
 
virtual void setSkewY (float fSkewY)
 Changes the Y skew angle of the node in degrees. More...
 
local setSkewY ( local fSkewY)
 Changes the Y skew angle of the node in degrees. More...
 
virtual float getSkewY ()
 Returns the Y skew angle of the node in degrees. More...
 
virtual void setAnchorPoint (const CCPoint &anchorPoint)
 Sets the anchor point in percent. More...
 
local setAnchorPoint ( local anchorPoint)
 Sets the anchor point in percent. More...
 
virtual const CCPointgetAnchorPoint ()
 Returns the anchor point in percent. More...
 
local getAnchorPoint ()
 Returns the anchor point in percent. More...
 
virtual const CCPointgetAnchorPointInPoints ()
 Returns the anchorPoint in absolute pixels. More...
 
virtual const CCSizegetContentSize () const
 Returns the untransformed size of the node. More...
 
local getContentSize ()
 Returns the untransformed size of the node. More...
 
virtual void setVisible (bool visible)
 Sets whether the node is visible. More...
 
local setVisible ( local visible)
 Sets whether the node is visible. More...
 
virtual bool isVisible ()
 Determines if the node is visible. More...
 
virtual void setRotation (float fRotation)
 Sets the rotation (angle) of the node in degrees. More...
 
local setRotation ( local fRotation)
 Sets the rotation (angle) of the node in degrees. More...
 
virtual float getRotation ()
 Returns the rotation of the node in degrees. More...
 
virtual void setRotationX (float fRotaionX)
 Sets the X rotation (angle) of the node in degrees which performs a horizontal rotational skew. More...
 
local setRotationX ( local fRotaionX)
 Sets the X rotation (angle) of the node in degrees which performs a horizontal rotational skew. More...
 
virtual float getRotationX ()
 Gets the X rotation (angle) of the node in degrees which performs a horizontal rotation skew. More...
 
virtual void setRotationY (float fRotationY)
 Sets the Y rotation (angle) of the node in degrees which performs a vertical rotational skew. More...
 
local setRotationY ( local fRotationY)
 Sets the Y rotation (angle) of the node in degrees which performs a vertical rotational skew. More...
 
virtual float getRotationY ()
 Gets the Y rotation (angle) of the node in degrees which performs a vertical rotational skew. More...
 
virtual void setOrderOfArrival (unsigned int uOrderOfArrival)
 Sets the arrival order when this node has a same ZOrder with other children. More...
 
local setOrderOfArrival ( local uOrderOfArrival)
 Sets the arrival order when this node has a same ZOrder with other children. More...
 
virtual unsigned int getOrderOfArrival ()
 Returns the arrival order, indecates which children is added previously. More...
 
virtual void setGLServerState (ccGLServerState glServerState)
 Sets the state of OpenGL server side. More...
 
local setGLServerState ( local glServerState)
 Sets the state of OpenGL server side. More...
 
virtual ccGLServerState getGLServerState ()
 Returns the state of OpenGL server side. More...
 
local getGLServerState ()
 Returns the state of OpenGL server side. More...
 
virtual void ignoreAnchorPointForPosition (bool ignore)
 Sets whether the anchor point will be (0,0) when you position this node. More...
 
local ignoreAnchorPointForPosition ( local ignore)
 Sets whether the anchor point will be (0,0) when you position this node. More...
 
virtual bool isIgnoreAnchorPointForPosition ()
 Gets whether the anchor point will be (0,0) when you position this node. More...
 
virtual void addChild (CCNode *child)
 Adds a child to the container with z-order as 0. More...
 
virtual void addChild (CCNode *child, int zOrder)
 Adds a child to the container with a z-order. More...
 
local addChild ( local child, local zOrder)
 Adds a child to the container with a z-order. More...
 
virtual void addChild (CCNode *child, int zOrder, int tag)
 Adds a child to the container with z order and tag. More...
 
local addChild ( local child, local zOrder, local tag)
 Adds a child to the container with z order and tag. More...
 
virtual CCNodegetChildByTag (int tag)
 Gets a child from the container with its tag. More...
 
virtual CCArraygetChildren ()
 Return an array of children. More...
 
local getChildren ()
 Return an array of children. More...
 
virtual unsigned int getChildrenCount (void) const
 Get the amount of children. More...
 
local getChildrenCount ()
 Get the amount of children. More...
 
virtual void setParent (CCNode *parent)
 Sets the parent node. More...
 
local setParent ( local parent)
 Sets the parent node. More...
 
virtual CCNodegetParent ()
 Returns a pointer to the parent node. More...
 
virtual void removeFromParent ()
 Removes this node itself from its parent node with a cleanup. More...
 
virtual void removeFromParentAndCleanup (bool cleanup)
 Removes this node itself from its parent node. More...
 
local removeFromParentAndCleanup ( local cleanup)
 Removes this node itself from its parent node. More...
 
virtual void removeChild (CCNode *child)
 Removes a child from the container with a cleanup. More...
 
virtual void removeChild (CCNode *child, bool cleanup)
 Removes a child from the container. More...
 
local removeChild ( local child, local cleanup)
 Removes a child from the container. More...
 
virtual void removeChildByTag (int tag)
 Removes a child from the container by tag value with a cleanup. More...
 
local removeChildByTag ( local tag)
 Removes a child from the container by tag value with a cleanup. More...
 
virtual void removeChildByTag (int tag, bool cleanup)
 Removes a child from the container by tag value. More...
 
local removeChildByTag ( local tag, local cleanup)
 Removes a child from the container by tag value. More...
 
virtual void removeAllChildren ()
 Removes all children from the container with a cleanup. More...
 
virtual void removeAllChildrenWithCleanup (bool cleanup)
 Removes all children from the container, and do a cleanup to all running actions depending on the cleanup parameter. More...
 
virtual void reorderChild (CCNode *child, int zOrder)
 Reorders a child according to a new z value. More...
 
virtual void sortAllChildren ()
 Sorts the children array once before drawing, instead of every time when a child is added or reordered. More...
 
virtual CCGridBasegetGrid ()
 Returns a grid object that is used when applying effects. More...
 
virtual void setGrid (CCGridBase *pGrid)
 Changes a grid object that is used when applying effects. More...
 
local setGrid ( local pGrid)
 Changes a grid object that is used when applying effects. More...
 
virtual int getTag () const
 Returns a tag that is used to identify the node easily. More...
 
local getTag ()
 Returns a tag that is used to identify the node easily. More...
 
virtual void setTag (int nTag)
 Changes the tag that is used to identify the node easily. More...
 
local setTag ( local nTag)
 Changes the tag that is used to identify the node easily. More...
 
virtual void * getUserData ()
 Returns a custom user data pointer. More...
 
virtual void setUserData (void *pUserData)
 Sets a custom user data pointer. More...
 
local setUserData ( local pUserData)
 Sets a custom user data pointer. More...
 
virtual CCObjectgetUserObject ()
 Returns a user assigned CCObject. More...
 
local getUserObject ()
 Returns a user assigned CCObject. More...
 
virtual void setUserObject (CCObject *pUserObject)
 Returns a user assigned CCObject. More...
 
local setUserObject ( local pUserObject)
 Returns a user assigned CCObject. More...
 
virtual CCGLProgramgetShaderProgram ()
 Return the shader program currently used for this node. More...
 
virtual void setShaderProgram (CCGLProgram *pShaderProgram)
 Sets the shader program for this node. More...
 
local setShaderProgram ( local pShaderProgram)
 Sets the shader program for this node. More...
 
virtual void registerScriptHandler (int handler)
 Registers a script function that will be called in onEnter() & onExit() seires functions. More...
 
local registerScriptHandler ( local handler)
 Registers a script function that will be called in onEnter() & onExit() seires functions. More...
 
virtual void unregisterScriptHandler (void)
 Unregisters a script function that will be called in onEnter() & onExit() series functions. More...
 
local unregisterScriptHandler ()
 Unregisters a script function that will be called in onEnter() & onExit() series functions. More...
 
int getScriptHandler ()
 Gets script handler for onEnter/onExit event. More...
 
void scheduleUpdateWithPriorityLua (int nHandler, int priority)
 Schedules for lua script. More...
 
local scheduleUpdateWithPriorityLua ( local nHandler, local priority)
 Schedules for lua script. More...
 
virtual void onEnter ()
 Event callback that is invoked every time when CCNode enters the 'stage'. More...
 
virtual void onEnterTransitionDidFinish ()
 Event callback that is invoked when the CCNode enters in the 'stage'. More...
 
virtual void onExit ()
 Event callback that is invoked every time the CCNode leaves the 'stage'. More...
 
virtual void onExitTransitionDidStart ()
 Event callback that is called every time the CCNode leaves the 'stage'. More...
 
virtual void setActionManager (CCActionManager *actionManager)
 Sets the CCActionManager object that is used by all actions. More...
 
local setActionManager ( local actionManager)
 Sets the CCActionManager object that is used by all actions. More...
 
virtual CCActionManagergetActionManager ()
 Gets the CCActionManager object that is used by all actions. More...
 
local getActionManager ()
 Gets the CCActionManager object that is used by all actions. More...
 
CCActionrunAction (CCAction *action)
 Executes an action, and returns the action that is executed. More...
 
local runAction ( local action)
 Executes an action, and returns the action that is executed. More...
 
void stopAllActions (void)
 Stops and removes all actions from the running action list . More...
 
local stopAllActions ()
 Stops and removes all actions from the running action list . More...
 
void stopAction (CCAction *action)
 Stops and removes an action from the running action list. More...
 
local stopAction ( local action)
 Stops and removes an action from the running action list. More...
 
void stopActionByTag (int tag)
 Removes an action from the running action list by its tag. More...
 
local stopActionByTag ( local tag)
 Removes an action from the running action list by its tag. More...
 
CCActiongetActionByTag (int tag)
 Gets an action from the running action list by its tag. More...
 
local getActionByTag ( local tag)
 Gets an action from the running action list by its tag. More...
 
unsigned int numberOfRunningActions (void)
 Returns the numbers of actions that are running plus the ones that are schedule to run (actions in actionsToAdd and actions arrays). More...
 
local numberOfRunningActions ()
 Returns the numbers of actions that are running plus the ones that are schedule to run (actions in actionsToAdd and actions arrays). More...
 
virtual void setScheduler (CCScheduler *scheduler)
 Sets a CCScheduler object that is used to schedule all "updates" and timers. More...
 
local setScheduler ( local scheduler)
 Sets a CCScheduler object that is used to schedule all "updates" and timers. More...
 
virtual CCSchedulergetScheduler ()
 Gets a CCSheduler object. More...
 
local getScheduler ()
 Gets a CCSheduler object. More...
 
bool isScheduled (SEL_SCHEDULE selector)
 Checks whether a selector is scheduled. More...
 
void scheduleUpdate (void)
 Schedules the "update" method. More...
 
void scheduleUpdateWithPriority (int priority)
 Schedules the "update" method with a custom priority. More...
 
void unscheduleUpdate (void)
void schedule (SEL_SCHEDULE selector, float interval, unsigned int repeat, float delay)
 Schedules a custom selector. More...
 
void schedule (SEL_SCHEDULE selector, float interval)
 Schedules a custom selector with an interval time in seconds. More...
 
void scheduleOnce (SEL_SCHEDULE selector, float delay)
 Schedules a selector that runs only once, with a delay of 0 or larger. More...
 
void schedule (SEL_SCHEDULE selector)
 Schedules a custom selector, the scheduled selector will be ticked every frame. More...
 
void unschedule (SEL_SCHEDULE selector)
 Unschedules a custom selector. More...
 
void unscheduleAllSelectors (void)
 Unschedule all scheduled selectors: custom selectors, and the 'update' selector. More...
 
local unscheduleAllSelectors ()
 Unschedule all scheduled selectors: custom selectors, and the 'update' selector. More...
 
void resumeSchedulerAndActions (void)
 Resumes all scheduled selectors and actions. More...
 
void pauseSchedulerAndActions (void)
 Pauses all scheduled selectors and actions. More...
 
virtual void update (float delta)
void transform (void)
 Performs OpenGL view-matrix transformation based on position, scale, rotation and other attributes. More...
 
void transformAncestors (void)
 Performs OpenGL view-matrix transformation of it's ancestors. More...
 
local transformAncestors ()
 Performs OpenGL view-matrix transformation of it's ancestors. More...
 
virtual void updateTransform (void)
 Calls children's updateTransform() method recursively. More...
 
local updateTransform ()
 Calls children's updateTransform() method recursively. More...
 
virtual CCAffineTransform nodeToParentTransform (void)
 Returns the matrix that transform the node's (local) space coordinates into the parent's space coordinates. More...
 
local nodeToParentTransform ()
 Returns the matrix that transform the node's (local) space coordinates into the parent's space coordinates. More...
 
virtual CCAffineTransform parentToNodeTransform (void)
 Returns the matrix that transform parent's space coordinates to the node's (local) space coordinates. More...
 
local parentToNodeTransform ()
 Returns the matrix that transform parent's space coordinates to the node's (local) space coordinates. More...
 
virtual CCAffineTransform nodeToWorldTransform (void)
 Returns the world affine transform matrix. More...
 
local nodeToWorldTransform ()
 Returns the world affine transform matrix. More...
 
virtual CCAffineTransform worldToNodeTransform (void)
 Returns the inverse world affine transform matrix. More...
 
CCPoint convertToNodeSpace (const CCPoint &worldPoint)
 Converts a Point to node (local) space coordinates. More...
 
local convertToNodeSpace ( local worldPoint)
 Converts a Point to node (local) space coordinates. More...
 
CCPoint convertToWorldSpace (const CCPoint &nodePoint)
 Converts a Point to world space coordinates. More...
 
local convertToWorldSpace ( local nodePoint)
 Converts a Point to world space coordinates. More...
 
CCPoint convertToNodeSpaceAR (const CCPoint &worldPoint)
 Converts a Point to node (local) space coordinates. More...
 
local convertToNodeSpaceAR ( local worldPoint)
 Converts a Point to node (local) space coordinates. More...
 
CCPoint convertToWorldSpaceAR (const CCPoint &nodePoint)
 Converts a local Point to world space coordinates.The result is in Points. More...
 
local convertToWorldSpaceAR ( local nodePoint)
 Converts a local Point to world space coordinates.The result is in Points. More...
 
CCPoint convertTouchToNodeSpace (CCTouch *touch)
 convenience methods which take a CCTouch instead of CCPoint More...
 
CCPoint convertTouchToNodeSpaceAR (CCTouch *touch)
 converts a CCTouch (world coordinates) into a local coordinate. More...
 
local convertTouchToNodeSpaceAR ( local touch)
 converts a CCTouch (world coordinates) into a local coordinate. More...
 
void setAdditionalTransform (const CCAffineTransform &additionalTransform)
 Sets the additional transform. More...
 
local setAdditionalTransform ( local additionalTransform)
 Sets the additional transform. More...
 
CCComponentgetComponent (const char *pName) const
 gets a component by its name More...
 
virtual bool addComponent (CCComponent *pComponent)
 adds a component More...
 
virtual bool removeComponent (const char *pName)
 removes a component by its name More...
 
local removeComponent ( local pName)
 removes a component by its name More...
 
virtual bool removeComponent (CCComponent *pComponent)
 removes a component by its pointer More...
 
virtual void removeAllComponents ()
 removes all components More...
 
local removeAllComponents ()
 removes all components More...
 
 CCNode (void)
 Default constructor. More...
 
 CCNode ()
 Default constructor. More...
 
virtual ~CCNode (void)
 Default destructor. More...
 
const char * description (void)
 Gets the description string. More...
 
local description ()
 Gets the description string. More...
 
- 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 acceptVisitor (CCDataVisitor &visitor)
- Public Member Functions inherited from CCCopying
virtual CCObjectcopyWithZone (CCZone *pZone)

Static Public Member Functions

static CCScale9Spritecreate (const char *file, CCRect rect, CCRect capInsets)
 Creates a 9-slice sprite with a texture file, a delimitation zone and with the specified cap insets. More...
 
var create ( var file, var rect, var capInsets)
 Creates a 9-slice sprite with a texture file, a delimitation zone and with the specified cap insets. More...
 
local create ( local file, local rect, local capInsets)
 Creates a 9-slice sprite with a texture file, a delimitation zone and with the specified cap insets. More...
 
static CCScale9Spritecreate (const char *file, CCRect rect)
 Creates a 9-slice sprite with a texture file and a delimitation zone. More...
 
var create ( var file, var rect)
 Creates a 9-slice sprite with a texture file and a delimitation zone. More...
 
local create ( local file, local rect)
 Creates a 9-slice sprite with a texture file and a delimitation zone. More...
 
static CCScale9Spritecreate (CCRect capInsets, const char *file)
 Creates a 9-slice sprite with a texture file. More...
 
static CCScale9Spritecreate (const char *file)
 Creates a 9-slice sprite with a texture file. More...
 
var create ( var file)
 Creates a 9-slice sprite with a texture file. More...
 
local create ( local file)
 Creates a 9-slice sprite with a texture file. More...
 
static CCScale9SpritecreateWithSpriteFrame (CCSpriteFrame *spriteFrame, CCRect capInsets)
 Creates a 9-slice sprite with an sprite frame and the centre of its zone. More...
 
local createWithSpriteFrame ( local spriteFrame, local capInsets)
 Creates a 9-slice sprite with an sprite frame and the centre of its zone. More...
 
static CCScale9SpritecreateWithSpriteFrame (CCSpriteFrame *spriteFrame)
 Creates a 9-slice sprite with an sprite frame. More...
 
local createWithSpriteFrame ( local spriteFrame)
 Creates a 9-slice sprite with an sprite frame. More...
 
static CCScale9SpritecreateWithSpriteFrameName (const char *spriteFrameName, CCRect capInsets)
 Creates a 9-slice sprite with an sprite frame name and the centre of its zone. More...
 
local createWithSpriteFrameName ( local spriteFrameName, local capInsets)
 Creates a 9-slice sprite with an sprite frame name and the centre of its zone. More...
 
static CCScale9SpritecreateWithSpriteFrameName (const char *spriteFrameName)
 Creates a 9-slice sprite with an sprite frame name. More...
 
local createWithSpriteFrameName ( local spriteFrameName)
 Creates a 9-slice sprite with an sprite frame name. More...
 
static CCScale9Spritecreate ()
local create ()
- Static Public Member Functions inherited from CCNodeRGBA
static CCNodeRGBAcreate (void)
 Allocates and initializes a nodergba. More...
 
- Static Public Member Functions inherited from CCNode
static CCNodecreate (void)
 Allocates and initializes a node. More...
 

Protected Member Functions

void updateCapInset ()
void updatePositions ()
var updatePositions ()
local updatePositions ()

Protected Attributes

CCSize m_originalSize
 Original sprite's size. More...
 
var m_originalSize
 Original sprite's size. More...
 
local m_originalSize
 Original sprite's size. More...
 
CCSize m_preferredSize
 Prefered sprite's size. More...
 
var m_preferredSize
 Prefered sprite's size. More...
 
local m_preferredSize
 Prefered sprite's size. More...
 
CCRect m_capInsets
 The end-cap insets. More...
 
var m_capInsets
 The end-cap insets. More...
 
local m_capInsets
 The end-cap insets. More...
 
float m_insetLeft
 Sets the left side inset. More...
 
float m_insetTop
 Sets the top side inset. More...
 
float m_insetRight
 Sets the right side inset. More...
 
var m_insetRight
 Sets the right side inset. More...
 
local m_insetRight
 Sets the right side inset. More...
 
float m_insetBottom
 Sets the bottom side inset. More...
 
bool m_bSpritesGenerated
CCRect m_spriteRect
var m_spriteRect
local m_spriteRect
bool m_bSpriteFrameRotated
var m_bSpriteFrameRotated
local m_bSpriteFrameRotated
CCRect m_capInsetsInternal
var m_capInsetsInternal
local m_capInsetsInternal
bool m_positionsAreDirty
var m_positionsAreDirty
local m_positionsAreDirty
CCSpriteBatchNode_scale9Image
var _scale9Image
local _scale9Image
CCSprite_topLeft
var _topLeft
local _topLeft
CCSprite_top
CCSprite_topRight
var _topRight
local _topRight
CCSprite_left
CCSprite_centre
var _centre
local _centre
CCSprite_right
var _right
local _right
CCSprite_bottomLeft
var _bottomLeft
local _bottomLeft
CCSprite_bottom
var _bottom
local _bottom
CCSprite_bottomRight
var _bottomRight
local _bottomRight
bool _opacityModifyRGB
var _opacityModifyRGB
local _opacityModifyRGB
GLubyte _opacity
var _opacity
local _opacity
ccColor3B _color
var _color
local _color
- Protected Attributes inherited from CCNodeRGBA
GLubyte _displayedOpacity
GLubyte _realOpacity
ccColor3B _displayedColor
ccColor3B _realColor
bool _cascadeColorEnabled
bool _cascadeOpacityEnabled
- Protected Attributes inherited from CCNode
float m_fRotationX
 rotation angle on x-axis More...
 
float m_fRotationY
 rotation angle on y-axis More...
 
local m_fRotationY
 rotation angle on y-axis More...
 
float m_fScaleX
 scaling factor on x-axis More...
 
local m_fScaleX
 scaling factor on x-axis More...
 
float m_fScaleY
 scaling factor on y-axis More...
 
local m_fScaleY
 scaling factor on y-axis More...
 
float m_fVertexZ
 OpenGL real Z vertex. More...
 
local m_fVertexZ
 OpenGL real Z vertex. More...
 
CCPoint m_obPosition
 position of the node More...
 
local m_obPosition
 position of the node More...
 
float m_fSkewX
 skew angle on x-axis More...
 
local m_fSkewX
 skew angle on x-axis More...
 
float m_fSkewY
 skew angle on y-axis More...
 
local m_fSkewY
 skew angle on y-axis More...
 
CCPoint m_obAnchorPointInPoints
 anchor point in points More...
 
local m_obAnchorPointInPoints
 anchor point in points More...
 
CCPoint m_obAnchorPoint
 anchor point normalized (NOT in points) More...
 
local m_obAnchorPoint
 anchor point normalized (NOT in points) More...
 
CCSize m_obContentSize
 untransformed size of the node More...
 
local m_obContentSize
 untransformed size of the node More...
 
CCAffineTransform m_sAdditionalTransform
 transform More...
 
CCAffineTransform m_sTransform
 transform More...
 
local m_sTransform
 transform More...
 
CCAffineTransform m_sInverse
 transform More...
 
local m_sInverse
 transform More...
 
CCCameram_pCamera
 a camera More...
 
local m_pCamera
 a camera More...
 
CCGridBasem_pGrid
 a grid More...
 
local m_pGrid
 a grid More...
 
int m_nZOrder
 z-order value that affects the draw order More...
 
local m_nZOrder
 z-order value that affects the draw order More...
 
CCArraym_pChildren
 array of children nodes More...
 
local m_pChildren
 array of children nodes More...
 
CCNodem_pParent
 weak reference to parent node More...
 
local m_pParent
 weak reference to parent node More...
 
int m_nTag
 a tag. Can be any number you assigned just to identify this node More...
 
local m_nTag
 a tag. Can be any number you assigned just to identify this node More...
 
void * m_pUserData
 A user assingned void pointer, Can be point to any cpp object. More...
 
local m_pUserData
 A user assingned void pointer, Can be point to any cpp object. More...
 
CCObjectm_pUserObject
 A user assigned CCObject. More...
 
local m_pUserObject
 A user assigned CCObject. More...
 
CCGLProgramm_pShaderProgram
 OpenGL shader. More...
 
local m_pShaderProgram
 OpenGL shader. More...
 
ccGLServerState m_eGLServerState
 OpenGL servier side state. More...
 
local m_eGLServerState
 OpenGL servier side state. More...
 
unsigned int m_uOrderOfArrival
 used to preserve sequence while sorting children with the same zOrder More...
 
local m_uOrderOfArrival
 used to preserve sequence while sorting children with the same zOrder More...
 
CCSchedulerm_pScheduler
 scheduler used to schedule timers and updates More...
 
local m_pScheduler
 scheduler used to schedule timers and updates More...
 
CCActionManagerm_pActionManager
 a pointer to ActionManager singleton, which is used to handle all the actions More...
 
bool m_bRunning
 is running More...
 
local m_bRunning
 is running More...
 
bool m_bTransformDirty
 transform dirty flag More...
 
local m_bTransformDirty
 transform dirty flag More...
 
bool m_bInverseDirty
 transform dirty flag More...
 
local m_bInverseDirty
 transform dirty flag More...
 
bool m_bAdditionalTransformDirty
 The flag to check whether the additional transform is dirty. More...
 
local m_bAdditionalTransformDirty
 The flag to check whether the additional transform is dirty. More...
 
bool m_bVisible
 is this node visible More...
 
local m_bVisible
 is this node visible More...
 
bool m_bIgnoreAnchorPointForPosition
 true if the Anchor Point will be (0,0) when you position the CCNode, false otherwise. More...
 
local m_bIgnoreAnchorPointForPosition
 true if the Anchor Point will be (0,0) when you position the CCNode, false otherwise. More...
 
bool m_bReorderChildDirty
 children order dirty flag More...
 
int m_nScriptHandler
 script handler for onEnter() & onExit(), used in Javascript binding and Lua binding. More...
 
local m_nScriptHandler
 script handler for onEnter() & onExit(), used in Javascript binding and Lua binding. More...
 
int m_nUpdateScriptHandler
 script handler for update() callback per frame, which is invoked from lua & javascript. More...
 
local m_nUpdateScriptHandler
 script handler for update() callback per frame, which is invoked from lua & javascript. More...
 
ccScriptType m_eScriptType
 type of script binding, lua or javascript More...
 
local m_eScriptType
 type of script binding, lua or javascript More...
 
CCComponentContainerm_pComponentContainer
 Dictionary of components. More...
 
- Protected Attributes inherited from CCObject
unsigned int m_uReference
unsigned int m_uAutoReleaseCount

Additional Inherited Members

- Public Attributes inherited from CCObject
unsigned int m_uID
int m_nLuaID

Detailed Description

A 9-slice sprite for cocos2d.

9-slice scaling allows you to specify how scaling is applied to specific areas of a sprite. With 9-slice scaling (3x3 grid), you can ensure that the sprite does not become distorted when scaled.

See Also
http://yannickloriot.com/library/ios/cccontrolextension/Classes/CCScale9Sprite.html

Constructor & Destructor Documentation

var CCScale9Sprite ( )
local CCScale9Sprite ( )
virtual ~CCScale9Sprite ( )
virtual
var ~CCScale9Sprite ( )
virtual
local ~CCScale9Sprite ( )
virtual

Member Function Documentation

static CCScale9Sprite* create ( const char *  file,
CCRect  rect,
CCRect  capInsets 
)
static

Creates a 9-slice sprite with a texture file, a delimitation zone and with the specified cap insets.

See Also
initWithFile:rect:centerRegion:
var create ( var  file,
var  rect,
var  capInsets 
)
static

Creates a 9-slice sprite with a texture file, a delimitation zone and with the specified cap insets.

See Also
initWithFile:rect:centerRegion:
local create ( local  file,
local  rect,
local  capInsets 
)
static

Creates a 9-slice sprite with a texture file, a delimitation zone and with the specified cap insets.

See Also
initWithFile:rect:centerRegion:
static CCScale9Sprite* create ( const char *  file,
CCRect  rect 
)
static

Creates a 9-slice sprite with a texture file and a delimitation zone.

The texture will be broken down into a 3×3 grid of equal blocks.

See Also
initWithFile:rect:
var create ( var  file,
var  rect 
)
static

Creates a 9-slice sprite with a texture file and a delimitation zone.

The texture will be broken down into a 3×3 grid of equal blocks.

See Also
initWithFile:rect:
local create ( local  file,
local  rect 
)
static

Creates a 9-slice sprite with a texture file and a delimitation zone.

The texture will be broken down into a 3×3 grid of equal blocks.

See Also
initWithFile:rect:
static CCScale9Sprite* create ( CCRect  capInsets,
const char *  file 
)
static

Creates a 9-slice sprite with a texture file.

The whole texture will be broken down into a 3×3 grid of equal blocks.

See Also
initWithFile:capInsets:
var create ( var  capInsets,
var  file 
)
static

Creates a 9-slice sprite with a texture file.

The whole texture will be broken down into a 3×3 grid of equal blocks.

See Also
initWithFile:capInsets:
local create ( local  capInsets,
local  file 
)
static

Creates a 9-slice sprite with a texture file.

The whole texture will be broken down into a 3×3 grid of equal blocks.

See Also
initWithFile:capInsets:
static CCScale9Sprite* create ( const char *  file)
static

Creates a 9-slice sprite with a texture file.

The whole texture will be broken down into a 3×3 grid of equal blocks.

See Also
initWithFile:
var create ( var  file)
static

Creates a 9-slice sprite with a texture file.

The whole texture will be broken down into a 3×3 grid of equal blocks.

See Also
initWithFile:
local create ( local  file)
static

Creates a 9-slice sprite with a texture file.

The whole texture will be broken down into a 3×3 grid of equal blocks.

See Also
initWithFile:
static CCScale9Sprite* create ( )
static
var create ( )
static
local create ( )
static
static CCScale9Sprite*
createWithSpriteFrame
( CCSpriteFrame spriteFrame,
CCRect  capInsets 
)
static

Creates a 9-slice sprite with an sprite frame and the centre of its zone.

Once the sprite is created, you can then call its "setContentSize:" method to resize the sprite will all it's 9-slice goodness intract. It respects the anchorPoint too.

See Also
initWithSpriteFrame:centerRegion:
var createWithSpriteFrame ( var  spriteFrame,
var  capInsets 
)
static

Creates a 9-slice sprite with an sprite frame and the centre of its zone.

Once the sprite is created, you can then call its "setContentSize:" method to resize the sprite will all it's 9-slice goodness intract. It respects the anchorPoint too.

See Also
initWithSpriteFrame:centerRegion:
local createWithSpriteFrame ( local  spriteFrame,
local  capInsets 
)
static

Creates a 9-slice sprite with an sprite frame and the centre of its zone.

Once the sprite is created, you can then call its "setContentSize:" method to resize the sprite will all it's 9-slice goodness intract. It respects the anchorPoint too.

See Also
initWithSpriteFrame:centerRegion:
static CCScale9Sprite*
createWithSpriteFrame
( CCSpriteFrame spriteFrame)
static

Creates a 9-slice sprite with an sprite frame.

Once the sprite is created, you can then call its "setContentSize:" method to resize the sprite will all it's 9-slice goodness intract. It respects the anchorPoint too.

See Also
initWithSpriteFrame:
var createWithSpriteFrame ( var  spriteFrame)
static

Creates a 9-slice sprite with an sprite frame.

Once the sprite is created, you can then call its "setContentSize:" method to resize the sprite will all it's 9-slice goodness intract. It respects the anchorPoint too.

See Also
initWithSpriteFrame:
local createWithSpriteFrame ( local  spriteFrame)
static

Creates a 9-slice sprite with an sprite frame.

Once the sprite is created, you can then call its "setContentSize:" method to resize the sprite will all it's 9-slice goodness intract. It respects the anchorPoint too.

See Also
initWithSpriteFrame:
static CCScale9Sprite*
createWithSpriteFrameName
( const char *  spriteFrameName,
CCRect  capInsets 
)
static

Creates a 9-slice sprite with an sprite frame name and the centre of its zone.

Once the sprite is created, you can then call its "setContentSize:" method to resize the sprite will all it's 9-slice goodness intract. It respects the anchorPoint too.

See Also
initWithSpriteFrameName:centerRegion:
var createWithSpriteFrameName ( var  spriteFrameName,
var  capInsets 
)
static

Creates a 9-slice sprite with an sprite frame name and the centre of its zone.

Once the sprite is created, you can then call its "setContentSize:" method to resize the sprite will all it's 9-slice goodness intract. It respects the anchorPoint too.

See Also
initWithSpriteFrameName:centerRegion:
local createWithSpriteFrameName ( local  spriteFrameName,
local  capInsets 
)
static

Creates a 9-slice sprite with an sprite frame name and the centre of its zone.

Once the sprite is created, you can then call its "setContentSize:" method to resize the sprite will all it's 9-slice goodness intract. It respects the anchorPoint too.

See Also
initWithSpriteFrameName:centerRegion:
static CCScale9Sprite*
createWithSpriteFrameName
( const char *  spriteFrameName)
static

Creates a 9-slice sprite with an sprite frame name.

Once the sprite is created, you can then call its "setContentSize:" method to resize the sprite will all it's 9-slice goodness intract. It respects the anchorPoint too.

See Also
initWithSpriteFrameName:
var createWithSpriteFrameName ( var  spriteFrameName)
static

Creates a 9-slice sprite with an sprite frame name.

Once the sprite is created, you can then call its "setContentSize:" method to resize the sprite will all it's 9-slice goodness intract. It respects the anchorPoint too.

See Also
initWithSpriteFrameName:
local createWithSpriteFrameName ( local  spriteFrameName)
static

Creates a 9-slice sprite with an sprite frame name.

Once the sprite is created, you can then call its "setContentSize:" method to resize the sprite will all it's 9-slice goodness intract. It respects the anchorPoint too.

See Also
initWithSpriteFrameName:
virtual CCRect getCapInsets ( void  )
virtual

getCapInsets

var getCapInsets (   )
virtual

getCapInsets

local getCapInsets (   )
virtual

getCapInsets

virtual const ccColor3B& getColor ( )
virtual

Returns color that is currently used.

Returns
The ccColor3B contains R,G,B bytes.

Reimplemented from CCNodeRGBA.

var getColor ( )
virtual

Returns color that is currently used.

Returns
The ccColor3B contains R,G,B bytes.

Reimplemented from CCNodeRGBA.

local getColor ( )
virtual

Returns color that is currently used.

Returns
The ccColor3B contains R,G,B bytes.

Reimplemented from CCNodeRGBA.

virtual float getInsetBottom ( void  )
virtual

getInsetBottom

var getInsetBottom (   )
virtual

getInsetBottom

local getInsetBottom (   )
virtual

getInsetBottom

virtual float getInsetLeft ( void  )
virtual

getInsetLeft

var getInsetLeft (   )
virtual

getInsetLeft

local getInsetLeft (   )
virtual

getInsetLeft

virtual float getInsetRight ( void  )
virtual

getInsetRight

var getInsetRight (   )
virtual

getInsetRight

local getInsetRight (   )
virtual

getInsetRight

virtual float getInsetTop ( void  )
virtual

getInsetTop

var getInsetTop (   )
virtual

getInsetTop

local getInsetTop (   )
virtual

getInsetTop

virtual GLubyte getOpacity ( )
virtual

Returns the opacity.

The opacity which indicates how transparent or opaque this node is. 0 indicates fully transparent and 255 is fully opaque.

Returns
The opacity of sprite, from 0 ~ 255

Reimplemented from CCNodeRGBA.

var getOpacity ( )
virtual

Returns the opacity.

The opacity which indicates how transparent or opaque this node is. 0 indicates fully transparent and 255 is fully opaque.

Returns
The opacity of sprite, from 0 ~ 255

Reimplemented from CCNodeRGBA.

local getOpacity ( )
virtual

Returns the opacity.

The opacity which indicates how transparent or opaque this node is. 0 indicates fully transparent and 255 is fully opaque.

Returns
The opacity of sprite, from 0 ~ 255

Reimplemented from CCNodeRGBA.

virtual CCSize getOriginalSize ( void  )
virtual

getOriginalSize

var getOriginalSize (   )
virtual

getOriginalSize

local getOriginalSize (   )
virtual

getOriginalSize

virtual CCSize getPreferredSize ( void  )
virtual

getPreferredSize

var getPreferredSize (   )
virtual

getPreferredSize

local getPreferredSize (   )
virtual

getPreferredSize

virtual bool init ( )
virtual

Initializes the instance of CCNode.

Returns
Whether the initialization was successful.

Reimplemented from CCNodeRGBA.

var init ( )
virtual

Initializes the instance of CCNode.

Returns
Whether the initialization was successful.

Reimplemented from CCNodeRGBA.

local init ( )
virtual

Initializes the instance of CCNode.

Returns
Whether the initialization was successful.

Reimplemented from CCNodeRGBA.

virtual bool initWithBatchNode ( CCSpriteBatchNode batchnode,
CCRect  rect,
bool  rotated,
CCRect  capInsets 
)
virtual
var initWithBatchNode ( var  batchnode,
var  rect,
var  rotated,
var  capInsets 
)
virtual
local initWithBatchNode ( local  batchnode,
local  rect,
local  rotated,
local  capInsets 
)
virtual
virtual bool initWithBatchNode ( CCSpriteBatchNode batchnode,
CCRect  rect,
CCRect  capInsets 
)
virtual
var initWithBatchNode ( var  batchnode,
var  rect,
var  capInsets 
)
virtual
local initWithBatchNode ( local  batchnode,
local  rect,
local  capInsets 
)
virtual
virtual bool initWithFile ( const char *  file,
CCRect  rect,
CCRect  capInsets 
)
virtual

Initializes a 9-slice sprite with a texture file, a delimitation zone and with the specified cap insets.

Once the sprite is created, you can then call its "setContentSize:" method to resize the sprite will all it's 9-slice goodness intract. It respects the anchorPoint too.

Parameters
fileThe name of the texture file.
rectThe rectangle that describes the sub-part of the texture that is the whole image. If the shape is the whole texture, set this to the texture's full rect.
capInsetsThe values to use for the cap insets.
var initWithFile ( var  file,
var  rect,
var  capInsets 
)
virtual

Initializes a 9-slice sprite with a texture file, a delimitation zone and with the specified cap insets.

Once the sprite is created, you can then call its "setContentSize:" method to resize the sprite will all it's 9-slice goodness intract. It respects the anchorPoint too.

Parameters
fileThe name of the texture file.
rectThe rectangle that describes the sub-part of the texture that is the whole image. If the shape is the whole texture, set this to the texture's full rect.
capInsetsThe values to use for the cap insets.
local initWithFile ( local  file,
local  rect,
local  capInsets 
)
virtual

Initializes a 9-slice sprite with a texture file, a delimitation zone and with the specified cap insets.

Once the sprite is created, you can then call its "setContentSize:" method to resize the sprite will all it's 9-slice goodness intract. It respects the anchorPoint too.

Parameters
fileThe name of the texture file.
rectThe rectangle that describes the sub-part of the texture that is the whole image. If the shape is the whole texture, set this to the texture's full rect.
capInsetsThe values to use for the cap insets.
virtual bool initWithFile ( const char *  file,
CCRect  rect 
)
virtual

Initializes a 9-slice sprite with a texture file and a delimitation zone.

The texture will be broken down into a 3×3 grid of equal blocks. Once the sprite is created, you can then call its "setContentSize:" method to resize the sprite will all it's 9-slice goodness intract. It respects the anchorPoint too.

Parameters
fileThe name of the texture file.
rectThe rectangle that describes the sub-part of the texture that is the whole image. If the shape is the whole texture, set this to the texture's full rect.
var initWithFile ( var  file,
var  rect 
)
virtual

Initializes a 9-slice sprite with a texture file and a delimitation zone.

The texture will be broken down into a 3×3 grid of equal blocks. Once the sprite is created, you can then call its "setContentSize:" method to resize the sprite will all it's 9-slice goodness intract. It respects the anchorPoint too.

Parameters
fileThe name of the texture file.
rectThe rectangle that describes the sub-part of the texture that is the whole image. If the shape is the whole texture, set this to the texture's full rect.
local initWithFile ( local  file,
local  rect 
)
virtual

Initializes a 9-slice sprite with a texture file and a delimitation zone.

The texture will be broken down into a 3×3 grid of equal blocks. Once the sprite is created, you can then call its "setContentSize:" method to resize the sprite will all it's 9-slice goodness intract. It respects the anchorPoint too.

Parameters
fileThe name of the texture file.
rectThe rectangle that describes the sub-part of the texture that is the whole image. If the shape is the whole texture, set this to the texture's full rect.
virtual bool initWithFile ( CCRect  capInsets,
const char *  file 
)
virtual

Initializes a 9-slice sprite with a texture file and with the specified cap insets.

Once the sprite is created, you can then call its "setContentSize:" method to resize the sprite will all it's 9-slice goodness intract. It respects the anchorPoint too.

Parameters
fileThe name of the texture file.
capInsetsThe values to use for the cap insets.
var initWithFile ( var  capInsets,
var  file 
)
virtual

Initializes a 9-slice sprite with a texture file and with the specified cap insets.

Once the sprite is created, you can then call its "setContentSize:" method to resize the sprite will all it's 9-slice goodness intract. It respects the anchorPoint too.

Parameters
fileThe name of the texture file.
capInsetsThe values to use for the cap insets.
local initWithFile ( local  capInsets,
local  file 
)
virtual

Initializes a 9-slice sprite with a texture file and with the specified cap insets.

Once the sprite is created, you can then call its "setContentSize:" method to resize the sprite will all it's 9-slice goodness intract. It respects the anchorPoint too.

Parameters
fileThe name of the texture file.
capInsetsThe values to use for the cap insets.
virtual bool initWithFile ( const char *  file)
virtual

Initializes a 9-slice sprite with a texture file.

The whole texture will be broken down into a 3×3 grid of equal blocks. Once the sprite is created, you can then call its "setContentSize:" method to resize the sprite will all it's 9-slice goodness intract. It respects the anchorPoint too.

Parameters
fileThe name of the texture file.
var initWithFile ( var  file)
virtual

Initializes a 9-slice sprite with a texture file.

The whole texture will be broken down into a 3×3 grid of equal blocks. Once the sprite is created, you can then call its "setContentSize:" method to resize the sprite will all it's 9-slice goodness intract. It respects the anchorPoint too.

Parameters
fileThe name of the texture file.
local initWithFile ( local  file)
virtual

Initializes a 9-slice sprite with a texture file.

The whole texture will be broken down into a 3×3 grid of equal blocks. Once the sprite is created, you can then call its "setContentSize:" method to resize the sprite will all it's 9-slice goodness intract. It respects the anchorPoint too.

Parameters
fileThe name of the texture file.
virtual bool initWithSpriteFrame ( CCSpriteFrame spriteFrame,
CCRect  capInsets 
)
virtual

Initializes a 9-slice sprite with an sprite frame and with the specified cap insets.

Once the sprite is created, you can then call its "setContentSize:" method to resize the sprite will all it's 9-slice goodness intract. It respects the anchorPoint too.

Parameters
spriteFrameThe sprite frame object.
capInsetsThe values to use for the cap insets.
var initWithSpriteFrame ( var  spriteFrame,
var  capInsets 
)
virtual

Initializes a 9-slice sprite with an sprite frame and with the specified cap insets.

Once the sprite is created, you can then call its "setContentSize:" method to resize the sprite will all it's 9-slice goodness intract. It respects the anchorPoint too.

Parameters
spriteFrameThe sprite frame object.
capInsetsThe values to use for the cap insets.
local initWithSpriteFrame ( local  spriteFrame,
local  capInsets 
)
virtual

Initializes a 9-slice sprite with an sprite frame and with the specified cap insets.

Once the sprite is created, you can then call its "setContentSize:" method to resize the sprite will all it's 9-slice goodness intract. It respects the anchorPoint too.

Parameters
spriteFrameThe sprite frame object.
capInsetsThe values to use for the cap insets.
virtual bool initWithSpriteFrame ( CCSpriteFrame spriteFrame)
virtual

Initializes a 9-slice sprite with an sprite frame.

Once the sprite is created, you can then call its "setContentSize:" method to resize the sprite will all it's 9-slice goodness intract. It respects the anchorPoint too.

Parameters
spriteFrameThe sprite frame object.
var initWithSpriteFrame ( var  spriteFrame)
virtual

Initializes a 9-slice sprite with an sprite frame.

Once the sprite is created, you can then call its "setContentSize:" method to resize the sprite will all it's 9-slice goodness intract. It respects the anchorPoint too.

Parameters
spriteFrameThe sprite frame object.
local initWithSpriteFrame ( local  spriteFrame)
virtual

Initializes a 9-slice sprite with an sprite frame.

Once the sprite is created, you can then call its "setContentSize:" method to resize the sprite will all it's 9-slice goodness intract. It respects the anchorPoint too.

Parameters
spriteFrameThe sprite frame object.
virtual bool
initWithSpriteFrameName
( const char *  spriteFrameName,
CCRect  capInsets 
)
virtual

Initializes a 9-slice sprite with an sprite frame name and with the specified cap insets.

Once the sprite is created, you can then call its "setContentSize:" method to resize the sprite will all it's 9-slice goodness intract. It respects the anchorPoint too.

Parameters
spriteFrameNameThe sprite frame name.
capInsetsThe values to use for the cap insets.
var initWithSpriteFrameName ( var  spriteFrameName,
var  capInsets 
)
virtual

Initializes a 9-slice sprite with an sprite frame name and with the specified cap insets.

Once the sprite is created, you can then call its "setContentSize:" method to resize the sprite will all it's 9-slice goodness intract. It respects the anchorPoint too.

Parameters
spriteFrameNameThe sprite frame name.
capInsetsThe values to use for the cap insets.
local initWithSpriteFrameName ( local  spriteFrameName,
local  capInsets 
)
virtual

Initializes a 9-slice sprite with an sprite frame name and with the specified cap insets.

Once the sprite is created, you can then call its "setContentSize:" method to resize the sprite will all it's 9-slice goodness intract. It respects the anchorPoint too.

Parameters
spriteFrameNameThe sprite frame name.
capInsetsThe values to use for the cap insets.
virtual bool
initWithSpriteFrameName
( const char *  spriteFrameName)
virtual

Initializes a 9-slice sprite with an sprite frame name.

Once the sprite is created, you can then call its "setContentSize:" method to resize the sprite will all it's 9-slice goodness intract. It respects the anchorPoint too.

Parameters
spriteFrameNameThe sprite frame name.
var initWithSpriteFrameName ( var  spriteFrameName)
virtual

Initializes a 9-slice sprite with an sprite frame name.

Once the sprite is created, you can then call its "setContentSize:" method to resize the sprite will all it's 9-slice goodness intract. It respects the anchorPoint too.

Parameters
spriteFrameNameThe sprite frame name.
local initWithSpriteFrameName ( local  spriteFrameName)
virtual

Initializes a 9-slice sprite with an sprite frame name.

Once the sprite is created, you can then call its "setContentSize:" method to resize the sprite will all it's 9-slice goodness intract. It respects the anchorPoint too.

Parameters
spriteFrameNameThe sprite frame name.
virtual bool isOpacityModifyRGB ( void  )
virtual

returns whether or not the opacity will be applied using glColor(R,G,B,opacity) or glColor(opacity, opacity, opacity, opacity);

Since
v0.8

Reimplemented from CCNodeRGBA.

var isOpacityModifyRGB (   )
virtual

returns whether or not the opacity will be applied using glColor(R,G,B,opacity) or glColor(opacity, opacity, opacity, opacity);

Since
v0.8

Reimplemented from CCNodeRGBA.

local isOpacityModifyRGB (   )
virtual

returns whether or not the opacity will be applied using glColor(R,G,B,opacity) or glColor(opacity, opacity, opacity, opacity);

Since
v0.8

Reimplemented from CCNodeRGBA.

CCScale9Sprite*
resizableSpriteWithCapInsets
( CCRect  capInsets)

Creates and returns a new sprite object with the specified cap insets.

You use this method to add cap insets to a sprite or to change the existing cap insets of a sprite. In both cases, you get back a new image and the original sprite remains untouched.

Parameters
capInsetsThe values to use for the cap insets.
var resizableSpriteWithCapInsets ( var  capInsets)

Creates and returns a new sprite object with the specified cap insets.

You use this method to add cap insets to a sprite or to change the existing cap insets of a sprite. In both cases, you get back a new image and the original sprite remains untouched.

Parameters
capInsetsThe values to use for the cap insets.
local resizableSpriteWithCapInsets ( local  capInsets)

Creates and returns a new sprite object with the specified cap insets.

You use this method to add cap insets to a sprite or to change the existing cap insets of a sprite. In both cases, you get back a new image and the original sprite remains untouched.

Parameters
capInsetsThe values to use for the cap insets.
virtual void setCapInsets ( CCRect  var)
virtual

setCapInsets

var setCapInsets ( var  var)
virtual

setCapInsets

local setCapInsets ( local  var)
virtual

setCapInsets

virtual void setColor ( const ccColor3B color)
virtual

@

Reimplemented from CCNodeRGBA.

var setColor ( var  color)
virtual

@

Reimplemented from CCNodeRGBA.

local setColor ( local  color)
virtual

@

Reimplemented from CCNodeRGBA.

virtual void setContentSize ( const CCSize contentSize)
virtual

Sets the untransformed size of the node.

The contentSize remains the same no matter the node is scaled or rotated. All nodes has a size. Layer and Scene has the same size of the screen.

Parameters
contentSizeThe untransformed size of the node.

Reimplemented from CCNode.

var setContentSize ( var  contentSize)
virtual

Sets the untransformed size of the node.

The contentSize remains the same no matter the node is scaled or rotated. All nodes has a size. Layer and Scene has the same size of the screen.

Parameters
contentSizeThe untransformed size of the node.

Reimplemented from CCNode.

local setContentSize ( local  contentSize)
virtual

Sets the untransformed size of the node.

The contentSize remains the same no matter the node is scaled or rotated. All nodes has a size. Layer and Scene has the same size of the screen.

Parameters
contentSizeThe untransformed size of the node.

Reimplemented from CCNode.

virtual void setInsetBottom ( float  var)
virtual

setInsetBottom

var setInsetBottom ( var  var)
virtual

setInsetBottom

local setInsetBottom ( local  var)
virtual

setInsetBottom

virtual void setInsetLeft ( float  var)
virtual

setInsetLeft

var setInsetLeft ( var  var)
virtual

setInsetLeft

local setInsetLeft ( local  var)
virtual

setInsetLeft

virtual void setInsetRight ( float  var)
virtual

setInsetRight

var setInsetRight ( var  var)
virtual

setInsetRight

local setInsetRight ( local  var)
virtual

setInsetRight

virtual void setInsetTop ( float  var)
virtual

setInsetTop

var setInsetTop ( var  var)
virtual

setInsetTop

local setInsetTop ( local  var)
virtual

setInsetTop

virtual void setOpacity ( GLubyte  opacity)
virtual

Changes the opacity.

Parameters
valueGoes from 0 to 255, where 255 means fully opaque and 0 means fully transparent.

Reimplemented from CCNodeRGBA.

var setOpacity ( var  opacity)
virtual

Changes the opacity.

Parameters
valueGoes from 0 to 255, where 255 means fully opaque and 0 means fully transparent.

Reimplemented from CCNodeRGBA.

local setOpacity ( local  opacity)
virtual

Changes the opacity.

Parameters
valueGoes from 0 to 255, where 255 means fully opaque and 0 means fully transparent.

Reimplemented from CCNodeRGBA.

virtual void setOpacityModifyRGB ( bool  bValue)
virtual

sets the premultipliedAlphaOpacity property.

If set to NO then opacity will be applied as: glColor(R,G,B,opacity); If set to YES then oapcity will be applied as: glColor(opacity, opacity, opacity, opacity ); Textures with premultiplied alpha will have this property by default on YES. Otherwise the default value is NO

Since
v0.8

Reimplemented from CCNodeRGBA.

var setOpacityModifyRGB ( var  bValue)
virtual

sets the premultipliedAlphaOpacity property.

If set to NO then opacity will be applied as: glColor(R,G,B,opacity); If set to YES then oapcity will be applied as: glColor(opacity, opacity, opacity, opacity ); Textures with premultiplied alpha will have this property by default on YES. Otherwise the default value is NO

Since
v0.8

Reimplemented from CCNodeRGBA.

local setOpacityModifyRGB ( local  bValue)
virtual

sets the premultipliedAlphaOpacity property.

If set to NO then opacity will be applied as: glColor(R,G,B,opacity); If set to YES then oapcity will be applied as: glColor(opacity, opacity, opacity, opacity ); Textures with premultiplied alpha will have this property by default on YES. Otherwise the default value is NO

Since
v0.8

Reimplemented from CCNodeRGBA.

virtual void setPreferredSize ( CCSize  var)
virtual

setPreferredSize

var setPreferredSize ( var  var)
virtual

setPreferredSize

local setPreferredSize ( local  var)
virtual

setPreferredSize

virtual void setSpriteFrame ( CCSpriteFrame spriteFrame)
virtual
var setSpriteFrame ( var  spriteFrame)
virtual
local setSpriteFrame ( local  spriteFrame)
virtual
void updateCapInset ( )
protected
var updateCapInset ( )
protected
local updateCapInset ( )
protected
virtual void updateDisplayedColor ( const cocos2d::ccColor3B &  parentColor)
virtual
var updateDisplayedColor ( var  parentColor)
virtual
local updateDisplayedColor ( local  parentColor)
virtual
virtual void updateDisplayedOpacity ( GLubyte  opacity)
virtual

recursive method that updates the displayed opacity.

Reimplemented from CCNodeRGBA.

var updateDisplayedOpacity ( var  opacity)
virtual

recursive method that updates the displayed opacity.

Reimplemented from CCNodeRGBA.

local updateDisplayedOpacity ( local  opacity)
virtual

recursive method that updates the displayed opacity.

Reimplemented from CCNodeRGBA.

void updatePositions ( )
protected
var updatePositions ( )
protected
local updatePositions ( )
protected
virtual bool updateWithBatchNode ( CCSpriteBatchNode batchnode,
CCRect  rect,
bool  rotated,
CCRect  capInsets 
)
virtual
var updateWithBatchNode ( var  batchnode,
var  rect,
var  rotated,
var  capInsets 
)
virtual
local updateWithBatchNode ( local  batchnode,
local  rect,
local  rotated,
local  capInsets 
)
virtual
virtual void visit ( )
virtual

Visits this node's children and draw them recursively.

Reimplemented from CCNode.

local visit ( )
virtual

Visits this node's children and draw them recursively.

Reimplemented from CCNode.

Member Data Documentation

CCSprite* _bottom
protected
var _bottom
protected
local _bottom
protected
CCSprite* _bottomLeft
protected
var _bottomLeft
protected
local _bottomLeft
protected
CCSprite* _bottomRight
protected
var _bottomRight
protected
local _bottomRight
protected
CCSprite* _centre
protected
var _centre
protected
local _centre
protected
ccColor3B _color
protected
var _color
protected
local _color
protected
CCSprite* _left
protected
var _left
protected
local _left
protected
GLubyte _opacity
protected
var _opacity
protected
local _opacity
protected
bool _opacityModifyRGB
protected
var _opacityModifyRGB
protected
local _opacityModifyRGB
protected
CCSprite* _right
protected
var _right
protected
local _right
protected
CCSpriteBatchNode* _scale9Image
protected
var _scale9Image
protected
local _scale9Image
protected
CCSprite* _top
protected
var _top
protected
local _top
protected
CCSprite* _topLeft
protected
var _topLeft
protected
local _topLeft
protected
CCSprite* _topRight
protected
var _topRight
protected
local _topRight
protected
bool m_bSpriteFrameRotated
protected
var m_bSpriteFrameRotated
protected
local m_bSpriteFrameRotated
protected
bool m_bSpritesGenerated
protected
var m_bSpritesGenerated
protected
local m_bSpritesGenerated
protected
CCRect m_capInsets
protected

The end-cap insets.

On a non-resizeable sprite, this property is set to CGRectZero; the sprite does not use end caps and the entire sprite is subject to stretching.

var m_capInsets
protected

The end-cap insets.

On a non-resizeable sprite, this property is set to CGRectZero; the sprite does not use end caps and the entire sprite is subject to stretching.

local m_capInsets
protected

The end-cap insets.

On a non-resizeable sprite, this property is set to CGRectZero; the sprite does not use end caps and the entire sprite is subject to stretching.

CCRect m_capInsetsInternal
protected
var m_capInsetsInternal
protected
local m_capInsetsInternal
protected
float m_insetBottom
protected

Sets the bottom side inset.

var m_insetBottom
protected

Sets the bottom side inset.

local m_insetBottom
protected

Sets the bottom side inset.

float m_insetLeft
protected

Sets the left side inset.

var m_insetLeft
protected

Sets the left side inset.

local m_insetLeft
protected

Sets the left side inset.

float m_insetRight
protected

Sets the right side inset.

var m_insetRight
protected

Sets the right side inset.

local m_insetRight
protected

Sets the right side inset.

float m_insetTop
protected

Sets the top side inset.

var m_insetTop
protected

Sets the top side inset.

local m_insetTop
protected

Sets the top side inset.

CCSize m_originalSize
protected

Original sprite's size.

var m_originalSize
protected

Original sprite's size.

local m_originalSize
protected

Original sprite's size.

bool m_positionsAreDirty
protected
var m_positionsAreDirty
protected
local m_positionsAreDirty
protected
CCSize m_preferredSize
protected

Prefered sprite's size.

By default the prefered size is the original size.

var m_preferredSize
protected

Prefered sprite's size.

By default the prefered size is the original size.

local m_preferredSize
protected

Prefered sprite's size.

By default the prefered size is the original size.

CCRect m_spriteRect
protected
var m_spriteRect
protected
local m_spriteRect
protected

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