cocos2d-x  2.2.3-gd2.113-rev1ec524e
Loading...
Searching...
No Matches
CCScale9Sprite Class Reference

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

#include <CCScale9Sprite.h>

Inheritance diagram for CCScale9Sprite:
[legend]
Collaboration diagram for CCScale9Sprite:
[legend]

Public Member Functions

 CCScale9Sprite ()
 
virtual ~CCScale9Sprite ()
 
virtual CCSize getOriginalSize (void)
 
virtual CCSize getPreferredSize (void)
 
virtual void setPreferredSize (CCSize var)
 
virtual CCRect getCapInsets (void)
 
virtual void setCapInsets (CCRect var)
 
virtual float getInsetLeft (void)
 
virtual void setInsetLeft (float var)
 
virtual float getInsetTop (void)
 
virtual void setInsetTop (float var)
 
virtual float getInsetRight (void)
 
virtual void setInsetRight (float var)
 
virtual float getInsetBottom (void)
 
virtual void setInsetBottom (float var)
 
virtual void setContentSize (const CCSize &size)
 Sets the untransformed size of the node. More...
 
virtual void visit ()
 NA. 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)
 
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...
 
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...
 
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...
 
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)
 Changes the color with R,G,B bytes. More...
 
virtual const ccColor3BgetColor ()
 Returns color that is currently used. More...
 
virtual bool updateWithBatchNode (CCSpriteBatchNode *batchnode, CCRect rect, bool rotated, CCRect capInsets)
 
virtual void setSpriteFrame (CCSpriteFrame *spriteFrame)
 
virtual void updateDisplayedOpacity (GLubyte parentOpacity)
 recursive method that updates the displayed opacity. More...
 
virtual void updateDisplayedColor (const cocos2d::ccColor3B &parentColor)
 
- Public Member Functions inherited from CCNodeRGBA
 CCNodeRGBA ()
 ctor More...
 
virtual ~CCNodeRGBA ()
 NA NA. More...
 
virtual bool init ()
 Initializes the instance of CCNode. More...
 
virtual GLubyte getOpacity ()
 Returns the opacity. More...
 
virtual GLubyte getDisplayedOpacity ()
 Returns the displayed opacity. More...
 
virtual void setOpacity (GLubyte opacity)
 Changes the opacity. More...
 
virtual void updateDisplayedOpacity (GLubyte parentOpacity)
 recursive method that updates 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 ccColor3BgetColor (void)
 Returns color that is currently used. More...
 
virtual const ccColor3BgetDisplayedColor ()
 Returns the displayed color. More...
 
virtual void setColor (const ccColor3B &color)
 Changes the color with R,G,B bytes. 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)
 
virtual void setOpacityModifyRGB (bool bValue)
 Changes the OpacityModifyRGB property. More...
 
virtual bool isOpacityModifyRGB ()
 Returns whether or not the opacity will be applied using glColor(R,G,B,opacity) or glColor(opacity, opacity, opacity, opacity) More...
 
- Public Member Functions inherited from CCNode
virtual ~CCNode (void)
 Default destructor NA NA. More...
 
virtual bool init ()
 Initializes the instance of CCNode. More...
 
const char * description (void)
 Gets the description string. More...
 
virtual void setVisible (bool 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...
 
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...
 
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...
 
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...
 
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...
 
virtual ccGLServerState 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...
 
virtual bool isIgnoreAnchorPointForPosition ()
 Gets whether the anchor point will be (0,0) when you position this 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...
 
virtual void removeChildByTag (int 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...
 
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 CCCameragetCamera ()
 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...
 
virtual void cleanup (void)
 Stops all running actions and schedulers. More...
 
virtual void draw (void)
 Override this method to draw your own node. More...
 
virtual void visit (void)
 Visits this node's children and draw them recursively. More...
 
CCRect boundingBox (void)
 Returns a "local" axis aligned bounding box of the node. More...
 
virtual CCAffineTransform nodeToWorldTransform (void)
 Returns the world affine transform matrix. More...
 
virtual CCAffineTransform worldToNodeTransform (void)
 Returns the inverse world affine transform matrix. More...
 
 CCNode (void)
 Default constructor ctor. More...
 
 CCNode (const CCNode &)
 
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...
 
virtual int getZOrder ()
 Gets the Z order of this node. More...
 
virtual void setVertexZ (float vertexZ)
 Sets the real OpenGL Z vertex. More...
 
virtual float 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...
 
virtual float 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...
 
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...
 
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...
 
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...
 
virtual void setPosition (float x, float 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...
 
virtual void setPositionX (float x)
 Gets/Sets x or y coordinate individually for position. More...
 
virtual float getPositionX (void)
 Sets the Z order which stands for the drawing order, and reorder this node in its parent's children array. More...
 
virtual void setPositionY (float y)
 Sets the Z order which stands for the drawing order, and reorder this node in its parent's children array. More...
 
virtual float getPositionY (void)
 Sets the Z order which stands for the drawing order, and reorder this node in its parent's children array. More...
 
virtual void setSkewX (float 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...
 
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...
 
virtual const CCPointgetAnchorPoint ()
 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...
 
virtual CCSize getScaledContentSize (void)
 
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...
 
virtual void addChild (CCNode *child, int zOrder, int 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...
 
virtual unsigned int getChildrenCount (void) const
 Get the amount of children. More...
 
virtual void setParent (CCNode *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...
 
virtual void removeMeAndCleanup (void)
 
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...
 
virtual void * getUserData ()
 Returns a tag that is used to identify the node easily. More...
 
virtual void setUserData (void *pUserData)
 Sets a custom user data pointer. More...
 
virtual CCObjectgetUserObject ()
 Returns a user assigned CCObject. More...
 
virtual void setUserObject (CCObject *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...
 
virtual void registerScriptHandler (int 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...
 
int getScriptHandler ()
 Gets script handler for onEnter/onExit event. More...
 
void scheduleUpdateWithPriorityLua (int nHandler, int 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...
 
virtual CCActionManagergetActionManager ()
 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...
 
void stopAllActions (void)
 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...
 
void stopActionByTag (int 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...
 
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...
 
virtual void setScheduler (CCScheduler *scheduler)
 Sets a CCScheduler object that is used to schedule all "updates" and timers. More...
 
virtual CCSchedulergetScheduler ()
 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)
 Sets a CCScheduler object that is used to schedule all "updates" and timers. More...
 
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...
 
void pauseSchedulerAndActions (void)
 Pauses all scheduled selectors and actions. More...
 
virtual void update (float delta)
 Sets a CCScheduler object that is used to schedule all "updates" and timers. More...
 
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...
 
virtual void updateTransform (void)
 Calls children's updateTransform() method recursively. More...
 
virtual const CCAffineTransform nodeToParentTransform (void)
 Returns the matrix that transform the node's (local) space coordinates into the parent's space coordinates. More...
 
virtual const CCAffineTransform parentToNodeTransform (void)
 Returns the matrix that transform parent's space coordinates to the node's (local) space coordinates. More...
 
CCPoint convertToNodeSpace (const CCPoint &worldPoint)
 Converts a Point to node (local) space coordinates. More...
 
CCPoint convertToWorldSpace (const CCPoint &nodePoint)
 Converts a Point to world space coordinates. More...
 
CCPoint convertToNodeSpaceAR (const CCPoint &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...
 
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...
 
void setAdditionalTransform (const CCAffineTransform &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...
 
virtual bool removeComponent (CCComponent *pComponent)
 removes a component by its pointer
More...
 
virtual void removeAllComponents ()
 removes all components More...
 
virtual void updateTweenAction (float, const char *)
 
CCNodeoperator= (const CCNode &)
 
- Public Member Functions inherited from CCObject
 CCObject (void)
 
virtual ~CCObject (void)
 NA. More...
 
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)
 
virtual void update (float dt)
 
 CCObject (const CCObject &)
 
CCObjectoperator= (const CCObject &)
 
virtual void encodeWithCoder (DS_Dictionary *)
 
virtual bool canEncode ()
 
CCObjectType getObjType () const
 
virtual int getTag () const
 
virtual void setTag (int nTag)
 
void setObjType (CCObjectType)
 
- Public Member Functions inherited from CCCopying
virtual CCObjectcopyWithZone (CCZone *pZone)
 
virtual void setColor (const ccColor3B &color)=0
 Changes the color with R,G,B bytes. More...
 
virtual const ccColor3BgetColor (void)=0
 Returns color that is currently used. More...
 
virtual const ccColor3BgetDisplayedColor (void)=0
 Returns the displayed color. More...
 
virtual GLubyte getDisplayedOpacity (void)=0
 Returns the displayed opacity. More...
 
virtual GLubyte getOpacity (void)=0
 Returns the opacity. More...
 
virtual void setOpacity (GLubyte opacity)=0
 Changes the opacity. More...
 
virtual void setOpacityModifyRGB (bool bValue)=0
 Changes the OpacityModifyRGB property. More...
 
virtual bool isOpacityModifyRGB (void)=0
 Returns whether or not the opacity will be applied using glColor(R,G,B,opacity) or glColor(opacity, opacity, opacity, opacity) More...
 
virtual bool isCascadeColorEnabled (void)=0
 whether or not color should be propagated to its children. More...
 
virtual void setCascadeColorEnabled (bool cascadeColorEnabled)=0
 
virtual void updateDisplayedColor (const ccColor3B &color)=0
 recursive method that updates display color More...
 
virtual bool isCascadeOpacityEnabled (void)=0
 whether or not opacity should be propagated to its children. More...
 
virtual void setCascadeOpacityEnabled (bool cascadeOpacityEnabled)=0
 
virtual void updateDisplayedOpacity (GLubyte opacity)=0
 recursive method that updates the displayed opacity. More...
 

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...
 
static CCScale9Spritecreate (const char *file, CCRect 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...
 
static CCScale9SpritecreateWithSpriteFrame (CCSpriteFrame *spriteFrame, CCRect 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...
 
static CCScale9SpritecreateWithSpriteFrameName (const char *spriteFrameName, CCRect 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...
 
static CCScale9Spritecreate ()
 
- 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...
 
- Static Public Member Functions inherited from CCObject
static CCObjectcreateWithCoder (DS_Dictionary *)
 

Protected Member Functions

void updateCapInset ()
 
void updatePositions ()
 

Protected Attributes

CCSize m_originalSize
 Original sprite's size. More...
 
CCSize m_preferredSize
 Prefered sprite's size. More...
 
CCRect 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...
 
float m_insetBottom
 Sets the bottom side inset. More...
 
bool m_bSpritesGenerated
 
CCRect m_spriteRect
 
bool m_bSpriteFrameRotated
 
CCRect m_capInsetsInternal
 
bool m_positionsAreDirty
 
CCSpriteBatchNode_scale9Image
 
CCSprite_topLeft
 
CCSprite_top
 
CCSprite_topRight
 
CCSprite_left
 
CCSprite_centre
 
CCSprite_right
 
CCSprite_bottomLeft
 
CCSprite_bottom
 
CCSprite_bottomRight
 
bool _opacityModifyRGB
 
GLubyte _opacity
 
ccColor3B _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...
 
float m_fScaleX
 scaling factor on x-axis More...
 
float m_fScaleY
 scaling factor on y-axis More...
 
float m_fVertexZ
 OpenGL real Z vertex. More...
 
CCPoint m_obPosition
 position of the node More...
 
float m_fSkewX
 skew angle on x-axis More...
 
float m_fSkewY
 skew angle on y-axis More...
 
CCPoint m_obAnchorPointInPoints
 anchor point in points More...
 
CCPoint m_obAnchorPoint
 anchor point normalized (NOT in points) More...
 
CCSize m_obContentSize
 untransformed size of the node More...
 
CCAffineTransform m_sAdditionalTransform
 transform More...
 
CCAffineTransform m_sTransform
 transform More...
 
CCAffineTransform m_sInverse
 transform More...
 
CCCameram_pCamera
 a camera More...
 
CCGridBasem_pGrid
 a grid More...
 
int m_nZOrder
 z-order value that affects the draw order More...
 
CCArraym_pChildren
 array of children nodes More...
 
CCNodem_pParent
 weak reference to parent node More...
 
void * m_pUserData
 A user assingned void pointer, Can be point to any cpp object. More...
 
CCObjectm_pUserObject
 A user assigned CCObject. More...
 
CCGLProgramm_pShaderProgram
 OpenGL shader. More...
 
ccGLServerState m_eGLServerState
 OpenGL servier side state. More...
 
unsigned int m_uOrderOfArrival
 used to preserve sequence while sorting children with the same zOrder More...
 
CCSchedulerm_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...
 
bool m_bTransformDirty
 transform dirty flag More...
 
bool m_bInverseDirty
 transform dirty flag More...
 
bool m_bAdditionalTransformDirty
 The flag to check whether the additional transform is dirty. More...
 
bool 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...
 
bool m_bReorderChildDirty
 children order dirty flag More...
 
int 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...
 
ccScriptType 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
 
int m_nTag
 
int m_eObjType
 
unsigned int m_uObjectIdxInArray
 

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

◆ CCScale9Sprite()

◆ ~CCScale9Sprite()

virtual ~CCScale9Sprite ( )
virtual

Member Function Documentation

◆ create() [1/5]

static CCScale9Sprite * create ( )
static

◆ create() [2/5]

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:

◆ create() [3/5]

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:

◆ create() [4/5]

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:

◆ create() [5/5]

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:

◆ createWithSpriteFrame() [1/2]

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:

◆ createWithSpriteFrame() [2/2]

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:

◆ createWithSpriteFrameName() [1/2]

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:

◆ createWithSpriteFrameName() [2/2]

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:

◆ getCapInsets()

virtual CCRect getCapInsets ( void  )
virtual

◆ getColor()

virtual const ccColor3B & getColor ( )
virtual

Returns color that is currently used.

Returns
The ccColor3B contains R,G,B bytes.

Reimplemented from CCNodeRGBA.

◆ getInsetBottom()

virtual float getInsetBottom ( void  )
virtual

◆ getInsetLeft()

virtual float getInsetLeft ( void  )
virtual

◆ getInsetRight()

virtual float getInsetRight ( void  )
virtual

◆ getInsetTop()

virtual float getInsetTop ( void  )
virtual

◆ getOpacity()

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.

◆ getOriginalSize()

virtual CCSize getOriginalSize ( void  )
virtual

◆ getPreferredSize()

virtual CCSize getPreferredSize ( void  )
virtual

◆ init()

virtual bool init ( )
virtual

Initializes the instance of CCNode.

Returns
Whether the initialization was successful.

Reimplemented from CCNodeRGBA.

◆ initWithBatchNode() [1/2]

virtual bool initWithBatchNode ( CCSpriteBatchNode batchnode,
CCRect  rect,
bool  rotated,
CCRect  capInsets 
)
virtual

◆ initWithBatchNode() [2/2]

virtual bool initWithBatchNode ( CCSpriteBatchNode batchnode,
CCRect  rect,
CCRect  capInsets 
)
virtual

◆ initWithFile() [1/4]

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.

◆ initWithFile() [2/4]

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.

◆ initWithFile() [3/4]

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.

◆ initWithFile() [4/4]

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.

◆ initWithSpriteFrame() [1/2]

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.

◆ initWithSpriteFrame() [2/2]

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.

◆ initWithSpriteFrameName() [1/2]

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.

◆ initWithSpriteFrameName() [2/2]

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.

◆ isOpacityModifyRGB()

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.

◆ resizableSpriteWithCapInsets()

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.

◆ setCapInsets()

virtual void setCapInsets ( CCRect  var)
virtual

◆ setColor()

virtual void setColor ( const ccColor3B color)
virtual

Changes the color with R,G,B bytes.

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

Reimplemented from CCNodeRGBA.

◆ setContentSize()

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.

◆ setInsetBottom()

virtual void setInsetBottom ( float  var)
virtual

◆ setInsetLeft()

virtual void setInsetLeft ( float  var)
virtual

◆ setInsetRight()

virtual void setInsetRight ( float  var)
virtual

◆ setInsetTop()

virtual void setInsetTop ( float  var)
virtual

◆ setOpacity()

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.

◆ setOpacityModifyRGB()

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.

◆ setPreferredSize()

virtual void setPreferredSize ( CCSize  var)
virtual

◆ setSpriteFrame()

virtual void setSpriteFrame ( CCSpriteFrame spriteFrame)
virtual

◆ updateCapInset()

void updateCapInset ( )
protected

◆ updateDisplayedColor()

virtual void updateDisplayedColor ( const cocos2d::ccColor3B &  parentColor)
virtual

◆ updateDisplayedOpacity()

virtual void updateDisplayedOpacity ( GLubyte  opacity)
virtual

recursive method that updates the displayed opacity.

Reimplemented from CCNodeRGBA.

◆ updatePositions()

void updatePositions ( )
protected

◆ updateWithBatchNode()

virtual bool updateWithBatchNode ( CCSpriteBatchNode batchnode,
CCRect  rect,
bool  rotated,
CCRect  capInsets 
)
virtual

◆ visit()

virtual void visit ( )
virtual

NA.

Reimplemented from CCNode.

Member Data Documentation

◆ _bottom

CCSprite* _bottom
protected

◆ _bottomLeft

CCSprite* _bottomLeft
protected

◆ _bottomRight

CCSprite* _bottomRight
protected

◆ _centre

CCSprite* _centre
protected

◆ _color

ccColor3B _color
protected

◆ _left

CCSprite* _left
protected

◆ _opacity

GLubyte _opacity
protected

◆ _opacityModifyRGB

bool _opacityModifyRGB
protected

◆ _right

CCSprite* _right
protected

◆ _scale9Image

CCSpriteBatchNode* _scale9Image
protected

◆ _top

CCSprite* _top
protected

◆ _topLeft

CCSprite* _topLeft
protected

◆ _topRight

CCSprite* _topRight
protected

◆ m_bSpriteFrameRotated

bool m_bSpriteFrameRotated
protected

◆ m_bSpritesGenerated

bool m_bSpritesGenerated
protected

◆ m_capInsets

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.

◆ m_capInsetsInternal

CCRect m_capInsetsInternal
protected

◆ m_insetBottom

float m_insetBottom
protected

Sets the bottom side inset.

◆ m_insetLeft

float m_insetLeft
protected

Sets the left side inset.

◆ m_insetRight

float m_insetRight
protected

Sets the right side inset.

◆ m_insetTop

float m_insetTop
protected

Sets the top side inset.

◆ m_originalSize

CCSize m_originalSize
protected

Original sprite's size.

◆ m_positionsAreDirty

bool m_positionsAreDirty
protected

◆ m_preferredSize

CCSize m_preferredSize
protected

Prefered sprite's size.

By default the prefered size is the original size.

◆ m_spriteRect

CCRect m_spriteRect
protected

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