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

Inherits Sprite.

Public Types
enum	State
	Builtin shader state. More...

Public Member Functions
	Scale9Sprite ()
	Default constructor.

	ctor ()
	Default constructor.

	new ()
	Default constructor.

virtual	~Scale9Sprite ()
	Default destructor.

virtual bool	initWithFile (const std::string &file, const Rect &rect, const Rect &capInsets)
	Initializes a 9-slice sprite with a texture file, a delimitation zone and with the specified cap insets. More...

virtual bool	initWithFile (const Rect &capInsets, const std::string &file)
	Initializes a 9-slice sprite with a texture file and with the specified cap insets. More...

virtual bool	initWithSpriteFrame (SpriteFrame *spriteFrame, const Rect &capInsets)
	Initializes a 9-slice sprite with an sprite frame and with the specified cap insets. More...

virtual bool	initWithSpriteFrameName (const std::string &spriteFrameName, const Rect &capInsets)
	Initializes a 9-slice sprite with an sprite frame name and with the specified cap insets. More...

var	initWithSpriteFrameName ( var spriteFrameName, var capInsets)
	Initializes a 9-slice sprite with an sprite frame name and with the specified cap insets. More...

local	initWithSpriteFrameName ( local spriteFrameName, local capInsets)
	Initializes a 9-slice sprite with an sprite frame name and with the specified cap insets. More...

virtual bool	initWithFile (const std::string &file, const Rect &rect) override
	Initializes a 9-slice sprite with a texture file and a delimitation zone. More...

virtual bool	initWithFile (const std::string &file) override
	Initializes a 9-slice sprite with a texture file. More...

virtual bool	initWithSpriteFrameName (const std::string &spriteFrameName) override
	Initializes a 9-slice sprite with an sprite frame name. More...

virtual bool	init (Sprite *sprite, const Rect &rect, bool rotated, const Rect &capInsets)
	Initializes a 9-slice sprite with an sprite instance. More...

var	init ( var sprite, var rect, var rotated, var capInsets)
	Initializes a 9-slice sprite with an sprite instance. More...

local	init ( local sprite, local rect, local rotated, local capInsets)
	Initializes a 9-slice sprite with an sprite instance. More...

virtual bool	init (Sprite *sprite, const Rect &rect, const Rect &capInsets)
	Initializes a 9-slice sprite with an sprite instance. More...

virtual bool	init (Sprite *sprite, const Rect &rect, bool rotated, const Vec2 &offset, const Size &originalSize, const Rect &capInsets)
	Initializes a 9-slice sprite with an sprite instance. More...

	CC_DEPRECATED (v3) virtual bool initWithBatchNode(SpriteBatchNode *batchnode
	Initializes a 9-slice sprite with a sprite batchnode. More...

	CC_DEPRECATED (v3) virtual bool initWithBatchNode(SpriteBatchNode *batchnode
	Initializes a 9-slice sprite with a sprite batch node. More...

	CC_DEPRECATED ( local v3)
	Initializes a 9-slice sprite with a sprite batch node. More...

Scale9Sprite *	resizableSpriteWithCapInsets (const Rect &capInsets) const
	Creates and returns a new sprite object with the specified cap insets. More...

var	resizableSpriteWithCapInsets ( var capInsets)
	Creates and returns a new sprite object with the specified cap insets. More...

virtual bool	updateWithSprite (Sprite *sprite, const Rect &rect, bool rotated, const Rect &capInsets)
	Update Scale9Sprite with a specified sprite. More...

virtual bool	updateWithSprite (Sprite *sprite, const Rect &rect, bool rotated, const Vec2 &offset, const Size &originalSize, const Rect &capInsets)
	Update Scale9Sprite with a specified sprite. More...

local	updateWithSprite ( local sprite, local rect, local rotated, local offset, local originalSize, local capInsets)
	Update Scale9Sprite with a specified sprite. More...

	CC_DEPRECATED (v3) bool updateWithBatchNode(SpriteBatchNode *batchnode
	Update Scale9Sprite with a specified sprite. More...

virtual void	setSpriteFrame (SpriteFrame *spriteFrame, const Rect &capInsets)
	Change inner sprite's sprite frame. More...

void	setState (State state)
	Change the state of 9-slice sprite. More...

var	setState ( var state)
	Change the state of 9-slice sprite. More...

local	setState ( local state)
	Change the state of 9-slice sprite. More...

State	getState () const
	Query the current bright state. More...

Size	getOriginalSize () const
	Query the sprite's original size. More...

local	getOriginalSize ()
	Query the sprite's original size. More...

void	setPreferredSize (const Size &size)
	Change the preferred size of Scale9Sprite. More...

var	setPreferredSize ( var size)
	Change the preferred size of Scale9Sprite. More...

local	setPreferredSize ( local size)
	Change the preferred size of Scale9Sprite. More...

Size	getPreferredSize () const
	Query the Scale9Sprite's preferred size. More...

void	setInsetLeft (float leftInset)
	Change the left sprite's cap inset. More...

var	setInsetLeft ( var leftInset)
	Change the left sprite's cap inset. More...

local	setInsetLeft ( local leftInset)
	Change the left sprite's cap inset. More...

float	getInsetLeft () const
	Query the left sprite's cap inset. More...

var	getInsetLeft ()
	Query the left sprite's cap inset. More...

local	getInsetLeft ()
	Query the left sprite's cap inset. More...

void	setInsetTop (float topInset)
	Change the top sprite's cap inset. More...

var	setInsetTop ( var topInset)
	Change the top sprite's cap inset. More...

local	setInsetTop ( local topInset)
	Change the top sprite's cap inset. More...

float	getInsetTop () const
	Query the top sprite's cap inset. More...

void	setInsetRight (float rightInset)
	Change the right sprite's cap inset. More...

var	setInsetRight ( var rightInset)
	Change the right sprite's cap inset. More...

local	setInsetRight ( local rightInset)
	Change the right sprite's cap inset. More...

float	getInsetRight () const
	Query the right sprite's cap inset. More...

var	getInsetRight ()
	Query the right sprite's cap inset. More...

local	getInsetRight ()
	Query the right sprite's cap inset. More...

void	setInsetBottom (float bottomInset)
	Change the bottom sprite's cap inset. More...

var	setInsetBottom ( var bottomInset)
	Change the bottom sprite's cap inset. More...

local	setInsetBottom ( local bottomInset)
	Change the bottom sprite's cap inset. More...

float	getInsetBottom () const
	Query the bottom sprite's cap inset. More...

void	setScale9Enabled (bool enabled)
	Toggle 9-slice feature. More...

local	setScale9Enabled ( local enabled)
	Toggle 9-slice feature. More...

bool	isScale9Enabled () const
	Query whether the Scale9Sprite is enable 9-slice or not. More...

local	isScale9Enabled ()
	Query whether the Scale9Sprite is enable 9-slice or not. More...

Sprite *	getSprite ()
	Get the original no 9-sliced sprite. More...

local	getSprite ()
	Get the original no 9-sliced sprite. More...

void	copyTo (Scale9Sprite *copy) const
	copies self to copy

local	copyTo ( local copy)
	copies self to copy

void	setRenderingType (RenderingType type)
	Set the slice sprite rendering type. More...

local	setRenderingType ( local type)
	Set the slice sprite rendering type. More...

RenderingType	getRenderingType () const
	Return the slice sprite rendering type.

var	getRenderingType ()
	Return the slice sprite rendering type.

local	getRenderingType ()
	Return the slice sprite rendering type.

void	setCapInsets (const Rect &insets)
	Set the Cap Insets in Points using the untrimmed size as reference.

Rect	getCapInsets () const
	Returns the Cap Insets.

Public Member Functions inherited from Sprite
virtual void	setDisplayFrame (SpriteFrame *newFrame)
local	setDisplayFrame ( local newFrame)
virtual bool	isFrameDisplayed (SpriteFrame *frame) const
	Returns whether or not a SpriteFrame is being displayed.

local	isFrameDisplayed ( local frame)
	Returns whether or not a SpriteFrame is being displayed.

virtual SpriteFrame *	getSpriteFrame () const
	Returns the current displayed frame.

virtual SpriteFrame *	getDisplayFrame () const
local	getDisplayFrame ()
virtual SpriteFrame *	displayFrame () const
var	displayFrame ()
local	displayFrame ()
bool	isFlipY ()
local	isFlipY ()
void	setFlipY (bool flippedY)
local	setFlipY ( local flippedY)
const PolygonInfo &	getPolygonInfo () const
	returns a reference of the polygon information associated with this sprite More...

void	setPolygonInfo (const PolygonInfo &info)
	set the sprite to use this new PolygonInfo More...

var	setPolygonInfo ( var info)
	set the sprite to use this new PolygonInfo More...

local	setPolygonInfo ( local info)
	set the sprite to use this new PolygonInfo More...

void	setStretchEnabled (bool enabled)
	whether or not contentSize stretches the sprite's texture

void	setStrechEnabled (bool enabled)
var	setStrechEnabled ( var enabled)
local	setStrechEnabled ( local enabled)
bool	isStretchEnabled () const
	returns whether or not contentSize stretches the sprite's texture

bool	isStrechEnabled () const
var	isStrechEnabled ()
local	isStrechEnabled ()
virtual std::string	getDescription () const override
	Gets the description string. More...

local	getDescription ()
	Gets the description string. More...

virtual void	updateTransform () override
	Updates the quad according the rotation, position, scale values.

virtual SpriteBatchNode *	getBatchNode () const
	Returns the batch node object if this sprite is rendered by SpriteBatchNode. More...

local	getBatchNode ()
	Returns the batch node object if this sprite is rendered by SpriteBatchNode. More...

virtual void	setBatchNode (SpriteBatchNode *spriteBatchNode)
	Sets the batch node to sprite. More...

local	setBatchNode ( local spriteBatchNode)
	Sets the batch node to sprite. More...

virtual void	setTexture (const std::string &filename)
	Sets a new texture (from a filename) to the sprite. More...

local	setTexture ( local filename)
	Sets a new texture (from a filename) to the sprite. More...

virtual void	setTexture (Texture2D *texture) override
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.The Texture's rect is not changed.

virtual Texture2D *	getTexture () const override
	Returns the Texture2D object used by the sprite. More...

virtual void	setTextureRect (const Rect &rect)
	Updates the texture rect of the Sprite in points. More...

local	setTextureRect ( local rect)
	Updates the texture rect of the Sprite in points. More...

virtual void	setTextureRect (const Rect &rect, bool rotated, const Size &untrimmedSize)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.It will update the texture coordinates and the vertex rectangle.

local	setTextureRect ( local rect, local rotated, local untrimmedSize)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.It will update the texture coordinates and the vertex rectangle.

virtual void	setVertexRect (const Rect &rect)
	Sets the vertex rect. More...

virtual void	setCenterRectNormalized (const Rect &rect)
	setCenterRectNormalized More...

local	setCenterRectNormalized ( local rect)
	setCenterRectNormalized More...

virtual Rect	getCenterRectNormalized () const
	getCenterRectNormalized More...

var	getCenterRectNormalized ()
	getCenterRectNormalized More...

local	getCenterRectNormalized ()
	getCenterRectNormalized More...

virtual void	setCenterRect (const Rect &rect)
var	setCenterRect ( var rect)
local	setCenterRect ( local rect)
virtual Rect	getCenterRect () const
	Returns the Cap Insets rect. More...

local	getCenterRect ()
	Returns the Cap Insets rect. More...

virtual void	setSpriteFrame (const std::string &spriteFrameName)
local	setSpriteFrame ( local spriteFrameName)
virtual void	setSpriteFrame (SpriteFrame *newFrame)
var	setSpriteFrame ( var newFrame)
local	setSpriteFrame ( local newFrame)
virtual void	setDisplayFrameWithAnimationName (const std::string &animationName, ssize_t frameIndex)
	Changes the display frame with animation name and index. More...

var	setDisplayFrameWithAnimationName ( var animationName, var frameIndex)
	Changes the display frame with animation name and index. More...

local	setDisplayFrameWithAnimationName ( local animationName, local frameIndex)
	Changes the display frame with animation name and index. More...

virtual bool	isDirty () const
	Whether or not the Sprite needs to be updated in the Atlas. More...

virtual void	setDirty (bool dirty)
	Makes the Sprite to be updated in the Atlas.

local	setDirty ( local dirty)
	Makes the Sprite to be updated in the Atlas.

V3F_C4B_T2F_Quad	getQuad () const
	Returns the quad (tex coords, vertex coords and color) information.

bool	isTextureRectRotated () const
	Returns whether or not the texture rectangle is rotated.

local	isTextureRectRotated ()
	Returns whether or not the texture rectangle is rotated.

ssize_t	getAtlasIndex () const
	Returns the index used on the TextureAtlas.

void	setAtlasIndex (ssize_t atlasIndex)
	Sets the index used on the TextureAtlas. More...

var	setAtlasIndex ( var atlasIndex)
	Sets the index used on the TextureAtlas. More...

local	setAtlasIndex ( local atlasIndex)
	Sets the index used on the TextureAtlas. More...

const Rect &	getTextureRect () const
	Returns the rect of the Sprite in points.

local	getTextureRect ()
	Returns the rect of the Sprite in points.

TextureAtlas *	getTextureAtlas () const
	Gets the weak reference of the TextureAtlas when the sprite is rendered using via SpriteBatchNode.

var	getTextureAtlas ()
	Gets the weak reference of the TextureAtlas when the sprite is rendered using via SpriteBatchNode.

local	getTextureAtlas ()
	Gets the weak reference of the TextureAtlas when the sprite is rendered using via SpriteBatchNode.

void	setTextureAtlas (TextureAtlas *textureAtlas)
	Sets the weak reference of the TextureAtlas when the sprite is rendered using via SpriteBatchNode.

var	setTextureAtlas ( var textureAtlas)
	Sets the weak reference of the TextureAtlas when the sprite is rendered using via SpriteBatchNode.

local	setTextureAtlas ( local textureAtlas)
	Sets the weak reference of the TextureAtlas when the sprite is rendered using via SpriteBatchNode.

const Vec2 &	getOffsetPosition () const
	Gets the offset position of the sprite. More...

bool	isFlippedX () const
	Returns the flag which indicates whether the sprite is flipped horizontally or not. More...

void	setFlippedX (bool flippedX)
	Sets whether the sprite should be flipped horizontally or not. More...

bool	isFlipX ()
void	setFlipX (bool flippedX)
local	setFlipX ( local flippedX)
bool	isFlippedY () const
	Return the flag which indicates whether the sprite is flipped vertically or not. More...

void	setFlippedY (bool flippedY)
	Sets whether the sprite should be flipped vertically or not. More...

void	setBlendFunc (const BlendFunc &blendFunc) override
var	setBlendFunc ( var blendFunc)
local	setBlendFunc ( local blendFunc)
const BlendFunc &	getBlendFunc () const override
virtual void	setScaleX (float scaleX) override
	Sets the scale (x) of the node. More...

var	setScaleX ( var scaleX)
	Sets the scale (x) of the node. More...

local	setScaleX ( local scaleX)
	Sets the scale (x) of the node. More...

virtual void	setScaleY (float scaleY) override
	Sets the scale (y) of the node. More...

local	setScaleY ( local scaleY)
	Sets the scale (y) of the node. More...

virtual void	setScale (float scaleX, float scaleY) override
	Sets the scale (x,y) of the node. More...

local	setScale ( local scaleX, local scaleY)
	Sets the scale (x,y) of the node. More...

virtual void	setPosition (const Vec2 &pos) override
	Sets the position (x,y) of the node in its parent's coordinate system. More...

virtual void	setPosition (float x, float y) override
	Sets the position (x,y) of the node in its parent's coordinate system. More...

local	setPosition ( local x, local y)
	Sets the position (x,y) of the node in its parent's coordinate system. More...

virtual void	setRotation (float rotation) override
	Sets the rotation (angle) of the node in degrees. More...

virtual void	setRotationSkewX (float rotationX) override
	Sets the X rotation (angle) of the node in degrees which performs a horizontal rotational skew. More...

local	setRotationSkewX ( local rotationX)
	Sets the X rotation (angle) of the node in degrees which performs a horizontal rotational skew. More...

virtual void	setRotationSkewY (float rotationY) override
	Sets the Y rotation (angle) of the node in degrees which performs a vertical rotational skew. More...

local	setRotationSkewY ( local rotationY)
	Sets the Y rotation (angle) of the node in degrees which performs a vertical rotational skew. More...

virtual void	setSkewX (float sx) override
	Changes the X skew angle of the node in degrees. More...

virtual void	setSkewY (float sy) override
	Changes the Y skew angle of the node in degrees. More...

var	setSkewY ( var sy)
	Changes the Y skew angle of the node in degrees. More...

local	setSkewY ( local sy)
	Changes the Y skew angle of the node in degrees. More...

virtual void	removeChild (Node *child, bool cleanup) override
	Removes a child from the container. More...

local	removeChild ( local child, local cleanup)
	Removes a child from the container. More...

virtual void	removeAllChildrenWithCleanup (bool cleanup) override
	Removes all children from the container, and do a cleanup to all running actions depending on the cleanup parameter. More...

local	removeAllChildrenWithCleanup ( 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) override
	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	addChild (Node *child, int zOrder, int tag) override
	Adds a child to the container with z order and tag. More...

local	addChild ( local child, local zOrder, local tag)
	Adds a child to the container with z order and tag. More...

virtual void	addChild (Node *child, int zOrder, const std::string &name) override
	Adds a child to the container with z order and tag. More...

local	addChild ( local child, local zOrder, local name)
	Adds a child to the container with z order and tag. More...

virtual void	sortAllChildren () override
	Sorts the children array once before drawing, instead of every time when a child is added or reordered. More...

var	sortAllChildren ()
	Sorts the children array once before drawing, instead of every time when a child is added or reordered. More...

local	sortAllChildren ()
	Sorts the children array once before drawing, instead of every time when a child is added or reordered. More...

virtual void	setScale (float scale) override
	Sets the scale (x,y,z) of the node. More...

local	setScale ( local scale)
	Sets the scale (x,y,z) of the node. More...

virtual void	setPositionZ (float positionZ) override
	Sets the 'z' coordinate in the position. More...

local	setPositionZ ( local positionZ)
	Sets the 'z' coordinate in the position. More...

virtual void	setAnchorPoint (const Vec2 &anchor) override
	Sets the anchor point in percent. More...

local	setAnchorPoint ( local anchor)
	Sets the anchor point in percent. More...

virtual void	setContentSize (const Size &size) override
	Sets the untransformed size of the node. More...

local	setContentSize ( local size)
	Sets the untransformed size of the node. More...

virtual void	setIgnoreAnchorPointForPosition (bool value) override
	Sets whether the anchor point will be (0,0) when you position this node. More...

local	setIgnoreAnchorPointForPosition ( local value)
	Sets whether the anchor point will be (0,0) when you position this node. More...

virtual void	setVisible (bool bVisible) override
	Sets whether the node is visible. More...

var	setVisible ( var bVisible)
	Sets whether the node is visible. More...

local	setVisible ( local bVisible)
	Sets whether the node is visible. More...

virtual void	draw (Renderer *renderer, const Mat4 &transform, uint32_t flags) override
	Override this method to draw your own node. More...

local	draw ( local renderer, local transform, local flags)
	Override this method to draw your own node. More...

virtual void	setOpacityModifyRGB (bool modify) override
	If you want the opacity affect the color property, then set to true. More...

var	setOpacityModifyRGB ( var modify)
	If you want the opacity affect the color property, then set to true. More...

local	setOpacityModifyRGB ( local modify)
	If you want the opacity affect the color property, then set to true. More...

virtual bool	isOpacityModifyRGB () const override
	If node opacity will modify the RGB color value, then you should override this method and return true. More...

var	isOpacityModifyRGB ()
	If node opacity will modify the RGB color value, then you should override this method and return true. More...

local	isOpacityModifyRGB ()
	If node opacity will modify the RGB color value, then you should override this method and return true. More...

static Sprite *	create ()
	Creates an empty sprite without texture. More...

Public Member Functions inherited from Node
virtual bool	isRunning () const
	Returns whether or not the node is "running". More...

var	isRunning ()
	Returns whether or not the node is "running". More...

local	isRunning ()
	Returns whether or not the node is "running". More...

void	scheduleUpdateWithPriorityLua (int handler, int priority)
	Schedules for lua script. More...

virtual void	cleanup ()
	Stops all running actions and schedulers.

virtual void	visit (Renderer *renderer, const Mat4 &parentTransform, uint32_t parentFlags)
	Visits this node's children and draw them recursively. More...

var	visit ( var renderer, var parentTransform, var parentFlags)
	Visits this node's children and draw them recursively. More...

virtual Scene *	getScene () const
	Returns the Scene that contains the Node. More...

local	getScene ()
	Returns the Scene that contains the Node. More...

virtual Rect	getBoundingBox () const
	Returns an AABB (axis-aligned bounding-box) in its parent's coordinate system. More...

virtual Rect	boundingBox () const
local	boundingBox ()
virtual void	setEventDispatcher (EventDispatcher *dispatcher)
	Set event dispatcher for scene. More...

var	setEventDispatcher ( var dispatcher)
	Set event dispatcher for scene. More...

local	setEventDispatcher ( local dispatcher)
	Set event dispatcher for scene. More...

virtual EventDispatcher *	getEventDispatcher () const
	Get the event dispatcher of scene. More...

local	getEventDispatcher ()
	Get the event dispatcher of scene. More...

virtual GLubyte	getOpacity () const
	Return the node's opacity. More...

local	getOpacity ()
	Return the node's opacity. More...

virtual GLubyte	getDisplayedOpacity () const
	Return the node's display opacity. More...

local	getDisplayedOpacity ()
	Return the node's display opacity. More...

virtual void	setOpacity (GLubyte opacity)
	Change node opacity. More...

virtual void	updateDisplayedOpacity (GLubyte parentOpacity)
	Update the displayed opacity of node with it's parent opacity;. More...

virtual bool	isCascadeOpacityEnabled () const
	Whether cascadeOpacity is enabled or not. More...

var	isCascadeOpacityEnabled ()
	Whether cascadeOpacity is enabled or not. More...

local	isCascadeOpacityEnabled ()
	Whether cascadeOpacity is enabled or not. More...

virtual void	setCascadeOpacityEnabled (bool cascadeOpacityEnabled)
	Change node's cascadeOpacity property. More...

local	setCascadeOpacityEnabled ( local cascadeOpacityEnabled)
	Change node's cascadeOpacity property. More...

virtual const Color3B &	getColor () const
	Query node's color value. More...

local	getColor ()
	Query node's color value. More...

virtual const Color3B &	getDisplayedColor () const
	Query node's displayed color. More...

local	getDisplayedColor ()
	Query node's displayed color. More...

virtual void	setColor (const Color3B &color)
	Change the color of node. More...

var	setColor ( var color)
	Change the color of node. More...

local	setColor ( local color)
	Change the color of node. More...

virtual void	updateDisplayedColor (const Color3B &parentColor)
	Update node's displayed color with its parent color. More...

local	updateDisplayedColor ( local parentColor)
	Update node's displayed color with its parent color. More...

virtual bool	isCascadeColorEnabled () const
	Query whether cascadeColor is enabled or not. More...

var	isCascadeColorEnabled ()
	Query whether cascadeColor is enabled or not. More...

local	isCascadeColorEnabled ()
	Query whether cascadeColor is enabled or not. More...

virtual void	setCascadeColorEnabled (bool cascadeColorEnabled)
	If you want node's color affect the children node's color, then set it to true. More...

void	setOnEnterCallback (const std::function< void()> &callback)
	Set the callback of event onEnter. More...

const std::function< void()> &	getOnEnterCallback () const
	Get the callback of event onEnter. More...

void	setOnExitCallback (const std::function< void()> &callback)
	Set the callback of event onExit. More...

var	setOnExitCallback ( var callback)
	Set the callback of event onExit. More...

local	setOnExitCallback ( local callback)
	Set the callback of event onExit. More...

const std::function< void()> &	getOnExitCallback () const
	Get the callback of event onExit. More...

local	getOnExitCallback ()
	Get the callback of event onExit. More...

void	setonEnterTransitionDidFinishCallback (const std::function< void()> &callback)
	Set the callback of event EnterTransitionDidFinish. More...

var	setonEnterTransitionDidFinishCallback ( var callback)
	Set the callback of event EnterTransitionDidFinish. More...

local	setonEnterTransitionDidFinishCallback ( local callback)
	Set the callback of event EnterTransitionDidFinish. More...

const std::function< void()> &	getonEnterTransitionDidFinishCallback () const
	Get the callback of event EnterTransitionDidFinish. More...

void	setonExitTransitionDidStartCallback (const std::function< void()> &callback)
	Set the callback of event ExitTransitionDidStart. More...

var	setonExitTransitionDidStartCallback ( var callback)
	Set the callback of event ExitTransitionDidStart. More...

local	setonExitTransitionDidStartCallback ( local callback)
	Set the callback of event ExitTransitionDidStart. More...

const std::function< void()> &	getonExitTransitionDidStartCallback () const
	Get the callback of event ExitTransitionDidStart. More...

unsigned short	getCameraMask () const
	get & set camera mask, the node is visible by the camera whose camera flag & node's camera mask is true

virtual void	setCameraMask (unsigned short mask, bool applyChildren=true)
	Modify the camera mask for current node. More...

local	setCameraMask ( local mask, local true)
	Modify the camera mask for current node. More...

virtual void	setLocalZOrder (std::int32_t localZOrder)
	LocalZOrder is the 'key' used to sort the node relative to its siblings. More...

virtual void	setZOrder (std::int32_t localZOrder)
virtual void	_setLocalZOrder (std::int32_t z)
local	_setLocalZOrder ( local z)
void	updateOrderOfArrival ()
	!!! ONLY FOR INTERNAL USE Sets the arrival order when this node has a same ZOrder with other children. More...

virtual std::int32_t	getLocalZOrder () const
	Gets the local Z order of this node. More...

virtual std::int32_t	getZOrder () const
var	getZOrder ()
local	getZOrder ()
virtual void	setGlobalZOrder (float globalZOrder)
	Defines the order in which the nodes are renderer. More...

local	setGlobalZOrder ( local globalZOrder)
	Defines the order in which the nodes are renderer. More...

virtual float	getGlobalZOrder () const
	Returns the Node's Global Z Order. More...

var	getGlobalZOrder ()
	Returns the Node's Global Z Order. More...

local	getGlobalZOrder ()
	Returns the Node's Global Z Order. More...

virtual float	getScaleX () const
	Returns the scale factor on X axis of this node. More...

local	getScaleX ()
	Returns the scale factor on X axis of this node. More...

virtual float	getScaleY () const
	Returns the scale factor on Y axis of this node. More...

virtual void	setScaleZ (float scaleZ)
	Changes the scale factor on Z axis of this node. More...

local	setScaleZ ( local scaleZ)
	Changes the scale factor on Z axis of this node. More...

virtual float	getScaleZ () const
	Returns the scale factor on Z axis of this 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	setPositionNormalized (const Vec2 &position)
	Sets the position (x,y) using values between 0 and 1. More...

virtual void	setNormalizedPosition (const Vec2 &position)
local	setNormalizedPosition ( local position)
virtual const Vec2 &	getPosition () const
	Gets the position (x,y) of the node in its parent's coordinate system. More...

local	getPosition ()
	Gets the position (x,y) of the node in its parent's coordinate system. More...

virtual const Vec2 &	getPositionNormalized () const
	Returns the normalized position. More...

virtual const Vec2 &	getNormalizedPosition () const
virtual void	getPosition (float x, float y) const
	Gets position in a more efficient way, returns two number instead of a Vec2 object. More...

virtual void	setPositionX (float x)
	Gets/Sets x or y coordinate individually for position. More...

var	setPositionX ( var x)
	Gets/Sets x or y coordinate individually for position. More...

local	setPositionX ( local x)
	Gets/Sets x or y coordinate individually for position. More...

virtual float	getPositionX (void) const
	Gets the x coordinate of the node in its parent's coordinate system. More...

virtual void	setPositionY (float y)
	Sets the y coordinate of the node in its parent's coordinate system. More...

local	setPositionY ( local y)
	Sets the y coordinate of the node in its parent's coordinate system. More...

virtual float	getPositionY (void) const
	Gets the y coordinate of the node in its parent's coordinate system. More...

var	getPositionY ()
	Gets the y coordinate of the node in its parent's coordinate system. More...

local	getPositionY ()
	Gets the y coordinate of the node in its parent's coordinate system. More...

virtual void	setPosition3D (const Vec3 &position)
	Sets the position (X, Y, and Z) in its parent's coordinate system. More...

local	setPosition3D ( local position)
	Sets the position (X, Y, and Z) in its parent's coordinate system. More...

virtual Vec3	getPosition3D () const
	Returns the position (X,Y,Z) in its parent's coordinate system. More...

local	getPosition3D ()
	Returns the position (X,Y,Z) in its parent's coordinate system. More...

virtual void	setVertexZ (float vertexZ)
var	setVertexZ ( var vertexZ)
local	setVertexZ ( local vertexZ)
virtual float	getPositionZ () const
	Gets position Z coordinate of this node. More...

virtual float	getVertexZ () const
virtual float	getSkewX () const
	Returns the X skew angle of the node in degrees. More...

local	getSkewX ()
	Returns the X skew angle of the node in degrees. More...

virtual float	getSkewY () const
	Returns the Y skew angle of the node in degrees. More...

virtual const Vec2 &	getAnchorPoint () const
	Returns the anchor point in percent. More...

virtual const Vec2 &	getAnchorPointInPoints () const
	Returns the anchorPoint in absolute pixels. More...

virtual const Size &	getContentSize () const
	Returns the untransformed size of the node. More...

virtual bool	isVisible () const
	Determines if the node is visible. More...

virtual float	getRotation () const
	Returns the rotation of the node in degrees. More...

virtual void	setRotation3D (const Vec3 &rotation)
	Sets the rotation (X,Y,Z) in degrees. More...

local	setRotation3D ( local rotation)
	Sets the rotation (X,Y,Z) in degrees. More...

virtual Vec3	getRotation3D () const
	Returns the rotation (X,Y,Z) in degrees. More...

virtual void	setRotationQuat (const Quaternion &quat)
	Set rotation by quaternion. More...

virtual Quaternion	getRotationQuat () const
	Return the rotation by quaternion, Note that when _rotationZ_X == _rotationZ_Y, the returned quaternion equals to RotationZ_X * RotationY * RotationX, it equals to RotationY * RotationX otherwise. More...

local	getRotationQuat ()
	Return the rotation by quaternion, Note that when _rotationZ_X == _rotationZ_Y, the returned quaternion equals to RotationZ_X * RotationY * RotationX, it equals to RotationY * RotationX otherwise. More...

virtual void	setRotationX (float rotationX)
local	setRotationX ( local rotationX)
virtual float	getRotationSkewX () const
	Gets the X rotation (angle) of the node in degrees which performs a horizontal rotation skew. More...

virtual float	getRotationX () const
var	getRotationX ()
local	getRotationX ()
virtual void	setRotationY (float rotationY)
var	setRotationY ( var rotationY)
local	setRotationY ( local rotationY)
virtual float	getRotationSkewY () const
	Gets the Y rotation (angle) of the node in degrees which performs a vertical rotational skew. More...

local	getRotationSkewY ()
	Gets the Y rotation (angle) of the node in degrees which performs a vertical rotational skew. More...

virtual float	getRotationY () const
void	setGLServerState (int)
var	setGLServerState ( var int)
int	getGLServerState () const
virtual void	ignoreAnchorPointForPosition (bool ignore)
local	ignoreAnchorPointForPosition ( local ignore)
virtual bool	isIgnoreAnchorPointForPosition () const
	Gets whether the anchor point will be (0,0) when you position this node. 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...

local	setTag ( local tag)
	Changes the tag that is used to identify the node easily. More...

virtual const std::string &	getName () const
	Returns a string that is used to identify the node. More...

local	getName ()
	Returns a string that is used to identify the node. More...

virtual void	setName (const std::string &name)
	Changes the name that is used to identify the node easily. More...

local	setName ( local name)
	Changes the name 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 Ref *	getUserObject ()
	Returns a user assigned Object. More...

var	getUserObject ()
	Returns a user assigned Object. More...

virtual const Ref *	getUserObject () const
virtual void	setUserObject (Ref *userObject)
	Returns a user assigned Object. More...

local	setUserObject ( local userObject)
	Returns a user assigned Object. More...

GLProgram *	getGLProgram () const
	Return the GLProgram (shader) currently used for this node. More...

var	getGLProgram ()
	Return the GLProgram (shader) currently used for this node. More...

local	getGLProgram ()
	Return the GLProgram (shader) currently used for this node. More...

GLProgram *	getShaderProgram () const
var	getShaderProgram ()
local	getShaderProgram ()
virtual void	setGLProgram (GLProgram *glprogram)
	Sets the shader program for this node. More...

local	setGLProgram ( local glprogram)
	Sets the shader program for this node. More...

void	setShaderProgram (GLProgram *glprogram)
var	setShaderProgram ( var glprogram)
local	setShaderProgram ( local glprogram)
GLProgramState *	getGLProgramState () const
	Return the GLProgramState currently used for this node. More...

var	getGLProgramState ()
	Return the GLProgramState currently used for this node. More...

local	getGLProgramState ()
	Return the GLProgramState currently used for this node. More...

virtual void	setGLProgramState (GLProgramState *glProgramState)
	Set the GLProgramState 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...

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

var	setActionManager ( var actionManager)
	Sets the ActionManager object that is used by all actions. More...

local	setActionManager ( local actionManager)
	Sets the ActionManager object that is used by all actions. More...

virtual ActionManager *	getActionManager ()
	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 ActionManager *	getActionManager () const
virtual Action *	runAction (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 .

void	stopAction (Action *action)
	Stops and removes an action from the running action list. More...

var	stopAction ( var action)
	Stops and removes an action from the running action list. More...

local	stopAction ( local action)
	Stops and removes an action from the running action list. More...

void	stopActionByTag (int tag)
	Removes an action from the running action list by its tag. More...

void	stopAllActionsByTag (int tag)
	Removes all actions from the running action list by its tag. More...

var	stopAllActionsByTag ( var tag)
	Removes all actions from the running action list by its tag. More...

local	stopAllActionsByTag ( local tag)
	Removes all actions from the running action list by its tag. More...

void	stopActionsByFlags (unsigned int flags)
	Removes all actions from the running action list by its flags. More...

Action *	getActionByTag (int tag)
	Gets an action from the running action list by its tag. More...

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

ssize_t	getNumberOfRunningActionsByTag (int tag) const
	Returns the numbers of actions that are running plus the ones that are schedule to run (actions in actionsToAdd and actions arrays) with a specific tag. More...

local	getNumberOfRunningActionsByTag ( local tag)
	Returns the numbers of actions that are running plus the ones that are schedule to run (actions in actionsToAdd and actions arrays) with a specific tag. More...

ssize_t	numberOfRunningActions () const
local	numberOfRunningActions ()
virtual void	setScheduler (Scheduler *scheduler)
	Sets a Scheduler object that is used to schedule all "updates" and timers. More...

virtual Scheduler *	getScheduler ()
	Gets a Scheduler object. More...

local	getScheduler ()
	Gets a Scheduler object. More...

virtual const Scheduler *	getScheduler () const
local	getScheduler ()
bool	isScheduled (SEL_SCHEDULE selector) const
	Checks whether a selector is scheduled. More...

bool	isScheduled (const std::string &key) const
	Checks whether a lambda function is scheduled. More...

void	scheduleUpdate (void)
	Schedules the "update" method. More...

var	scheduleUpdate ()
	Schedules the "update" method. More...

void	scheduleUpdateWithPriority (int priority)
	Schedules the "update" method with a custom priority. More...

var	scheduleUpdateWithPriority ( var priority)
	Schedules the "update" method with a custom priority. More...

void	unscheduleUpdate (void)
var	unscheduleUpdate ()
local	unscheduleUpdate ()
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	scheduleOnce (const std::function< void(float)> &callback, float delay, const std::string &key)
	Schedules a lambda function 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	schedule (const std::function< void(float)> &callback, const std::string &key)
	Schedules a lambda function. More...

var	schedule ( var callback, var key)
	Schedules a lambda function. More...

void	schedule (const std::function< void(float)> &callback, float interval, const std::string &key)
	Schedules a lambda function. More...

void	schedule (const std::function< void(float)> &callback, float interval, unsigned int repeat, float delay, const std::string &key)
	Schedules a lambda function. More...

void	unschedule (SEL_SCHEDULE selector)
	Unschedules a custom selector. More...

void	unschedule (const std::string &key)
	Unschedules a lambda function. More...

void	unscheduleAllCallbacks ()
	Unschedule all scheduled selectors and lambda functions: custom selectors, and the 'update' selector and lambda functions. More...

void	unscheduleAllSelectors ()
var	unscheduleAllSelectors ()
local	unscheduleAllSelectors ()
virtual void	resume (void)
	Resumes all scheduled selectors, actions and event listeners. More...

var	resume ()
	Resumes all scheduled selectors, actions and event listeners. More...

local	resume ()
	Resumes all scheduled selectors, actions and event listeners. More...

virtual void	pause (void)
	Pauses all scheduled selectors, actions and event listeners. More...

local	pause ()
	Pauses all scheduled selectors, actions and event listeners. More...

void	resumeSchedulerAndActions ()
	Resumes all scheduled selectors, actions and event listeners. More...

void	pauseSchedulerAndActions ()
	Pauses all scheduled selectors, actions and event listeners. More...

var	pauseSchedulerAndActions ()
	Pauses all scheduled selectors, actions and event listeners. More...

local	pauseSchedulerAndActions ()
	Pauses all scheduled selectors, actions and event listeners. More...

virtual void	update (float delta)
	Update method will be called automatically every frame if "scheduleUpdate" is called, and the node is "live". More...

var	update ( var delta)
	Update method will be called automatically every frame if "scheduleUpdate" is called, and the node is "live". More...

local	update ( local delta)
	Update method will be called automatically every frame if "scheduleUpdate" is called, and the node is "live". More...

virtual const Mat4 &	getNodeToParentTransform () const
	Returns the matrix that transform the node's (local) space coordinates into the parent's space coordinates. More...

virtual AffineTransform	getNodeToParentAffineTransform () const
local	getNodeToParentAffineTransform ()
virtual Mat4	getNodeToParentTransform (Node *ancestor) const
	Returns the matrix that transform the node's (local) space coordinates into the parent's space coordinates. More...

var	getNodeToParentTransform ( var ancestor)
	Returns the matrix that transform the node's (local) space coordinates into the parent's space coordinates. More...

local	getNodeToParentTransform ( local ancestor)
	Returns the matrix that transform the node's (local) space coordinates into the parent's space coordinates. More...

virtual AffineTransform	getNodeToParentAffineTransform (Node *ancestor) const
	Returns the affine transform matrix that transform the node's (local) space coordinates into the parent's space coordinates. More...

local	getNodeToParentAffineTransform ( local ancestor)
	Returns the affine transform matrix that transform the node's (local) space coordinates into the parent's space coordinates. More...

virtual void	setNodeToParentTransform (const Mat4 &transform)
	Sets the transformation matrix manually. More...

var	setNodeToParentTransform ( var transform)
	Sets the transformation matrix manually. More...

local	setNodeToParentTransform ( local transform)
	Sets the transformation matrix manually. More...

virtual AffineTransform	nodeToParentTransform () const
virtual const Mat4 &	getParentToNodeTransform () const
	Returns the matrix that transform parent's space coordinates to the node's (local) space coordinates. More...

var	getParentToNodeTransform ()
	Returns the matrix that transform parent's space coordinates to the node's (local) space coordinates. More...

local	getParentToNodeTransform ()
	Returns the matrix that transform parent's space coordinates to the node's (local) space coordinates. More...

virtual AffineTransform	getParentToNodeAffineTransform () const
local	getParentToNodeAffineTransform ()
virtual AffineTransform	parentToNodeTransform () const
local	parentToNodeTransform ()
virtual Mat4	getNodeToWorldTransform () const
	Returns the world affine transform matrix. More...

var	getNodeToWorldTransform ()
	Returns the world affine transform matrix. More...

local	getNodeToWorldTransform ()
	Returns the world affine transform matrix. More...

virtual AffineTransform	getNodeToWorldAffineTransform () const
local	getNodeToWorldAffineTransform ()
virtual AffineTransform	nodeToWorldTransform () const
local	nodeToWorldTransform ()
virtual Mat4	getWorldToNodeTransform () const
	Returns the inverse world affine transform matrix. More...

var	getWorldToNodeTransform ()
	Returns the inverse world affine transform matrix. More...

local	getWorldToNodeTransform ()
	Returns the inverse world affine transform matrix. More...

virtual AffineTransform	getWorldToNodeAffineTransform () const
local	getWorldToNodeAffineTransform ()
virtual AffineTransform	worldToNodeTransform () const
local	worldToNodeTransform ()
Vec2	convertToNodeSpace (const Vec2 &worldPoint) const
	Converts a Vec2 to node (local) space coordinates. More...

var	convertToNodeSpace ( var worldPoint)
	Converts a Vec2 to node (local) space coordinates. More...

local	convertToNodeSpace ( local worldPoint)
	Converts a Vec2 to node (local) space coordinates. More...

Vec2	convertToWorldSpace (const Vec2 &nodePoint) const
	Converts a Vec2 to world space coordinates. More...

Vec2	convertToNodeSpaceAR (const Vec2 &worldPoint) const
	Converts a Vec2 to node (local) space coordinates. More...

Vec2	convertToWorldSpaceAR (const Vec2 &nodePoint) const
	Converts a local Vec2 to world space coordinates.The result is in Points. More...

var	convertToWorldSpaceAR ( var nodePoint)
	Converts a local Vec2 to world space coordinates.The result is in Points. More...

local	convertToWorldSpaceAR ( local nodePoint)
	Converts a local Vec2 to world space coordinates.The result is in Points. More...

Vec2	convertTouchToNodeSpace (Touch *touch) const
	convenience methods which take a Touch instead of Vec2. More...

local	convertTouchToNodeSpace ( local touch)
	convenience methods which take a Touch instead of Vec2. More...

Vec2	convertTouchToNodeSpaceAR (Touch *touch) const
	converts a Touch (world coordinates) into a local coordinate. More...

void	setAdditionalTransform (const Mat4 *additionalTransform)
	Sets an additional transform matrix to the node. More...

void	setAdditionalTransform (const Mat4 &additionalTransform)
var	setAdditionalTransform ( var additionalTransform)
local	setAdditionalTransform ( local additionalTransform)
void	setAdditionalTransform (const AffineTransform &additionalTransform)
var	setAdditionalTransform ( var additionalTransform)
local	setAdditionalTransform ( local additionalTransform)
Component *	getComponent (const std::string &name)
	Gets a component by its name. More...

local	getComponent ( local name)
	Gets a component by its name. More...

virtual bool	addComponent (Component *component)
	Adds a component. More...

local	addComponent ( local component)
	Adds a component. More...

virtual bool	removeComponent (const std::string &name)
	Removes a component by its name. More...

local	removeComponent ( local name)
	Removes a component by its name. More...

virtual bool	removeComponent (Component *component)
	Removes a component by its pointer. More...

local	removeComponent ( local component)
	Removes a component by its pointer. More...

virtual void	removeAllComponents ()
	Removes all components.

virtual void	addChild (Node *child)
	Adds a child to the container with z-order as 0. More...

virtual void	addChild (Node *child, int localZOrder)
	Adds a child to the container with a local z-order. More...

local	addChild ( local child, local localZOrder)
	Adds a child to the container with a local z-order. More...

virtual Node *	getChildByTag (int tag) const
	Gets a child from the container with its tag. More...

local	getChildByTag ( local tag)
	Gets a child from the container with its tag. More...

template<typename T >
T	getChildByTag (int tag) const
	Gets a child from the container with its tag that can be cast to Type T. More...

virtual Node *	getChildByName (const std::string &name) const
	Gets a child from the container with its name. More...

local	getChildByName ( local name)
	Gets a child from the container with its name. More...

template<typename T >
T	getChildByName (const std::string &name) const
	Gets a child from the container with its name that can be cast to Type T. More...

template<typename T >
var	getChildByName ( var name)
	Gets a child from the container with its name that can be cast to Type T. More...

template<typename T >
local	getChildByName ( local name)
	Gets a child from the container with its name that can be cast to Type T. More...

virtual void	enumerateChildren (const std::string &name, std::function< bool(Node *node)> callback) const
	Search the children of the receiving node to perform processing for nodes which share a name. More...

virtual Vector< Node * > &	getChildren ()
	Returns the array of the node's children. More...

local	getChildren ()
	Returns the array of the node's children. More...

virtual const Vector< Node * > &	getChildren () const
var	getChildren ()
local	getChildren ()
virtual ssize_t	getChildrenCount () const
	Returns the amount of children. More...

virtual void	setParent (Node *parent)
	Sets the parent node. More...

local	setParent ( local parent)
	Sets the parent node. More...

virtual Node *	getParent ()
	Returns a pointer to the parent node. More...

virtual const Node *	getParent () const
local	getParent ()
virtual void	removeFromParent ()
	Removes this node itself from its parent node with a cleanup. More...

virtual void	removeFromParentAndCleanup (bool cleanup)
	Removes this node itself from its parent node. More...

local	removeFromParent ( local cleanup)
	Removes this node itself from its parent node. More...

virtual void	removeChildByTag (int tag, bool cleanup=true)
	Removes a child from the container by tag value. More...

var	removeChildByTag ( var tag, var 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	removeChildByName (const std::string &name, bool cleanup=true)
	Removes a child from the container by tag value. More...

virtual void	removeAllChildren ()
	Removes all children from the container with a cleanup. More...

var	removeAllChildren ()
	Removes all children from the container with a cleanup. More...

local	removeAllChildren ()
	Removes all children from the container with a cleanup. More...

Public Member Functions inherited from Ref
void	retain ()
	Retains the ownership. More...

void	release ()
	Releases the ownership immediately. More...

local	release ()
	Releases the ownership immediately. More...

Ref *	autorelease ()
	Releases the ownership sometime soon automatically. More...

unsigned int	getReferenceCount () const
	Returns the Ref's current reference count. More...

local	getReferenceCount ()
	Returns the Ref's current reference count. More...

virtual	~Ref ()
	Destructor. More...

Static Public Member Functions
static Scale9Sprite *	create ()
	Create an empty Scale9Sprite. More...

var	create ()
	Create an empty Scale9Sprite. More...

local	create ()
	Create an empty Scale9Sprite. More...

static Scale9Sprite *	create (const std::string &file, const Rect &rect, const Rect &capInsets)
	Creates a 9-slice sprite with a texture file, a delimitation zone and with the specified cap insets. More...

static Scale9Sprite *	create (const Rect &capInsets, const std::string &file)
	Creates a 9-slice sprite with a texture file. More...

static Scale9Sprite *	create (const std::string &file, const Rect &rect)
	Creates a 9-slice sprite with a texture file and a delimitation zone. More...

local	create ( local file, local rect)
	Creates a 9-slice sprite with a texture file and a delimitation zone. More...

static Scale9Sprite *	create (const std::string &file)
	Creates a 9-slice sprite with a texture file. More...

static Scale9Sprite *	createWithSpriteFrame (SpriteFrame *spriteFrame)
	Creates a 9-slice sprite with an sprite frame. More...

static Scale9Sprite *	createWithSpriteFrame (SpriteFrame *spriteFrame, const 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 Scale9Sprite *	createWithSpriteFrameName (const std::string &spriteFrameName)
	Creates a 9-slice sprite with an sprite frame name. More...

local	createWithSpriteFrameName ( local spriteFrameName)
	Creates a 9-slice sprite with an sprite frame name. More...

static Scale9Sprite *	createWithSpriteFrameName (const std::string &spriteFrameName, const Rect &capInsets)
	Creates a 9-slice sprite with an sprite frame name and the centre of its zone. More...

local	createWithSpriteFrameName ( local spriteFrameName, local capInsets)
	Creates a 9-slice sprite with an sprite frame name and the centre of its zone. More...

Static Public Member Functions inherited from Sprite
static Sprite *	create (const std::string &filename)
	Creates a sprite with an image filename. More...

local	create ( local filename)
	Creates a sprite with an image filename. More...

static Sprite *	create (const PolygonInfo &info)
	Creates a polygon sprite with a polygon info. More...

var	create ( var info)
	Creates a polygon sprite with a polygon info. More...

local	create ( local info)
	Creates a polygon sprite with a polygon info. More...

static Sprite *	create (const std::string &filename, const Rect &rect)
	Creates a sprite with an image filename and a rect. More...

local	create ( local filename, local rect)
	Creates a sprite with an image filename and a rect. More...

static Sprite *	createWithTexture (Texture2D *texture)
	Creates a sprite with a Texture2D object. More...

static Sprite *	createWithTexture (Texture2D *texture, const Rect &rect, bool rotated=false)
	Creates a sprite with a texture and a rect. More...

local	createWithTexture ( local texture, local rect, local false)
	Creates a sprite with a texture and a rect. More...

static Sprite *	createWithSpriteFrame (SpriteFrame *spriteFrame)
	Creates a sprite with an sprite frame. More...

static Sprite *	createWithSpriteFrameName (const std::string &spriteFrameName)
	Creates a sprite with an sprite frame name. More...

local	createWithSpriteFrameName ( local spriteFrameName)
	Creates a sprite with an sprite frame name. More...

Static Public Member Functions inherited from Node
static Node *	create ()
	Allocates and initializes a node. More...

var	create ()
	Allocates and initializes a node. More...

local	create ()
	Allocates and initializes a node. More...

static int	getAttachedNodeCount ()
	Gets count of nodes those are attached to scene graph.

var	getAttachedNodeCount ()
	Gets count of nodes those are attached to scene graph.

local	getAttachedNodeCount ()
	Gets count of nodes those are attached to scene graph.

template<typename _T >
static void	sortNodes (cocos2d::Vector< _T * > &nodes)
	Sorts helper function. More...

Additional Inherited Members
Public Attributes inherited from Ref
unsigned int	_ID
	object id, ScriptSupport need public _ID

local	_ID
	object id, ScriptSupport need public _ID

int	_luaID
	Lua reference id.

local	_luaID
	Lua reference id.

void *	_scriptObject
	scriptObject, support for swift

local	_scriptObject
	scriptObject, support for swift

bool	_rooted
	When true, it means that the object was already rooted.

local	_rooted
	When true, it means that the object was already rooted.

Static Public Attributes inherited from Sprite
static const int	INDEX_NOT_INITIALIZED = -1
	Sprite invalid index on the SpriteBatchNode. More...

Static Public Attributes inherited from Node
static const int	INVALID_TAG = -1
	Default tag used for all the nodes.

var	INVALID_TAG = -1
	Default tag used for all the nodes.

local	INVALID_TAG = -1
	Default tag used for all the nodes.

Protected Member Functions inherited from Sprite
virtual bool	initWithTexture (Texture2D *texture)
	Initializes a sprite with a texture. More...

var	initWithTexture ( var texture)
	Initializes a sprite with a texture. More...

local	initWithTexture ( local texture)
	Initializes a sprite with a texture. More...

virtual bool	initWithPolygon (const PolygonInfo &info)
	Initializes a sprite with a PolygonInfo. More...

local	initWithPolygon ( local info)
	Initializes a sprite with a PolygonInfo. More...

virtual bool	initWithTexture (Texture2D *texture, const Rect &rect)
	Initializes a sprite with a texture and a rect. More...

local	initWithTexture ( local texture, local rect)
	Initializes a sprite with a texture and a rect. More...

virtual bool	initWithTexture (Texture2D *texture, const Rect &rect, bool rotated)
	Initializes a sprite with a texture and a rect in points, optionally rotated. More...

var	initWithTexture ( var texture, var rect, var rotated)
	Initializes a sprite with a texture and a rect in points, optionally rotated. More...

local	initWithTexture ( local texture, local rect, local rotated)
	Initializes a sprite with a texture and a rect in points, optionally rotated. More...

virtual bool	initWithSpriteFrame (SpriteFrame *spriteFrame)
	Initializes a sprite with an SpriteFrame. More...

Detailed Description

A 9-slice sprite for cocos2d-x.

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. Note: When you set _scale9Enabled to false, then you could call scale9Sprite->getSprite() to return the inner Sprite pointer. Then you could call any methods of Sprite class with the return pointers.

Member Function Documentation

static Scale9Sprite* create ( )

static

Create an empty Scale9Sprite.

Returns: A Scale9Sprite instance.

var create ( )

static

Create an empty Scale9Sprite.

Returns: A Scale9Sprite instance.

local create ( )

static

Create an empty Scale9Sprite.

Returns: A Scale9Sprite instance.

static Scale9Sprite* create	(	const std::string &	file,
		const Rect &	rect,
		const 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, const Rect& rect, const Rect& capInsets)

Parameters

file	A texture file name.
rect	A delimitation zone.
capInsets	A specified cap insets.

Returns: A Scale9Sprite instance.

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, const Rect& rect, const Rect& capInsets)

Parameters

file	A texture file name.
rect	A delimitation zone.
capInsets	A specified cap insets.

Returns: A Scale9Sprite instance.

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, const Rect& rect, const Rect& capInsets)

Parameters

file	A texture file name.
rect	A delimitation zone.
capInsets	A specified cap insets.

Returns: A Scale9Sprite instance.

static Scale9Sprite* create	(	const Rect &	capInsets,
		const std::string &	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 Rect& capInsets, const char *file)

Parameters

capInsets	A specified cap insets.
file	A texture file name.

Returns: A Scale9Sprite instance.

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(const Rect& capInsets, const char *file)

Parameters

capInsets	A specified cap insets.
file	A texture file name.

Returns: A Scale9Sprite instance.

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(const Rect& capInsets, const char *file)

Parameters

capInsets	A specified cap insets.
file	A texture file name.

Returns: A Scale9Sprite instance.

static Scale9Sprite* create	(	const std::string &	file,
		const 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, const Rect& rect)

Parameters

file	A texture file name.
rect	A delimitation zone.

Returns: A Scale9Sprite instance.

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, const Rect& rect)

Parameters

file	A texture file name.
rect	A delimitation zone.

Returns: A Scale9Sprite instance.

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, const Rect& rect)

Parameters

file	A texture file name.
rect	A delimitation zone.

Returns: A Scale9Sprite instance.

static Scale9Sprite* create ( const std::string & 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)

Parameters

file	A texture file name.

Returns: A Scale9Sprite instance.

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)

Parameters

file	A texture file name.

Returns: A Scale9Sprite instance.

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)

Parameters

file	A texture file name.

Returns: A Scale9Sprite instance.

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 interact. It respects the anchorPoint too.

See also: initWithSpriteFrame(SpriteFrame *spriteFrame)

Parameters

spriteFrame A sprite frame pointer.

Returns: A Scale9Sprite instance.

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 interact. It respects the anchorPoint too.

See also: initWithSpriteFrame(SpriteFrame *spriteFrame)

Parameters

spriteFrame A sprite frame pointer.

Returns: A Scale9Sprite instance.

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 interact. It respects the anchorPoint too.

See also: initWithSpriteFrame(SpriteFrame *spriteFrame)

Parameters

spriteFrame A sprite frame pointer.

Returns: A Scale9Sprite instance.

static Scale9Sprite* createWithSpriteFrame	(	SpriteFrame *	spriteFrame,
		const 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 interact. It respects the anchorPoint too.

See also: initWithSpriteFrame(SpriteFrame *spriteFrame, const Rect& capInsets)

Parameters

spriteFrame	A sprite frame pointer.
capInsets	A delimitation zone.

Returns: A Scale9Sprite instance.

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 interact. It respects the anchorPoint too.

See also: initWithSpriteFrame(SpriteFrame *spriteFrame, const Rect& capInsets)

Parameters

spriteFrame	A sprite frame pointer.
capInsets	A delimitation zone.

Returns: A Scale9Sprite instance.

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 interact. It respects the anchorPoint too.

See also: initWithSpriteFrame(SpriteFrame *spriteFrame, const Rect& capInsets)

Parameters

spriteFrame	A sprite frame pointer.
capInsets	A delimitation zone.

Returns: A Scale9Sprite instance.

static Scale9Sprite*
createWithSpriteFrameName ( const std::string & 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 interact. It respects the anchorPoint too.

See also: initWithSpriteFrameName(const char *spriteFrameName)

Parameters

spriteFrameName A sprite frame name.

Returns: A Scale9Sprite instance.

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 interact. It respects the anchorPoint too.

See also: initWithSpriteFrameName(const char *spriteFrameName)

Parameters

spriteFrameName A sprite frame name.

Returns: A Scale9Sprite instance.

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 interact. It respects the anchorPoint too.

See also: initWithSpriteFrameName(const char *spriteFrameName)

Parameters

spriteFrameName A sprite frame name.

Returns: A Scale9Sprite instance.

static Scale9Sprite* createWithSpriteFrameName	(	const std::string &	spriteFrameName,
		const 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 interact. It respects the anchorPoint too.

See also: initWithSpriteFrameName(const char *spriteFrameName, const Rect& capInsets)

Parameters

spriteFrameName	A sprite frame name.
capInsets	A delimitation zone.

Returns: A Scale9Sprite instance.

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 interact. It respects the anchorPoint too.

See also: initWithSpriteFrameName(const char *spriteFrameName, const Rect& capInsets)

Parameters

spriteFrameName	A sprite frame name.
capInsets	A delimitation zone.

Returns: A Scale9Sprite instance.

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 interact. It respects the anchorPoint too.

See also: initWithSpriteFrameName(const char *spriteFrameName, const Rect& capInsets)

Parameters

spriteFrameName	A sprite frame name.
capInsets	A delimitation zone.

Returns: A Scale9Sprite instance.

virtual bool initWithFile	(	const std::string &	file,
		const Rect &	rect,
		const 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 interact. It respects the anchorPoint too.

Parameters

file	The name of the texture file.
rect	The 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.
capInsets	The values to use for the cap insets.

Returns: True if initialize success, false otherwise.

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 interact. It respects the anchorPoint too.

Parameters

file	The name of the texture file.
rect	The 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.
capInsets	The values to use for the cap insets.

Returns: True if initialize success, false otherwise.

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 interact. It respects the anchorPoint too.

Parameters

file	The name of the texture file.
rect	The 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.
capInsets	The values to use for the cap insets.

Returns: True if initialize success, false otherwise.

virtual bool initWithFile	(	const Rect &	capInsets,
		const std::string &	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 interact. It respects the anchorPoint too.

Parameters

file	The name of the texture file.
capInsets	The values to use for the cap insets.

Returns: True if initializes success, false otherwise.

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 interact. It respects the anchorPoint too.

Parameters

file	The name of the texture file.
capInsets	The values to use for the cap insets.

Returns: True if initializes success, false otherwise.

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 interact. It respects the anchorPoint too.

Parameters

file	The name of the texture file.
capInsets	The values to use for the cap insets.

Returns: True if initializes success, false otherwise.

virtual bool initWithSpriteFrame	(	SpriteFrame *	spriteFrame,
		const 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 interact. It respects the anchorPoint too.

Parameters

spriteFrame	The sprite frame object.
capInsets	The values to use for the cap insets.

Returns: True if initializes success, false otherwise.

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 interact. It respects the anchorPoint too.

Parameters

spriteFrame	The sprite frame object.
capInsets	The values to use for the cap insets.

Returns: True if initializes success, false otherwise.

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 interact. It respects the anchorPoint too.

Parameters

spriteFrame	The sprite frame object.
capInsets	The values to use for the cap insets.

Returns: True if initializes success, false otherwise.

virtual bool initWithSpriteFrameName	(	const std::string &	spriteFrameName,
		const 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 interact. It respects the anchorPoint too.

Parameters

spriteFrameName	The sprite frame name.
capInsets	The values to use for the cap insets.

Returns: True if initializes success, false otherwise.

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 interact. It respects the anchorPoint too.

Parameters

spriteFrameName	The sprite frame name.
capInsets	The values to use for the cap insets.

Returns: True if initializes success, false otherwise.

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 interact. It respects the anchorPoint too.

Parameters

spriteFrameName	The sprite frame name.
capInsets	The values to use for the cap insets.

Returns: True if initializes success, false otherwise.

virtual bool initWithFile	(	const std::string &	file,
		const Rect &	rect
	)

overridevirtual

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 interact. It respects the anchorPoint too.

Parameters

file	The name of the texture file.
rect	The 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.

Returns: True if initializes success, false otherwise.

Reimplemented from Sprite.

var initWithFile	(	var	file,
		var	rect
	)

overridevirtual

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 interact. It respects the anchorPoint too.

Parameters

file	The name of the texture file.
rect	The 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.

Returns: True if initializes success, false otherwise.

Reimplemented from Sprite.

local initWithFile	(	local	file,
		local	rect
	)

overridevirtual

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 interact. It respects the anchorPoint too.

Parameters

file	The name of the texture file.
rect	The 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.

Returns: True if initializes success, false otherwise.

Reimplemented from Sprite.

virtual bool initWithFile ( const std::string & file )

overridevirtual

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 interact. It respects the anchorPoint too.

Parameters

file	The name of the texture file.

Returns: True if initializes success, false otherwise.

Reimplemented from Sprite.

var initWithFile ( var file )

overridevirtual

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 interact. It respects the anchorPoint too.

Parameters

file	The name of the texture file.

Returns: True if initializes success, false otherwise.

Reimplemented from Sprite.

local initWithFile ( local file )

overridevirtual

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 interact. It respects the anchorPoint too.

Parameters

file	The name of the texture file.

Returns: True if initializes success, false otherwise.

Reimplemented from Sprite.

virtual bool
initWithSpriteFrameName ( const std::string & spriteFrameName )

overridevirtual

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 interact. It respects the anchorPoint too.

Parameters

spriteFrameName The sprite frame name.

Returns: True if initializes success, false otherwise.

Reimplemented from Sprite.

var initWithSpriteFrameName ( var spriteFrameName )

overridevirtual

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 interact. It respects the anchorPoint too.

Parameters

spriteFrameName The sprite frame name.

Returns: True if initializes success, false otherwise.

Reimplemented from Sprite.

local initWithSpriteFrameName ( local spriteFrameName )

overridevirtual

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 interact. It respects the anchorPoint too.

Parameters

spriteFrameName The sprite frame name.

Returns: True if initializes success, false otherwise.

Reimplemented from Sprite.

virtual bool init	(	Sprite *	sprite,
		const Rect &	rect,
		bool	rotated,
		const Rect &	capInsets
	)

virtual

Initializes a 9-slice sprite with an sprite instance.

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

Parameters

sprite	The sprite instance.
rect	A delimitation zone.
rotated	Whether the sprite is rotated or not.
capInsets	The values to use for the cap insets.

Returns: True if initializes success, false otherwise.

var init	(	var	sprite,
		var	rect,
		var	rotated,
		var	capInsets
	)

virtual

Initializes a 9-slice sprite with an sprite instance.

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

Parameters

sprite	The sprite instance.
rect	A delimitation zone.
rotated	Whether the sprite is rotated or not.
capInsets	The values to use for the cap insets.

Returns: True if initializes success, false otherwise.

local init	(	local	sprite,
		local	rect,
		local	rotated,
		local	capInsets
	)

virtual

Initializes a 9-slice sprite with an sprite instance.

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

Parameters

sprite	The sprite instance.
rect	A delimitation zone.
rotated	Whether the sprite is rotated or not.
capInsets	The values to use for the cap insets.

Returns: True if initializes success, false otherwise.

virtual bool init	(	Sprite *	sprite,
		const Rect &	rect,
		const Rect &	capInsets
	)

virtual

Initializes a 9-slice sprite with an sprite instance.

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

Parameters

sprite	The sprite instance.
rect	A delimitation zone.
capInsets	The values to use for the cap insets.

Returns: True if initializes success, false otherwise.

var init	(	var	sprite,
		var	rect,
		var	capInsets
	)

virtual

Initializes a 9-slice sprite with an sprite instance.

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

Parameters

sprite	The sprite instance.
rect	A delimitation zone.
capInsets	The values to use for the cap insets.

Returns: True if initializes success, false otherwise.

local init	(	local	sprite,
		local	rect,
		local	capInsets
	)

virtual

Initializes a 9-slice sprite with an sprite instance.

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

Parameters

sprite	The sprite instance.
rect	A delimitation zone.
capInsets	The values to use for the cap insets.

Returns: True if initializes success, false otherwise.

virtual bool init	(	Sprite *	sprite,
		const Rect &	rect,
		bool	rotated,
		const Vec2 &	offset,
		const Size &	originalSize,
		const Rect &	capInsets
	)

virtual

Initializes a 9-slice sprite with an sprite instance.

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

Parameters

sprite	The sprite instance.
rect	A delimitation zone.
rotated	Whether the sprite is rotated or not.
offset	The offset when slice the sprite.
originalSize	The original size of sprite.
capInsets	The values to use for the cap insets.

Returns: True if initializes success, false otherwise.

var init	(	var	sprite,
		var	rect,
		var	rotated,
		var	offset,
		var	originalSize,
		var	capInsets
	)

virtual

Initializes a 9-slice sprite with an sprite instance.

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

Parameters

sprite	The sprite instance.
rect	A delimitation zone.
rotated	Whether the sprite is rotated or not.
offset	The offset when slice the sprite.
originalSize	The original size of sprite.
capInsets	The values to use for the cap insets.

Returns: True if initializes success, false otherwise.

local init	(	local	sprite,
		local	rect,
		local	rotated,
		local	offset,
		local	originalSize,
		local	capInsets
	)

virtual

Initializes a 9-slice sprite with an sprite instance.

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

Parameters

sprite	The sprite instance.
rect	A delimitation zone.
rotated	Whether the sprite is rotated or not.
offset	The offset when slice the sprite.
originalSize	The original size of sprite.
capInsets	The values to use for the cap insets.

Returns: True if initializes success, false otherwise.

CC_DEPRECATED ( v3 )

Initializes a 9-slice sprite with a sprite batchnode.

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

var CC_DEPRECATED ( var )

Initializes a 9-slice sprite with a sprite batchnode.

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

local CC_DEPRECATED ( local )

Initializes a 9-slice sprite with a sprite batchnode.

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

CC_DEPRECATED ( v3 )

Initializes a 9-slice sprite with a sprite batch node.

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

var CC_DEPRECATED ( var )

Initializes a 9-slice sprite with a sprite batch node.

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

local CC_DEPRECATED ( local )

Initializes a 9-slice sprite with a sprite batch node.

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

Scale9Sprite*
resizableSpriteWithCapInsets ( const Rect & capInsets ) const

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

capInsets The values to use for the cap insets.

Returns: A Scale9Sprite instance.

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

capInsets The values to use for the cap insets.

Returns: A Scale9Sprite instance.

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

capInsets The values to use for the cap insets.

Returns: A Scale9Sprite instance.

virtual bool updateWithSprite	(	Sprite *	sprite,
		const Rect &	rect,
		bool	rotated,
		const Rect &	capInsets
	)

virtual

Update Scale9Sprite with a specified sprite.

Parameters

sprite	A sprite pointer.
rect	A delimitation zone.
rotated	Whether the sprite is rotated or not.
capInsets	The Values to use for the cap insets.

Returns: True if update success, false otherwise.

local updateWithSprite	(	local	sprite,
		local	rect,
		local	rotated,
		local	capInsets
	)

virtual

Update Scale9Sprite with a specified sprite.

Parameters

sprite	A sprite pointer.
rect	A delimitation zone.
rotated	Whether the sprite is rotated or not.
capInsets	The Values to use for the cap insets.

Returns: True if update success, false otherwise.

virtual bool updateWithSprite	(	Sprite *	sprite,
		const Rect &	rect,
		bool	rotated,
		const Vec2 &	offset,
		const Size &	originalSize,
		const Rect &	capInsets
	)

virtual

Update Scale9Sprite with a specified sprite.

Parameters

sprite	A sprite pointer.
rect	A delimitation zone.
rotated	Whether the sprite is rotated or not.
offset	The offset when slice the sprite.
originalSize	The original size of the sprite.
capInsets	The Values to use for the cap insets.

Returns: True if update success, false otherwise.

local updateWithSprite	(	local	sprite,
		local	rect,
		local	rotated,
		local	offset,
		local	originalSize,
		local	capInsets
	)

virtual

Update Scale9Sprite with a specified sprite.

Parameters

sprite	A sprite pointer.
rect	A delimitation zone.
rotated	Whether the sprite is rotated or not.
offset	The offset when slice the sprite.
originalSize	The original size of the sprite.
capInsets	The Values to use for the cap insets.

Returns: True if update success, false otherwise.

CC_DEPRECATED ( v3 )

Update Scale9Sprite with a specified sprite.

var CC_DEPRECATED ( var )

Update Scale9Sprite with a specified sprite.

local CC_DEPRECATED ( local )

Update Scale9Sprite with a specified sprite.

virtual void setSpriteFrame	(	SpriteFrame *	spriteFrame,
		const Rect &	capInsets
	)

virtual

Change inner sprite's sprite frame.

Parameters

spriteFrame	A sprite frame pointer.
capInsets	The values to use for the cap insets.

var setSpriteFrame	(	var	spriteFrame,
		var	capInsets
	)

virtual

Change inner sprite's sprite frame.

Parameters

spriteFrame	A sprite frame pointer.
capInsets	The values to use for the cap insets.

local setSpriteFrame	(	local	spriteFrame,
		local	capInsets
	)

virtual

Change inner sprite's sprite frame.

Parameters

spriteFrame	A sprite frame pointer.
capInsets	The values to use for the cap insets.

void setState ( State state )

Change the state of 9-slice sprite.

See also: State

Parameters

state A enum value in State.

Since: v3.4

var setState ( var state )

Change the state of 9-slice sprite.

See also: State

Parameters

state A enum value in State.

Since: v3.4

local setState ( local state )

Change the state of 9-slice sprite.

See also: State

Parameters

state A enum value in State.

Since: v3.4

State getState ( ) const

Query the current bright state.

Returns

See also: State

Since: v3.7

var getState ( )

Query the current bright state.

Returns

See also: State

Since: v3.7

local getState ( )

Query the current bright state.

Returns

See also: State

Since: v3.7

Size getOriginalSize ( ) const

Query the sprite's original size.

Returns: Sprite size.

var getOriginalSize ( )

Query the sprite's original size.

Returns: Sprite size.

local getOriginalSize ( )

Query the sprite's original size.

Returns: Sprite size.

void setPreferredSize ( const Size & size )

Change the preferred size of Scale9Sprite.

Parameters

size	A delimitation zone.

var setPreferredSize ( var size )

Change the preferred size of Scale9Sprite.

Parameters

size	A delimitation zone.

local setPreferredSize ( local size )

Change the preferred size of Scale9Sprite.

Parameters

size	A delimitation zone.

Size getPreferredSize ( ) const

Query the Scale9Sprite's preferred size.

Returns: Scale9Sprite's preferred size.

var getPreferredSize ( )

Query the Scale9Sprite's preferred size.

Returns: Scale9Sprite's preferred size.

local getPreferredSize ( )

Query the Scale9Sprite's preferred size.

Returns: Scale9Sprite's preferred size.

void setInsetLeft ( float leftInset )

Change the left sprite's cap inset.

Parameters

leftInset The values to use for the cap inset.

var setInsetLeft ( var leftInset )

Change the left sprite's cap inset.

Parameters

leftInset The values to use for the cap inset.

local setInsetLeft ( local leftInset )

Change the left sprite's cap inset.

Parameters

leftInset The values to use for the cap inset.

float getInsetLeft ( ) const

Query the left sprite's cap inset.

Returns: The left sprite's cap inset.

var getInsetLeft ( )

Query the left sprite's cap inset.

Returns: The left sprite's cap inset.

local getInsetLeft ( )

Query the left sprite's cap inset.

Returns: The left sprite's cap inset.

void setInsetTop ( float topInset )

Change the top sprite's cap inset.

Parameters

topInset The values to use for the cap inset.

var setInsetTop ( var topInset )

Change the top sprite's cap inset.

Parameters

topInset The values to use for the cap inset.

local setInsetTop ( local topInset )

Change the top sprite's cap inset.

Parameters

topInset The values to use for the cap inset.

float getInsetTop ( ) const

Query the top sprite's cap inset.

Returns: The top sprite's cap inset.

var getInsetTop ( )

Query the top sprite's cap inset.

Returns: The top sprite's cap inset.

local getInsetTop ( )

Query the top sprite's cap inset.

Returns: The top sprite's cap inset.

void setInsetRight ( float rightInset )

Change the right sprite's cap inset.

Parameters

rightInset The values to use for the cap inset.

var setInsetRight ( var rightInset )

Change the right sprite's cap inset.

Parameters

rightInset The values to use for the cap inset.

local setInsetRight ( local rightInset )

Change the right sprite's cap inset.

Parameters

rightInset The values to use for the cap inset.

float getInsetRight ( ) const

Query the right sprite's cap inset.

Returns: The right sprite's cap inset.

var getInsetRight ( )

Query the right sprite's cap inset.

Returns: The right sprite's cap inset.

local getInsetRight ( )

Query the right sprite's cap inset.

Returns: The right sprite's cap inset.

void setInsetBottom ( float bottomInset )

Change the bottom sprite's cap inset.

Parameters

bottomInset The values to use for the cap inset.

var setInsetBottom ( var bottomInset )

Change the bottom sprite's cap inset.

Parameters

bottomInset The values to use for the cap inset.

local setInsetBottom ( local bottomInset )

Change the bottom sprite's cap inset.

Parameters

bottomInset The values to use for the cap inset.

float getInsetBottom ( ) const

Query the bottom sprite's cap inset.

Returns: The bottom sprite's cap inset.

var getInsetBottom ( )

Query the bottom sprite's cap inset.

Returns: The bottom sprite's cap inset.

local getInsetBottom ( )

Query the bottom sprite's cap inset.

Returns: The bottom sprite's cap inset.

void setScale9Enabled ( bool enabled )

Toggle 9-slice feature.

If Scale9Sprite is 9-slice disabled, the Scale9Sprite will rendered as a normal sprite.

Warning: : Don't use setScale9Enabled(false), use setRenderingType(RenderingType::SIMPLE) instead. The setScale9Enabled(false) is kept only for back back compatibility.

Parameters

enabled True to enable 9-slice, false otherwise.

local setScale9Enabled ( local enabled )

Toggle 9-slice feature.

If Scale9Sprite is 9-slice disabled, the Scale9Sprite will rendered as a normal sprite.

Warning: : Don't use setScale9Enabled(false), use setRenderingType(RenderingType::SIMPLE) instead. The setScale9Enabled(false) is kept only for back back compatibility.

Parameters

enabled True to enable 9-slice, false otherwise.

bool isScale9Enabled ( ) const

Query whether the Scale9Sprite is enable 9-slice or not.

Returns: True if 9-slice is enabled, false otherwise.

local isScale9Enabled ( )

Query whether the Scale9Sprite is enable 9-slice or not.

Returns: True if 9-slice is enabled, false otherwise.

Sprite* getSprite ( )

Get the original no 9-sliced sprite.

Returns: A sprite instance.

var getSprite ( )

Get the original no 9-sliced sprite.

Returns: A sprite instance.

local getSprite ( )

Get the original no 9-sliced sprite.

Returns: A sprite instance.

void setRenderingType ( RenderingType type )

Set the slice sprite rendering type.

When setting to SIMPLE, only 4 vertexes is used to rendering. otherwise 16 vertexes will be used to rendering.

See also: RenderingType

var setRenderingType ( var type )

Set the slice sprite rendering type.

When setting to SIMPLE, only 4 vertexes is used to rendering. otherwise 16 vertexes will be used to rendering.

See also: RenderingType

local setRenderingType ( local type )

Set the slice sprite rendering type.

When setting to SIMPLE, only 4 vertexes is used to rendering. otherwise 16 vertexes will be used to rendering.

See also: RenderingType

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

UIScale9Sprite.h

Public Types

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation