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

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

#include <CCScale9Sprite.h>

Inheritance diagram for Scale9Sprite:
NodeRGBA Node RGBAProtocol Object

Public Member Functions

 Scale9Sprite ()
virtual ~Scale9Sprite ()
virtual bool initWithFile (const char *file, Rect rect, Rect 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, Rect rect)
 Initializes a 9-slice sprite with a texture file and a delimitation zone. More...
 
virtual bool initWithFile (Rect 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 (SpriteFrame *spriteFrame, Rect capInsets)
 Initializes a 9-slice sprite with an sprite frame and with the specified cap insets. More...
 
var initWithSpriteFrame ( var spriteFrame, var capInsets)
 Initializes a 9-slice sprite with an sprite frame and with the specified cap insets. More...
 
local initWithSpriteFrame ( local spriteFrame, local capInsets)
 Initializes a 9-slice sprite with an sprite frame and with the specified cap insets. More...
 
virtual bool initWithSpriteFrame (SpriteFrame *spriteFrame)
 Initializes a 9-slice sprite with an sprite frame. More...
 
virtual bool initWithSpriteFrameName (const char *spriteFrameName, Rect 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...
 
virtual bool init ()
 Initializes the instance of Node. More...
 
virtual bool initWithBatchNode (SpriteBatchNode *batchnode, Rect rect, bool rotated, Rect capInsets)
virtual bool initWithBatchNode (SpriteBatchNode *batchnode, Rect rect, Rect capInsets)
var initWithBatchNode ( var batchnode, var rect, var capInsets)
local initWithBatchNode ( local batchnode, local rect, local capInsets)
Scale9SpriteresizableSpriteWithCapInsets (Rect capInsets)
 Creates and returns a new sprite object with the specified cap insets. More...
 
virtual bool updateWithBatchNode (SpriteBatchNode *batchnode, Rect rect, bool rotated, Rect capInsets)
local updateWithBatchNode ( local batchnode, local rect, local rotated, local capInsets)
virtual void setSpriteFrame (SpriteFrame *spriteFrame)
virtual void setContentSize (const Size &size) override
 Sets the untransformed size of the node. More...
 
var setContentSize ( var size)
 Sets the untransformed size of the node. More...
 
local setContentSize ( local size)
 Sets the untransformed size of the node. More...
 
virtual void visit () override
 Visits this node's children and draw them recursively. More...
 
virtual void setOpacityModifyRGB (bool bValue) override
 Changes the OpacityModifyRGB property. More...
 
virtual bool isOpacityModifyRGB (void) const override
 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) override
 Changes the opacity. More...
 
virtual GLubyte getOpacity () const override
 Returns the opacity. More...
 
virtual void setColor (const Color3B &color) override
 Changes the color with R,G,B bytes. More...
 
var setColor ( var color)
 Changes the color with R,G,B bytes. More...
 
local setColor ( local color)
 Changes the color with R,G,B bytes. More...
 
virtual const Color3BgetColor () const override
 Returns color that is currently used. More...
 
local getColor ()
 Returns color that is currently used. More...
 
virtual void updateDisplayedOpacity (GLubyte parentOpacity) override
 recursive method that updates the displayed opacity. More...
 
virtual void updateDisplayedColor (const Color3B &parentColor) override
 recursive method that updates display color More...
 
var updateDisplayedColor ( var parentColor)
 recursive method that updates display color More...
 
local updateDisplayedColor ( local parentColor)
 recursive method that updates display color More...
 
virtual Size getOriginalSize (void)
 getOriginalSize More...
 
var getOriginalSize ()
 getOriginalSize More...
 
local getOriginalSize ()
 getOriginalSize More...
 
virtual Size getPreferredSize (void)
 getPreferredSize More...
 
local getPreferredSize ()
 getPreferredSize More...
 
virtual void setPreferredSize (Size var)
 setPreferredSize More...
 
virtual Rect getCapInsets (void)
 getCapInsets More...
 
var getCapInsets ()
 getCapInsets More...
 
local getCapInsets ()
 getCapInsets More...
 
virtual void setCapInsets (Rect 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...
 
- Public Member Functions inherited from NodeRGBA
 NodeRGBA ()
virtual ~NodeRGBA ()
virtual GLubyte getDisplayedOpacity () const override
 Returns the displayed opacity. More...
 
virtual bool isCascadeOpacityEnabled () const override
 whether or not opacity should be propagated to its children. More...
 
virtual void setCascadeOpacityEnabled (bool cascadeOpacityEnabled) override
virtual const Color3BgetDisplayedColor () const override
 Returns the displayed color. More...
 
virtual bool isCascadeColorEnabled () const override
 whether or not color should be propagated to its children. More...
 
virtual void setCascadeColorEnabled (bool cascadeColorEnabled) override
- Public Member Functions inherited from Node
virtual CameragetCamera ()
 Returns a camera object that lets you move the node using a gluLookAt. More...
 
virtual bool isRunning () const
 Returns whether or not the node accepts event callbacks. More...
 
void scheduleUpdateWithPriorityLua (int handler, int priority)
 Schedules for lua script. More...
 
virtual void cleanup ()
 Stops all running actions and schedulers. More...
 
var cleanup ()
 Stops all running actions and schedulers. More...
 
local cleanup ()
 Stops all running actions and schedulers. More...
 
virtual void draw ()
 Override this method to draw your own node. More...
 
local draw ()
 Override this method to draw your own node. More...
 
virtual Rect getBoundingBox () const
 Returns a "local" axis aligned bounding box of the node. More...
 
local getBoundingBox ()
 Returns a "local" axis aligned bounding box of the node. More...
 
virtual
CC_DEPRECATED_ATTRIBUTE Rect 
boundingBox () const
local boundingBox ()
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...
 
local setZOrder ( local 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...
 
virtual int getZOrder () const
 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 () const
 Gets OpenGL Z vertex of this node. More...
 
virtual void setScaleX (float scaleX)
 Changes the scale factor on X axis of this node. More...
 
var setScaleX ( var scaleX)
 Changes the scale factor on X axis of this node. More...
 
local setScaleX ( local scaleX)
 Changes the scale factor on X axis of this node. More...
 
virtual float getScaleX () const
 Returns the scale factor on X axis of this node. More...
 
virtual void setScaleY (float scaleY)
 Changes the scale factor on Y axis of this node. More...
 
var setScaleY ( var scaleY)
 Changes the scale factor on Y axis of this node. More...
 
local setScaleY ( local scaleY)
 Changes the scale factor on Y axis of this node. More...
 
virtual float getScaleY () const
 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 () const
 Gets the scale factor of the node, when X and Y have the same scale factor. More...
 
virtual void setPosition (const Point &position)
 Changes the position (x,y) of the node in OpenGL coordinates. More...
 
virtual const PointgetPosition () const
 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...
 
virtual void getPosition (float *x, float *y) const
 Gets position in a more efficient way, returns two number instead of a Point object. More...
 
virtual void setPositionX (float x)
 Gets/Sets x or y coordinate individually for position. More...
 
virtual float getPositionX (void) const
local getPositionX ()
virtual void setPositionY (float y)
local setPositionY ( local y)
virtual float getPositionY (void) const
local getPositionY ()
virtual void setSkewX (float fSkewX)
 Changes the X skew angle of the node in degrees. More...
 
virtual float getSkewX () const
 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 () const
 Returns the Y skew angle of the node in degrees. More...
 
virtual void setAnchorPoint (const Point &anchorPoint)
 Sets the anchor point in percent. More...
 
local setAnchorPoint ( local anchorPoint)
 Sets the anchor point in percent. More...
 
virtual const PointgetAnchorPoint () const
 Returns the anchor point in percent. More...
 
local getAnchorPoint ()
 Returns the anchor point in percent. More...
 
virtual const PointgetAnchorPointInPoints () const
 Returns the anchorPoint in absolute pixels. More...
 
virtual const SizegetContentSize () const
 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 () const
 Determines if the node is visible. More...
 
var isVisible ()
 Determines if the node is visible. More...
 
local isVisible ()
 Determines if the node is visible. More...
 
virtual void setRotation (float rotation)
 Sets the rotation (angle) of the node in degrees. More...
 
virtual float getRotation () const
 Returns the rotation of the node in degrees. More...
 
virtual void setRotationX (float rotationX)
 Sets the X rotation (angle) of the node in degrees which performs a horizontal rotational skew. More...
 
local setRotationX ( local rotationX)
 Sets the X rotation (angle) of the node in degrees which performs a horizontal rotational skew. More...
 
virtual float getRotationX () const
 Gets the X rotation (angle) of the node in degrees which performs a horizontal rotation skew. More...
 
virtual void setRotationY (float rotationY)
 Sets the Y rotation (angle) of the node in degrees which performs a vertical rotational skew. More...
 
local setRotationY ( local rotationY)
 Sets the Y rotation (angle) of the node in degrees which performs a vertical rotational skew. More...
 
virtual float getRotationY () const
 Gets the Y rotation (angle) of the node in degrees which performs a vertical rotational skew. More...
 
virtual void setOrderOfArrival (int orderOfArrival)
 Sets the arrival order when this node has a same ZOrder with other children. More...
 
var setOrderOfArrival ( var orderOfArrival)
 Sets the arrival order when this node has a same ZOrder with other children. More...
 
local setOrderOfArrival ( local orderOfArrival)
 Sets the arrival order when this node has a same ZOrder with other children. More...
 
virtual int getOrderOfArrival () const
 Returns the arrival order, indecates which children is added previously. More...
 
CC_DEPRECATED_ATTRIBUTE void setGLServerState (int serverState)
CC_DEPRECATED_ATTRIBUTE int getGLServerState () const
virtual void ignoreAnchorPointForPosition (bool ignore)
 Sets whether the anchor point will be (0,0) when you position this node. More...
 
virtual bool isIgnoreAnchorPointForPosition () const
 Gets whether the anchor point will be (0,0) when you position this node. More...
 
virtual void addChild (Node *child)
 Adds a child to the container with z-order as 0. More...
 
virtual void addChild (Node *child, int zOrder)
 Adds a child to the container with a z-order. More...
 
virtual void addChild (Node *child, int zOrder, int tag)
 Adds a child to the container with z order and tag. More...
 
NodegetChildByTag (int tag)
 Gets a child from the container with its tag. More...
 
virtual ArraygetChildren ()
 Return an array of children. More...
 
virtual const ArraygetChildren () const
unsigned int getChildrenCount () const
 Get the amount of children. More...
 
local getChildrenCount ()
 Get the amount of children. More...
 
virtual void setParent (Node *parent)
 Sets the parent node. More...
 
var setParent ( var parent)
 Sets the parent node. More...
 
local setParent ( local parent)
 Sets the parent node. More...
 
virtual NodegetParent ()
 Returns a pointer to the parent node. More...
 
var getParent ()
 Returns a pointer to the parent node. More...
 
local getParent ()
 Returns a pointer to the parent node. More...
 
virtual const NodegetParent () const
local getParent ()
virtual void removeFromParent ()
 Removes this node itself from its parent node with a cleanup. More...
 
local 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 removeFromParent ( local cleanup)
 Removes this node itself from its parent node. More...
 
virtual void removeChild (Node *child, bool cleanup=true)
 Removes a child from the container. More...
 
var removeChild ( var child, var true)
 Removes a child from the container. More...
 
local removeChild ( local child, local true)
 Removes a child from the container. More...
 
virtual void removeChildByTag (int tag, bool cleanup=true)
 Removes a child from the container by tag value. More...
 
local removeChildByTag ( local tag, local true)
 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...
 
local removeAllChildren ( local cleanup)
 Removes all children from the container, and do a cleanup to all running actions depending on the cleanup parameter. More...
 
virtual void reorderChild (Node *child, int zOrder)
 Reorders a child according to a new z value. More...
 
var reorderChild ( var child, var zOrder)
 Reorders a child according to a new z value. More...
 
local reorderChild ( local child, local 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 GridBasegetGrid ()
 Returns a grid object that is used when applying effects. More...
 
local getGrid ()
 Returns a grid object that is used when applying effects. More...
 
virtual const GridBasegetGrid () const
local getGrid ()
virtual void setGrid (GridBase *grid)
 Changes a grid object that is used when applying effects. More...
 
local setGrid ( local grid)
 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...
 
virtual void setTag (int tag)
 Changes the tag that is used to identify the node easily. More...
 
var setTag ( var tag)
 Changes the tag that is used to identify the node easily. More...
 
local setTag ( local tag)
 Changes the tag that is used to identify the node easily. More...
 
virtual void * getUserData ()
 Returns a custom user data pointer. More...
 
virtual const void * getUserData () const
virtual void setUserData (void *userData)
 Sets a custom user data pointer. More...
 
virtual ObjectgetUserObject ()
 Returns a user assigned Object. More...
 
virtual const ObjectgetUserObject () const
virtual void setUserObject (Object *userObject)
 Returns a user assigned Object. More...
 
local setUserObject ( local userObject)
 Returns a user assigned Object. More...
 
virtual GLProgramgetShaderProgram ()
 Return the shader program currently used for this node. More...
 
virtual const GLProgramgetShaderProgram () const
local getShaderProgram ()
virtual void setShaderProgram (GLProgram *shaderProgram)
 Sets the shader program for this node. More...
 
var setShaderProgram ( var shaderProgram)
 Sets the shader program for this node. More...
 
local setShaderProgram ( local shaderProgram)
 Sets the shader program for this node. More...
 
virtual void onEnter ()
 Event callback that is invoked every time when Node enters the 'stage'. More...
 
virtual void onEnterTransitionDidFinish ()
 Event callback that is invoked when the Node enters in the 'stage'. More...
 
virtual void onExit ()
 Event callback that is invoked every time the Node leaves the 'stage'. More...
 
virtual void onExitTransitionDidStart ()
 Event callback that is called every time the Node leaves the 'stage'. More...
 
virtual void setActionManager (ActionManager *actionManager)
 Sets the ActionManager object that is used by all actions. More...
 
virtual ActionManagergetActionManager ()
 Gets the ActionManager object that is used by all actions. More...
 
local getActionManager ()
 Gets the ActionManager object that is used by all actions. More...
 
virtual const ActionManagergetActionManager () const
ActionrunAction (Action *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 ()
 Stops and removes all actions from the running action list . More...
 
void stopAction (Action *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...
 
ActiongetActionByTag (int tag)
 Gets an action from the running action list by its tag. More...
 
unsigned int getNumberOfRunningActions () const
 Returns the numbers of actions that are running plus the ones that are schedule to run (actions in actionsToAdd and actions arrays). More...
 
local getNumberOfRunningActions ()
 Returns the numbers of actions that are running plus the ones that are schedule to run (actions in actionsToAdd and actions arrays). More...
 
CC_DEPRECATED_ATTRIBUTE
unsigned int 
numberOfRunningActions () const
local numberOfRunningActions ()
virtual void setScheduler (Scheduler *scheduler)
 Sets a Scheduler object that is used to schedule all "updates" and timers. More...
 
virtual SchedulergetScheduler ()
 Gets a Sheduler object. More...
 
virtual const SchedulergetScheduler () const
local getScheduler ()
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...
 
void resumeSchedulerAndActions (void)
 Resumes all scheduled selectors and actions. More...
 
local resumeSchedulerAndActions ()
 Resumes all scheduled selectors and actions. More...
 
void pauseSchedulerAndActions (void)
 Pauses all scheduled selectors and actions. More...
 
virtual void update (float delta)
local update ( local delta)
void transform ()
 Performs OpenGL view-matrix transformation based on position, scale, rotation and other attributes. More...
 
void transformAncestors ()
 Performs OpenGL view-matrix transformation of it's ancestors. More...
 
virtual void updateTransform ()
 Calls children's updateTransform() method recursively. More...
 
virtual const AffineTransformgetNodeToParentTransform () const
 Returns the matrix that transform the node's (local) space coordinates into the parent's space coordinates. More...
 
local getNodeToParentTransform ()
 Returns the matrix that transform the node's (local) space coordinates into the parent's space coordinates. More...
 
virtual
CC_DEPRECATED_ATTRIBUTE
AffineTransform 
nodeToParentTransform () const
local nodeToParentTransform ()
virtual const AffineTransformgetParentToNodeTransform () const
 Returns the matrix that transform parent's space coordinates to the node's (local) space coordinates. More...
 
virtual
CC_DEPRECATED_ATTRIBUTE
AffineTransform 
parentToNodeTransform () const
local parentToNodeTransform ()
virtual AffineTransform getNodeToWorldTransform () const
 Returns the world affine transform matrix. More...
 
local getNodeToWorldTransform ()
 Returns the world affine transform matrix. More...
 
virtual
CC_DEPRECATED_ATTRIBUTE
AffineTransform 
nodeToWorldTransform () const
local nodeToWorldTransform ()
virtual AffineTransform getWorldToNodeTransform () const
 Returns the inverse world affine transform matrix. More...
 
local getWorldToNodeTransform ()
 Returns the inverse world affine transform matrix. More...
 
virtual
CC_DEPRECATED_ATTRIBUTE
AffineTransform 
worldToNodeTransform () const
local worldToNodeTransform ()
Point convertToNodeSpace (const Point &worldPoint) const
 Converts a Point to node (local) space coordinates. More...
 
Point convertToWorldSpace (const Point &nodePoint) const
 Converts a Point to world space coordinates. More...
 
Point convertToNodeSpaceAR (const Point &worldPoint) const
 Converts a Point to node (local) space coordinates. More...
 
Point convertToWorldSpaceAR (const Point &nodePoint) const
 Converts a local Point to world space coordinates.The result is in Points. More...
 
Point convertTouchToNodeSpace (Touch *touch) const
 convenience methods which take a Touch instead of Point More...
 
Point convertTouchToNodeSpaceAR (Touch *touch) const
 converts a Touch (world coordinates) into a local coordinate. More...
 
void setAdditionalTransform (const AffineTransform &additionalTransform)
 Sets the additional transform. More...
 
ComponentgetComponent (const char *pName)
 gets a component by its name More...
 
virtual bool addComponent (Component *pComponent)
 adds a component More...
 
local addComponent ( local pComponent)
 adds a component More...
 
virtual bool removeComponent (const char *pName)
 removes a component by its name More...
 
virtual void removeAllComponents ()
 removes all components More...
 
 Node (void)
 Default constructor. More...
 
virtual ~Node (void)
 Default destructor. More...
 
const char * description (void) const
 Gets the description string. More...
 
- 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)

Static Public Member Functions

static Scale9Spritecreate ()
var create ()
local create ()
static Scale9Spritecreate (const char *file, Rect rect, Rect capInsets)
 Creates a 9-slice sprite with a texture file, a delimitation zone and with the specified cap insets. More...
 
static Scale9Spritecreate (Rect capInsets, const char *file)
 Creates a 9-slice sprite with a texture file. More...
 
local create ( local capInsets, local file)
 Creates a 9-slice sprite with a texture file. More...
 
static Scale9Spritecreate (const char *file, Rect rect)
 Creates a 9-slice sprite with a texture file and a delimitation zone. More...
 
static Scale9Spritecreate (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 Scale9SpritecreateWithSpriteFrame (SpriteFrame *spriteFrame)
 Creates a 9-slice sprite with an sprite frame. More...
 
static Scale9SpritecreateWithSpriteFrame (SpriteFrame *spriteFrame, Rect 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 Scale9SpritecreateWithSpriteFrameName (const char *spriteFrameName)
 Creates a 9-slice sprite with an sprite frame name. More...
 
static Scale9SpritecreateWithSpriteFrameName (const char *spriteFrameName, Rect capInsets)
 Creates a 9-slice sprite with an sprite frame name and the centre of its zone. More...
 
var createWithSpriteFrameName ( var spriteFrameName, var 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...
 

Protected Member Functions

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

Protected Attributes

bool _spritesGenerated
Rect _spriteRect
var _spriteRect
local _spriteRect
bool _spriteFrameRotated
var _spriteFrameRotated
local _spriteFrameRotated
Rect _capInsetsInternal
var _capInsetsInternal
local _capInsetsInternal
bool _positionsAreDirty
var _positionsAreDirty
local _positionsAreDirty
SpriteBatchNode_scale9Image
var _scale9Image
local _scale9Image
Sprite_topLeft
var _topLeft
local _topLeft
Sprite_top
Sprite_topRight
var _topRight
local _topRight
Sprite_left
Sprite_centre
var _centre
local _centre
Sprite_right
var _right
local _right
Sprite_bottomLeft
var _bottomLeft
local _bottomLeft
Sprite_bottom
Sprite_bottomRight
var _bottomRight
local _bottomRight
bool _opacityModifyRGB
var _opacityModifyRGB
local _opacityModifyRGB
Size _originalSize
 Original sprite's size. More...
 
var _originalSize
 Original sprite's size. More...
 
local _originalSize
 Original sprite's size. More...
 
Size _preferredSize
 Prefered sprite's size. More...
 
var _preferredSize
 Prefered sprite's size. More...
 
local _preferredSize
 Prefered sprite's size. More...
 
Rect _capInsets
 The end-cap insets. More...
 
float _insetLeft
 Sets the left side inset. More...
 
var _insetLeft
 Sets the left side inset. More...
 
local _insetLeft
 Sets the left side inset. More...
 
float _insetTop
 Sets the top side inset. More...
 
var _insetTop
 Sets the top side inset. More...
 
local _insetTop
 Sets the top side inset. More...
 
float _insetRight
 Sets the right side inset. More...
 
float _insetBottom
 Sets the bottom side inset. More...
 
var _insetBottom
 Sets the bottom side inset. More...
 
local _insetBottom
 Sets the bottom side inset. More...
 
- Protected Attributes inherited from NodeRGBA
GLubyte _displayedOpacity
GLubyte _realOpacity
Color3B _displayedColor
Color3B _realColor
bool _cascadeColorEnabled
bool _cascadeOpacityEnabled
- Protected Attributes inherited from Node
float _rotationX
 rotation angle on x-axis More...
 
float _rotationY
 rotation angle on y-axis More...
 
var _rotationY
 rotation angle on y-axis More...
 
local _rotationY
 rotation angle on y-axis More...
 
float _scaleX
 scaling factor on x-axis More...
 
var _scaleX
 scaling factor on x-axis More...
 
local _scaleX
 scaling factor on x-axis More...
 
float _scaleY
 scaling factor on y-axis More...
 
var _scaleY
 scaling factor on y-axis More...
 
local _scaleY
 scaling factor on y-axis More...
 
float _vertexZ
 OpenGL real Z vertex. More...
 
Point _position
 position of the node More...
 
float _skewX
 skew angle on x-axis More...
 
var _skewX
 skew angle on x-axis More...
 
local _skewX
 skew angle on x-axis More...
 
float _skewY
 skew angle on y-axis More...
 
var _skewY
 skew angle on y-axis More...
 
local _skewY
 skew angle on y-axis More...
 
Point _anchorPointInPoints
 anchor point in points More...
 
var _anchorPointInPoints
 anchor point in points More...
 
local _anchorPointInPoints
 anchor point in points More...
 
Point _anchorPoint
 anchor point normalized (NOT in points) More...
 
Size _contentSize
 untransformed size of the node More...
 
local _contentSize
 untransformed size of the node More...
 
AffineTransform _additionalTransform
 transform More...
 
AffineTransform _transform
 transform More...
 
var _transform
 transform More...
 
local _transform
 transform More...
 
AffineTransform _inverse
 inverse transform More...
 
var _inverse
 inverse transform More...
 
local _inverse
 inverse transform More...
 
bool _additionalTransformDirty
 The flag to check whether the additional transform is dirty. More...
 
bool _transformDirty
 transform dirty flag More...
 
var _transformDirty
 transform dirty flag More...
 
local _transformDirty
 transform dirty flag More...
 
bool _inverseDirty
 inverse transform dirty flag More...
 
var _inverseDirty
 inverse transform dirty flag More...
 
local _inverseDirty
 inverse transform dirty flag More...
 
Camera_camera
 a camera More...
 
GridBase_grid
 a grid More...
 
int _ZOrder
 z-order value that affects the draw order More...
 
Array_children
 array of children nodes More...
 
var _children
 array of children nodes More...
 
local _children
 array of children nodes More...
 
Node_parent
 weak reference to parent node More...
 
int _tag
 a tag. Can be any number you assigned just to identify this node More...
 
var _tag
 a tag. Can be any number you assigned just to identify this node More...
 
local _tag
 a tag. Can be any number you assigned just to identify this node More...
 
void * _userData
 A user assingned void pointer, Can be point to any cpp object. More...
 
Object_userObject
 A user assigned Object. More...
 
local _userObject
 A user assigned Object. More...
 
GLProgram_shaderProgram
 OpenGL shader. More...
 
int _orderOfArrival
 used to preserve sequence while sorting children with the same zOrder More...
 
Scheduler_scheduler
 scheduler used to schedule timers and updates More...
 
ActionManager_actionManager
 a pointer to ActionManager singleton, which is used to handle all the actions More...
 
var _actionManager
 a pointer to ActionManager singleton, which is used to handle all the actions More...
 
local _actionManager
 a pointer to ActionManager singleton, which is used to handle all the actions More...
 
bool _running
 is running More...
 
bool _visible
 is this node visible More...
 
bool _ignoreAnchorPointForPosition
 true if the Anchor Point will be (0,0) when you position the Node, false otherwise. More...
 
var _ignoreAnchorPointForPosition
 true if the Anchor Point will be (0,0) when you position the Node, false otherwise. More...
 
local _ignoreAnchorPointForPosition
 true if the Anchor Point will be (0,0) when you position the Node, false otherwise. More...
 
bool _reorderChildDirty
 children order dirty flag More...
 
local _reorderChildDirty
 children order dirty flag More...
 
bool _isTransitionFinished
 flag to indicate whether the transition was finished More...
 
var _isTransitionFinished
 flag to indicate whether the transition was finished More...
 
local _isTransitionFinished
 flag to indicate whether the transition was finished More...
 
int _scriptHandler
 script handler for onEnter() & onExit(), used in Javascript binding and Lua binding. More...
 
int _updateScriptHandler
 script handler for update() callback per frame, which is invoked from lua & javascript. More...
 
var _updateScriptHandler
 script handler for update() callback per frame, which is invoked from lua & javascript. More...
 
local _updateScriptHandler
 script handler for update() callback per frame, which is invoked from lua & javascript. More...
 
ccScriptType _scriptType
 type of script binding, lua or javascript More...
 
ComponentContainer_componentContainer
 Dictionary of components. More...
 
var _componentContainer
 Dictionary of components. More...
 
local _componentContainer
 Dictionary of components. More...
 
int _eventPriority
 The scene graph based priority of event listener. More...
 
int _oldEventPriority
 The old scene graph based priority of event listener. More...
 
var _oldEventPriority
 The old scene graph based priority of event listener. More...
 
local _oldEventPriority
 The old scene graph based priority of event listener. 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...
 

Additional Inherited Members

- Public Attributes inherited from Object
unsigned int _ID
 object id, ScriptSupport need public _ID More...
 
int _luaID
 Lua reference id. More...
 
- Static Public Attributes inherited from Node
static const int INVALID_TAG = -1
 Default tag used for all the nodes. More...
 
var INVALID_TAG = -1
 Default tag used for all the nodes. More...
 
local INVALID_TAG = -1
 Default tag used for all the nodes. More...
 
- Static Protected Attributes inherited from Node
static int _globalEventPriorityIndex
 The index of global event priority. More...
 

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 ctor ( )
local Scale9Sprite ( )
virtual ~Scale9Sprite ( )
virtual

Member Function Documentation

static Scale9Sprite* create ( )
static
var create ( )
static
local create ( )
static
static Scale9Sprite* create ( const char *  file,
Rect  rect,
Rect  capInsets 
)
static

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

See Also
initWithFile(const char *file, Rect rect, Rect capInsets)
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(const char *file, Rect rect, Rect capInsets)
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(const char *file, Rect rect, Rect capInsets)
static Scale9Sprite* create ( Rect  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(Rect capInsets, const char *file)
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(Rect capInsets, const char *file)
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(Rect capInsets, const char *file)
static Scale9Sprite* create ( const char *  file,
Rect  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(const char *file, Rect 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(const char *file, Rect 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(const char *file, Rect rect)
static Scale9Sprite* 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(const char *file)
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(const char *file)
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(const char *file)
static Scale9Sprite*
createWithSpriteFrame
( SpriteFrame 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(SpriteFrame *spriteFrame)
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(SpriteFrame *spriteFrame)
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(SpriteFrame *spriteFrame)
static Scale9Sprite*
createWithSpriteFrame
( SpriteFrame spriteFrame,
Rect  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(SpriteFrame *spriteFrame, Rect capInsets)
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(SpriteFrame *spriteFrame, Rect capInsets)
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(SpriteFrame *spriteFrame, Rect capInsets)
static Scale9Sprite*
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(const char *spriteFrameName)
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(const char *spriteFrameName)
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(const char *spriteFrameName)
static Scale9Sprite*
createWithSpriteFrameName
( const char *  spriteFrameName,
Rect  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(const char *spriteFrameName, Rect capInsets)
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(const char *spriteFrameName, Rect capInsets)
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(const char *spriteFrameName, Rect capInsets)
virtual Rect getCapInsets ( void  )
virtual

getCapInsets

var getCapInsets (   )
virtual

getCapInsets

local getCapInsets (   )
virtual

getCapInsets

virtual const Color3B& getColor ( ) const
overridevirtual

Returns color that is currently used.

Returns
The Color3B contains R,G,B bytes.

Reimplemented from NodeRGBA.

var getColor ( )
overridevirtual

Returns color that is currently used.

Returns
The Color3B contains R,G,B bytes.

Reimplemented from NodeRGBA.

local getColor ( )
overridevirtual

Returns color that is currently used.

Returns
The Color3B contains R,G,B bytes.

Reimplemented from NodeRGBA.

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 ( ) const
overridevirtual

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 NodeRGBA.

var getOpacity ( )
overridevirtual

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 NodeRGBA.

local getOpacity ( )
overridevirtual

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 NodeRGBA.

virtual Size getOriginalSize ( void  )
virtual

getOriginalSize

var getOriginalSize (   )
virtual

getOriginalSize

local getOriginalSize (   )
virtual

getOriginalSize

virtual Size getPreferredSize ( void  )
virtual

getPreferredSize

var getPreferredSize (   )
virtual

getPreferredSize

local getPreferredSize (   )
virtual

getPreferredSize

virtual bool init ( )
virtual

Initializes the instance of Node.

Returns
Whether the initialization was successful.

Reimplemented from NodeRGBA.

var init ( )
virtual

Initializes the instance of Node.

Returns
Whether the initialization was successful.

Reimplemented from NodeRGBA.

local init ( )
virtual

Initializes the instance of Node.

Returns
Whether the initialization was successful.

Reimplemented from NodeRGBA.

virtual bool initWithBatchNode ( SpriteBatchNode batchnode,
Rect  rect,
bool  rotated,
Rect  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 ( SpriteBatchNode batchnode,
Rect  rect,
Rect  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,
Rect  rect,
Rect  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,
Rect  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 ( Rect  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 ( SpriteFrame spriteFrame,
Rect  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 ( SpriteFrame 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,
Rect  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  ) const
overridevirtual

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

Returns
Returns opacity modify flag.

Reimplemented from NodeRGBA.

var isOpacityModifyRGB (   )
overridevirtual

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

Returns
Returns opacity modify flag.

Reimplemented from NodeRGBA.

local isOpacityModifyRGB (   )
overridevirtual

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

Returns
Returns opacity modify flag.

Reimplemented from NodeRGBA.

Scale9Sprite*
resizableSpriteWithCapInsets
( Rect  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 ( Rect  var)
virtual

setCapInsets

var setCapInsets ( var  var)
virtual

setCapInsets

local setCapInsets ( local  var)
virtual

setCapInsets

virtual void setColor ( const Color3B color)
overridevirtual

Changes the color with R,G,B bytes.

Parameters
colorExample: Color3B(255,100,0) means R=255, G=100, B=0

Reimplemented from NodeRGBA.

var setColor ( var  color)
overridevirtual

Changes the color with R,G,B bytes.

Parameters
colorExample: Color3B(255,100,0) means R=255, G=100, B=0

Reimplemented from NodeRGBA.

local setColor ( local  color)
overridevirtual

Changes the color with R,G,B bytes.

Parameters
colorExample: Color3B(255,100,0) means R=255, G=100, B=0

Reimplemented from NodeRGBA.

virtual void setContentSize ( const Size contentSize)
overridevirtual

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 Node.

var setContentSize ( var  contentSize)
overridevirtual

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 Node.

local setContentSize ( local  contentSize)
overridevirtual

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 Node.

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)
overridevirtual

Changes the opacity.

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

Reimplemented from NodeRGBA.

var setOpacity ( var  opacity)
overridevirtual

Changes the opacity.

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

Reimplemented from NodeRGBA.

local setOpacity ( local  opacity)
overridevirtual

Changes the opacity.

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

Reimplemented from NodeRGBA.

virtual void setOpacityModifyRGB ( bool  value)
overridevirtual

Changes the OpacityModifyRGB property.

If thie property is set to true, then the rendered color will be affected by opacity. Normally, r = r * opacity/255, g = g * opacity/255, b = b * opacity/255.

Parameters
valueIf true, then the opacity will be applied as: glColor(R,G,B,opacity); If false, then the opacity will be applied as: glColor(opacity, opacity, opacity, opacity);

Reimplemented from NodeRGBA.

var setOpacityModifyRGB ( var  value)
overridevirtual

Changes the OpacityModifyRGB property.

If thie property is set to true, then the rendered color will be affected by opacity. Normally, r = r * opacity/255, g = g * opacity/255, b = b * opacity/255.

Parameters
valueIf true, then the opacity will be applied as: glColor(R,G,B,opacity); If false, then the opacity will be applied as: glColor(opacity, opacity, opacity, opacity);

Reimplemented from NodeRGBA.

local setOpacityModifyRGB ( local  value)
overridevirtual

Changes the OpacityModifyRGB property.

If thie property is set to true, then the rendered color will be affected by opacity. Normally, r = r * opacity/255, g = g * opacity/255, b = b * opacity/255.

Parameters
valueIf true, then the opacity will be applied as: glColor(R,G,B,opacity); If false, then the opacity will be applied as: glColor(opacity, opacity, opacity, opacity);

Reimplemented from NodeRGBA.

virtual void setPreferredSize ( Size  var)
virtual

setPreferredSize

var setPreferredSize ( var  var)
virtual

setPreferredSize

local setPreferredSize ( local  var)
virtual

setPreferredSize

virtual void setSpriteFrame ( SpriteFrame 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 Color3B color)
overridevirtual

recursive method that updates display color

Reimplemented from NodeRGBA.

var updateDisplayedColor ( var  color)
overridevirtual

recursive method that updates display color

Reimplemented from NodeRGBA.

local updateDisplayedColor ( local  color)
overridevirtual

recursive method that updates display color

Reimplemented from NodeRGBA.

virtual void updateDisplayedOpacity ( GLubyte  opacity)
overridevirtual

recursive method that updates the displayed opacity.

Reimplemented from NodeRGBA.

var updateDisplayedOpacity ( var  opacity)
overridevirtual

recursive method that updates the displayed opacity.

Reimplemented from NodeRGBA.

local updateDisplayedOpacity ( local  opacity)
overridevirtual

recursive method that updates the displayed opacity.

Reimplemented from NodeRGBA.

void updatePositions ( )
protected
var updatePositions ( )
protected
local updatePositions ( )
protected
virtual bool updateWithBatchNode ( SpriteBatchNode batchnode,
Rect  rect,
bool  rotated,
Rect  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 ( )
overridevirtual

Visits this node's children and draw them recursively.

Reimplemented from Node.

Member Data Documentation

Sprite* _bottom
protected
var _bottom
protected
local _bottom
protected
Sprite* _bottomLeft
protected
var _bottomLeft
protected
local _bottomLeft
protected
Sprite* _bottomRight
protected
var _bottomRight
protected
local _bottomRight
protected
Rect _capInsets
protected

The end-cap insets.

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

var _capInsets
protected

The end-cap insets.

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

local _capInsets
protected

The end-cap insets.

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

Rect _capInsetsInternal
protected
var _capInsetsInternal
protected
local _capInsetsInternal
protected
Sprite* _centre
protected
var _centre
protected
local _centre
protected
float _insetBottom
protected

Sets the bottom side inset.

var _insetBottom
protected

Sets the bottom side inset.

local _insetBottom
protected

Sets the bottom side inset.

float _insetLeft
protected

Sets the left side inset.

var _insetLeft
protected

Sets the left side inset.

local _insetLeft
protected

Sets the left side inset.

float _insetRight
protected

Sets the right side inset.

var _insetRight
protected

Sets the right side inset.

local _insetRight
protected

Sets the right side inset.

float _insetTop
protected

Sets the top side inset.

var _insetTop
protected

Sets the top side inset.

local _insetTop
protected

Sets the top side inset.

Sprite* _left
protected
var _left
protected
local _left
protected
bool _opacityModifyRGB
protected
var _opacityModifyRGB
protected
local _opacityModifyRGB
protected
Size _originalSize
protected

Original sprite's size.

var _originalSize
protected

Original sprite's size.

local _originalSize
protected

Original sprite's size.

bool _positionsAreDirty
protected
var _positionsAreDirty
protected
local _positionsAreDirty
protected
Size _preferredSize
protected

Prefered sprite's size.

By default the prefered size is the original size.

var _preferredSize
protected

Prefered sprite's size.

By default the prefered size is the original size.

local _preferredSize
protected

Prefered sprite's size.

By default the prefered size is the original size.

Sprite* _right
protected
var _right
protected
local _right
protected
SpriteBatchNode* _scale9Image
protected
var _scale9Image
protected
local _scale9Image
protected
bool _spriteFrameRotated
protected
var _spriteFrameRotated
protected
local _spriteFrameRotated
protected
Rect _spriteRect
protected
var _spriteRect
protected
local _spriteRect
protected
bool _spritesGenerated
protected
Sprite* _top
protected
var _top
protected
local _top
protected
Sprite* _topLeft
protected
var _topLeft
protected
local _topLeft
protected
Sprite* _topRight
protected
var _topRight
protected
local _topRight
protected

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