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

Inherits Node, and BlendProtocol.

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 std::string &file, const Rect &rect)
	Initializes a 9-slice sprite with a texture file and a delimitation zone. 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...

var	initWithFile ( var capInsets, var file)
	Initializes a 9-slice sprite with a texture file and with the specified cap insets. More...

local	initWithFile ( local capInsets, local file)
	Initializes a 9-slice sprite with a texture file and with the specified cap insets. More...

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

local	initWithFile ( local file)
	Initializes a 9-slice sprite with a texture file. 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...

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

virtual bool	initWithSpriteFrame (SpriteFrame *spriteFrame)
	Initializes a 9-slice sprite with an sprite frame. More...

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

virtual bool	initWithSpriteFrameName (const std::string &spriteFrameName)
	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...

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

local	init ( local sprite, local rect, local 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...

local	init ( local sprite, local rect, local rotated, local offset, local originalSize, local 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...

virtual void	setBlendFunc (const BlendFunc &blendFunc) override
	Sets the source blending function. More...

virtual const BlendFunc &	getBlendFunc () const override
	Returns the blending function that is currently being used. More...

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

local	resizableSpriteWithCapInsets ( local 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...

local	updateWithSprite ( local sprite, local rect, local rotated, local 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=Rect::ZERO)
	Change inner sprite's sprite frame. More...

var	setSpriteFrame ( var spriteFrame, var ZERO)
	Change inner sprite's sprite frame. More...

local	setSpriteFrame ( local spriteFrame, local ZERO)
	Change inner sprite's sprite frame. More...

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

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

var	setAnchorPoint ( var anchorPoint)
	Sets the anchor point in percent. More...

local	setAnchorPoint ( local anchorPoint)
	Sets the anchor point in percent. 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...

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

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

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

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

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

void	setCapInsets (const Rect &rect)
	Change the cap inset size. More...

local	setCapInsets ( local rect)
	Change the cap inset size. More...

Rect	getCapInsets () const
	Query the Scale9Sprite's prefered size. More...

local	getCapInsets ()
	Query the Scale9Sprite's prefered 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...

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

local	getInsetTop ()
	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...

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

local	getInsetBottom ()
	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...

virtual void	visit (Renderer *renderer, const Mat4 &parentTransform, uint32_t parentFlags) override
	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...

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

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

virtual void	onEnter () override
	Event callback that is invoked every time when Node enters the 'stage'. More...

virtual void	onEnterTransitionDidFinish () override
	Event callback that is invoked when the Node enters in the 'stage'. More...

virtual void	onExit () override
	Event callback that is invoked every time the Node leaves the 'stage'. More...

virtual void	onExitTransitionDidStart () override
	Event callback that is called every time the Node leaves the 'stage'. More...

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

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

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

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

var	setFlippedX ( var flippedX)
	Sets whether the widget should be flipped horizontally or not. More...

local	setFlippedX ( local flippedX)
	Sets whether the widget should be flipped horizontally or not. More...

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

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

var	setFlippedY ( var flippedY)
	Sets whether the widget should be flipped vertically or not. More...

local	setFlippedY ( local flippedY)
	Sets whether the widget should be flipped vertically or not. More...

virtual bool	isFlippedY () const
	Return the flag which indicates whether the widget is flipped vertically or not. More...

virtual void	setScaleX (float scaleX) override
	Sets the scale (x) of the node. More...

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

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

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

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

var	setScale ( var scale)
	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	setScale (float scaleX, float scaleY) override
	Sets the scale (x,y) of the node. More...

virtual float	getScaleX () const override
	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 override
	Returns the scale factor on Y axis of this node. More...

var	getScaleY ()
	Returns the scale factor on Y axis of this node. More...

local	getScaleY ()
	Returns the scale factor on Y axis of this node. More...

virtual float	getScale () const override
	Gets the scale factor of the node, when X and Y have the same scale factor. More...

var	getScale ()
	Gets the scale factor of the node, when X and Y have the same scale factor. More...

local	getScale ()
	Gets the scale factor of the node, when X and Y have the same scale factor. More...

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

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

virtual void	draw (Renderer *renderer, const Mat4 &transform, uint32_t flags)
	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 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...

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

void	setPhysicsBody (PhysicsBody *body)
	Set the PhysicsBody that let the sprite effect with physics. More...

PhysicsBody *	getPhysicsBody () const
	Get the PhysicsBody the sprite have. More...

var	getPhysicsBody ()
	Get the PhysicsBody the sprite have. More...

local	getPhysicsBody ()
	Get the PhysicsBody the sprite have. More...

void	removeFromPhysicsWorld ()
	Remove this node from physics world. More...

var	removeFromPhysicsWorld ()
	Remove this node from physics world. More...

local	removeFromPhysicsWorld ()
	Remove this node from physics world. More...

void	updateTransformFromPhysics (const Mat4 &parentTransform, uint32_t parentFlags)
	Update the transform matrix from physics.

var	updateTransformFromPhysics ( var parentTransform, var parentFlags)
	Update the transform matrix from physics.

local	updateTransformFromPhysics ( local parentTransform, local parentFlags)
	Update the transform matrix from physics.

virtual void	updatePhysicsBodyTransform (const Mat4 &parentTransform, uint32_t parentFlags, float parentScaleX, float parentScaleY)
	Update physics body transform matrix.

var	updatePhysicsBodyTransform ( var parentTransform, var parentFlags, var parentScaleX, var parentScaleY)
	Update physics body transform matrix.

local	updatePhysicsBodyTransform ( local parentTransform, local parentFlags, local parentScaleX, local parentScaleY)
	Update physics body transform matrix.

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	setLocalZOrder (int localZOrder)
	LocalZOrder is the 'key' used to sort the node relative to its siblings. More...

virtual void	setZOrder (int localZOrder)
virtual void	_setLocalZOrder (int z)
var	_setLocalZOrder ( var z)
local	_setLocalZOrder ( local z)
virtual int	getLocalZOrder () const
	Gets the local Z order of this node. More...

var	getLocalZOrder ()
	Gets the local Z order of this node. More...

local	getLocalZOrder ()
	Gets the local Z order of this node. More...

virtual int	getZOrder () const
virtual void	setGlobalZOrder (float globalZOrder)
	Defines the oder in which the nodes are renderer. More...

local	setGlobalZOrder ( local globalZOrder)
	Defines the oder 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 void	setScaleZ (float scaleZ)
	Changes the scale factor on Z axis of this node. More...

var	setScaleZ ( var 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 void	setPosition (const Vec2 &position)
	Sets the position (x,y) of the node in its parent's coordinate system. More...

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

virtual void	setNormalizedPosition (const Vec2 &position)
	Sets the position (x,y) using values between 0 and 1. More...

var	setNormalizedPosition ( var position)
	Sets the position (x,y) using values between 0 and 1. More...

local	setNormalizedPosition ( local position)
	Sets the position (x,y) using values between 0 and 1. More...

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

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

local	getNormalizedPosition ()
	Returns the normalized position. More...

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

var	setPosition ( var x, var y)
	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	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...

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

virtual float	getPositionY (void) const
	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...

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

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

var	setVertexZ ( var positionZ)
	Sets the 'z' coordinate in the position. More...

local	setPositionZ ( local positionZ)
	Sets the 'z' coordinate in the position. 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...

var	getVertexZ ()
	Gets position Z coordinate of this node. More...

local	getPositionZ ()
	Gets position Z coordinate of this node. More...

virtual float	getVertexZ () const
virtual void	setSkewX (float skewX)
	Changes the X skew angle of the node in degrees. More...

local	setSkewX ( local skewX)
	Changes the X skew angle of the node in degrees. More...

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

var	getSkewX ()
	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 void	setSkewY (float skewY)
	Changes the Y skew angle of the node in degrees. More...

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

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

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

var	getSkewY ()
	Returns the Y skew angle of the node in degrees. More...

local	getSkewY ()
	Returns the Y skew angle of the node in degrees. More...

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

local	getAnchorPoint ()
	Returns the anchor point in percent. More...

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

local	getAnchorPointInPoints ()
	Returns the anchorPoint in absolute pixels. More...

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

local	getContentSize ()
	Returns the untransformed size of the node. More...

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

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

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

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

local	setRotation ( local rotation)
	Sets the rotation (angle) of the node in degrees. More...

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

virtual void	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...

local	setRotationQuat ( local 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...

virtual void	setRotationSkewX (float rotationX)
	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	setRotationX (float rotationX)
var	setRotationX ( var 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...

var	getRotationX ()
	Gets the X rotation (angle) of the node in degrees which performs a horizontal rotation skew. More...

local	getRotationSkewX ()
	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	setRotationSkewY (float rotationY)
	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	setRotationY (float 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	setOrderOfArrival (int orderOfArrival)
	Sets the arrival order when this node has a same ZOrder with other children. More...

int	getOrderOfArrival () const
	Returns the arrival order, indicates which children is added previously. More...

void	setGLServerState (int serverState)
var	setGLServerState ( var serverState)
int	getGLServerState () const
virtual void	ignoreAnchorPointForPosition (bool ignore)
	Sets whether the anchor point will be (0,0) when you position this node. More...

virtual bool	isIgnoreAnchorPointForPosition () const
	Gets whether the anchor point will be (0,0) when you position this node. More...

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

var	addChild ( var child)
	Adds a child to the container with z-order as 0. More...

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

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

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

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

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

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

local	getChildByTag ( local tag)
	Gets a child from the container with its tag. 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...

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
local	getChildren ()
virtual ssize_t	getChildrenCount () const
	Returns the amount of children. More...

var	getChildrenCount ()
	Returns the amount of children. More...

local	getChildrenCount ()
	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
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	removeChild (Node *child, bool cleanup=true)
	Removes a child from the container. More...

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

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

local	removeChildByTag ( local tag, local true)
	Removes a child from the container by tag value. More...

virtual void	removeChildByName (const std::string &name, bool cleanup=true)
	Removes a child from the container by tag value. More...

var	removeChildByName ( var name, var true)
	Removes a child from the container by tag value. More...

local	removeChildByName ( local name, local true)
	Removes a child from the container by tag value. More...

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

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

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

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

var	removeAllChildren ( var cleanup)
	Removes all children from the container, and do a cleanup to all running actions depending on the cleanup parameter. More...

local	removeAllChildren ( local cleanup)
	Removes all children from the container, and do a cleanup to all running actions depending on the cleanup parameter. More...

virtual void	reorderChild (Node *child, int localZOrder)
	Reorders a child according to a new z value. More...

local	reorderChild ( local child, local localZOrder)
	Reorders a child according to a new z value. More...

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

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

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

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

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

var	setGLProgramState ( var glProgramState)
	Set the GLProgramState for this node. More...

local	setGLProgramState ( local glProgramState)
	Set the GLProgramState for this node. 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...

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

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

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

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

local	getNumberOfRunningActions ()
	Returns the numbers of actions that are running plus the ones that are schedule to run (actions in actionsToAdd and actions arrays). More...

ssize_t	numberOfRunningActions () const
var	numberOfRunningActions ()
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 Sheduler object. More...

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

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

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

void	scheduleUpdate (void)
	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...

var	scheduleOnce ( var selector, var 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...

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

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

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

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

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 void	updateTransform ()
	Calls children's updateTransform() method recursively. More...

var	updateTransform ()
	Calls children's updateTransform() method recursively. More...

local	updateTransform ()
	Calls children's updateTransform() method recursively. 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 void	setNodeToParentTransform (const Mat4 &transform)
	Sets the transformation matrix manually. More...

virtual AffineTransform	nodeToParentTransform () const
local	nodeToParentTransform ()
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...

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

Vec2	convertTouchToNodeSpace (Touch *touch) const
	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 (Mat4 *additionalTransform)
	Sets an additional transform matrix to the node. More...

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

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

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

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

virtual void	removeAllComponents ()
	Removes all components.

virtual std::string	getDescription () const
	Gets the description string. More...

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

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

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

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

int	_luaID
	Lua reference id.

void *	_scriptObject
	scriptObject, support for swift

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.

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 intract. 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 intract. 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 intract. 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 intract. 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 intract. 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 intract. 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 intract. 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 intract. 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 intract. 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 intract. 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 intract. 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 intract. 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 intract. 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 intract. 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 intract. 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 std::string &	file,
		const Rect &	rect
	)

virtual

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

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

Parameters

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.

var initWithFile	(	var	file,
		var	rect
	)

virtual

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

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

Parameters

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.

local initWithFile	(	local	file,
		local	rect
	)

virtual

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

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

Parameters

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.

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 intract. 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 intract. 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 intract. 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 initWithFile ( const std::string & file )

virtual

Initializes a 9-slice sprite with a texture file.

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

Parameters

file	The name of the texture file.

Returns: True if initializes success, false otherwise.

var initWithFile ( var file )

virtual

Initializes a 9-slice sprite with a texture file.

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

Parameters

file	The name of the texture file.

Returns: True if initializes success, false otherwise.

local initWithFile ( local file )

virtual

Initializes a 9-slice sprite with a texture file.

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

Parameters

file	The name of the texture file.

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 intract. 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 intract. 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 intract. 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 initWithSpriteFrame ( SpriteFrame * spriteFrame )

virtual

Initializes a 9-slice sprite with an sprite frame.

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

Parameters

spriteFrame The sprite frame object.

Returns: True if initializes success, false otherwise.

var initWithSpriteFrame ( var spriteFrame )

virtual

Initializes a 9-slice sprite with an sprite frame.

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

Parameters

spriteFrame The sprite frame object.

Returns: True if initializes success, false otherwise.

local initWithSpriteFrame ( local spriteFrame )

virtual

Initializes a 9-slice sprite with an sprite frame.

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

Parameters

spriteFrame The sprite frame object.

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 intract. 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 intract. 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 intract. 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
initWithSpriteFrameName ( const std::string & spriteFrameName )

virtual

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

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

Parameters

spriteFrameName The sprite frame name.

Returns: True if initializes success, false otherwise.

var initWithSpriteFrameName ( var spriteFrameName )

virtual

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

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

Parameters

spriteFrameName The sprite frame name.

Returns: True if initializes success, false otherwise.

local initWithSpriteFrameName ( local spriteFrameName )

virtual

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

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

Parameters

spriteFrameName The sprite frame name.

Returns: True if initializes success, false otherwise.

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

virtual void setBlendFunc ( const BlendFunc & blendFunc )

overridevirtual

Sets the source blending function.

Parameters

blendFunc A structure with source and destination factor to specify pixel arithmetic. e.g. {GL_ONE, GL_ONE}, {GL_SRC_ALPHA, GL_ONE_MINUS_SRC_ALPHA}.

virtual const BlendFunc&
getBlendFunc ( ) const

overridevirtual

Returns the blending function that is currently being used.

Returns: A BlendFunc structure with source and destination factor which specified pixel arithmetic.

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 origial 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 origial 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 = `Rect::ZERO`
	)

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 = `Rect::ZERO`
	)

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 = `Rect::ZERO`
	)

virtual

Change inner sprite's sprite frame.

Parameters

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

virtual void setContentSize ( const Size & contentSize )

overridevirtual

Sets the untransformed size of the node.

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

Parameters

contentSize The untransformed size of the node.

Reimplemented from Node.

var setContentSize ( var contentSize )

overridevirtual

Sets the untransformed size of the node.

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

Parameters

contentSize The untransformed size of the node.

Reimplemented from Node.

local setContentSize ( local contentSize )

overridevirtual

Sets the untransformed size of the node.

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

Parameters

contentSize The untransformed size of the node.

Reimplemented from Node.

virtual void setAnchorPoint ( const Vec2 & anchorPoint )

overridevirtual

Sets the anchor point in percent.

anchorPoint is the point around which all transformations and positioning manipulations take place. It's like a pin in the node where it is "attached" to its parent. The anchorPoint is normalized, like a percentage. (0,0) means the bottom-left corner and (1,1) means the top-right corner. But you can use values higher than (1,1) and lower than (0,0) too. The default anchorPoint is (0.5,0.5), so it starts in the center of the node.

Note: If node has a physics body, the anchor must be in the middle, you cann't change this to other value.

Parameters

anchorPoint The anchor point of node.

Reimplemented from Node.

var setAnchorPoint ( var anchorPoint )

overridevirtual

Sets the anchor point in percent.

anchorPoint is the point around which all transformations and positioning manipulations take place. It's like a pin in the node where it is "attached" to its parent. The anchorPoint is normalized, like a percentage. (0,0) means the bottom-left corner and (1,1) means the top-right corner. But you can use values higher than (1,1) and lower than (0,0) too. The default anchorPoint is (0.5,0.5), so it starts in the center of the node.

Note: If node has a physics body, the anchor must be in the middle, you cann't change this to other value.

Parameters

anchorPoint The anchor point of node.

Reimplemented from Node.

local setAnchorPoint ( local anchorPoint )

overridevirtual

Sets the anchor point in percent.

anchorPoint is the point around which all transformations and positioning manipulations take place. It's like a pin in the node where it is "attached" to its parent. The anchorPoint is normalized, like a percentage. (0,0) means the bottom-left corner and (1,1) means the top-right corner. But you can use values higher than (1,1) and lower than (0,0) too. The default anchorPoint is (0.5,0.5), so it starts in the center of the node.

Note: If node has a physics body, the anchor must be in the middle, you cann't change this to other value.

Parameters

anchorPoint The anchor point of node.

Reimplemented from Node.

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

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 prefered size of Scale9Sprite.

Parameters

size	A delimitation zone.

var setPreferredSize ( var size )

Change the prefered size of Scale9Sprite.

Parameters

size	A delimitation zone.

local setPreferredSize ( local size )

Change the prefered size of Scale9Sprite.

Parameters

size	A delimitation zone.

Size getPreferredSize ( ) const

Query the Scale9Sprite's prefered size.

Returns: Scale9Sprite's prefered size.

var getPreferredSize ( )

Query the Scale9Sprite's prefered size.

Returns: Scale9Sprite's prefered size.

local getPreferredSize ( )

Query the Scale9Sprite's prefered size.

Returns: Scale9Sprite's prefered size.

void setCapInsets ( const Rect & rect )

Change the cap inset size.

Parameters

rect	A delimitation zone.

var setCapInsets ( var rect )

Change the cap inset size.

Parameters

rect	A delimitation zone.

local setCapInsets ( local rect )

Change the cap inset size.

Parameters

rect	A delimitation zone.

Rect getCapInsets ( ) const

Query the Scale9Sprite's prefered size.

Returns: Scale9Sprite's cap inset.

var getCapInsets ( )

Query the Scale9Sprite's prefered size.

Returns: Scale9Sprite's cap inset.

local getCapInsets ( )

Query the Scale9Sprite's prefered size.

Returns: Scale9Sprite's cap inset.

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.

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.

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.

virtual void visit	(	Renderer *	renderer,
		const Mat4 &	parentTransform,
		uint32_t	parentFlags
	)

overridevirtual

Visits this node's children and draw them recursively.

Parameters

renderer	A given renderer.
parentTransform	A transform matrix.
parentFlags	Renderer flag.

Reimplemented from Node.

var visit	(	var	renderer,
		var	parentTransform,
		var	parentFlags
	)

overridevirtual

Visits this node's children and draw them recursively.

Parameters

renderer	A given renderer.
parentTransform	A transform matrix.
parentFlags	Renderer flag.

Reimplemented from Node.

local visit	(	local	renderer,
		local	parentTransform,
		local	parentFlags
	)

overridevirtual

Visits this node's children and draw them recursively.

Parameters

renderer	A given renderer.
parentTransform	A transform matrix.
parentFlags	Renderer flag.

Reimplemented from Node.

virtual void onEnter ( )

overridevirtual

Event callback that is invoked every time when Node enters the 'stage'.

If the Node enters the 'stage' with a transition, this event is called when the transition starts. During onEnter you can't access a "sister/brother" node. If you override onEnter, you shall call its parent's one, e.g., Node::onEnter().

Reimplemented from Node.

var onEnter ( )

overridevirtual

Event callback that is invoked every time when Node enters the 'stage'.

If the Node enters the 'stage' with a transition, this event is called when the transition starts. During onEnter you can't access a "sister/brother" node. If you override onEnter, you shall call its parent's one, e.g., Node::onEnter().

Reimplemented from Node.

virtual void
onEnterTransitionDidFinish ( )

overridevirtual

Event callback that is invoked when the Node enters in the 'stage'.

If the Node enters the 'stage' with a transition, this event is called when the transition finishes. If you override onEnterTransitionDidFinish, you shall call its parent's one, e.g. Node::onEnterTransitionDidFinish()

Reimplemented from Node.

virtual void onExit ( )

overridevirtual

Event callback that is invoked every time the Node leaves the 'stage'.

If the Node leaves the 'stage' with a transition, this event is called when the transition finishes. During onExit you can't access a sibling node. If you override onExit, you shall call its parent's one, e.g., Node::onExit().

Reimplemented from Node.

virtual void
onExitTransitionDidStart ( )

overridevirtual

Event callback that is called every time the Node leaves the 'stage'.

If the Node leaves the 'stage' with a transition, this callback is called when the transition starts.

Reimplemented from Node.

Sprite* getSprite ( ) const

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.

virtual void setFlippedX ( bool flippedX )

virtual

Sets whether the widget should be flipped horizontally or not.

Parameters

flippedX true if the widget should be flipped horizontally, false otherwise.

var setFlippedX ( var flippedX )

virtual

Sets whether the widget should be flipped horizontally or not.

Parameters

flippedX true if the widget should be flipped horizontally, false otherwise.

local setFlippedX ( local flippedX )

virtual

Sets whether the widget should be flipped horizontally or not.

Parameters

flippedX true if the widget should be flipped horizontally, false otherwise.

virtual bool isFlippedX ( ) const

virtual

Returns the flag which indicates whether the widget is flipped horizontally or not.

It only flips the texture of the widget, and not the texture of the widget's children. Also, flipping the texture doesn't alter the anchorPoint. If you want to flip the anchorPoint too, and/or to flip the children too use: widget->setScaleX(sprite->getScaleX() * -1);

Returns: true if the widget is flipped horizontally, false otherwise.

var isFlippedX ( )

virtual

Returns the flag which indicates whether the widget is flipped horizontally or not.

It only flips the texture of the widget, and not the texture of the widget's children. Also, flipping the texture doesn't alter the anchorPoint. If you want to flip the anchorPoint too, and/or to flip the children too use: widget->setScaleX(sprite->getScaleX() * -1);

Returns: true if the widget is flipped horizontally, false otherwise.

local isFlippedX ( )

virtual

Returns the flag which indicates whether the widget is flipped horizontally or not.

It only flips the texture of the widget, and not the texture of the widget's children. Also, flipping the texture doesn't alter the anchorPoint. If you want to flip the anchorPoint too, and/or to flip the children too use: widget->setScaleX(sprite->getScaleX() * -1);

Returns: true if the widget is flipped horizontally, false otherwise.

virtual void setFlippedY ( bool flippedY )

virtual

Sets whether the widget should be flipped vertically or not.

Parameters

flippedY true if the widget should be flipped vertically, false otherwise.

var setFlippedY ( var flippedY )

virtual

Sets whether the widget should be flipped vertically or not.

Parameters

flippedY true if the widget should be flipped vertically, false otherwise.

local setFlippedY ( local flippedY )

virtual

Sets whether the widget should be flipped vertically or not.

Parameters

flippedY true if the widget should be flipped vertically, false otherwise.

virtual bool isFlippedY ( ) const

virtual

Return the flag which indicates whether the widget is flipped vertically or not.

It only flips the texture of the widget, and not the texture of the widget's children. Also, flipping the texture doesn't alter the anchorPoint. If you want to flip the anchorPoint too, and/or to flip the children too use: widget->setScaleY(widget->getScaleY() * -1);

Returns: true if the widget is flipped vertically, flase otherwise.

var isFlippedY ( )

virtual

Return the flag which indicates whether the widget is flipped vertically or not.

It only flips the texture of the widget, and not the texture of the widget's children. Also, flipping the texture doesn't alter the anchorPoint. If you want to flip the anchorPoint too, and/or to flip the children too use: widget->setScaleY(widget->getScaleY() * -1);

Returns: true if the widget is flipped vertically, flase otherwise.

local isFlippedY ( )

virtual

Return the flag which indicates whether the widget is flipped vertically or not.

It only flips the texture of the widget, and not the texture of the widget's children. Also, flipping the texture doesn't alter the anchorPoint. If you want to flip the anchorPoint too, and/or to flip the children too use: widget->setScaleY(widget->getScaleY() * -1);

Returns: true if the widget is flipped vertically, flase otherwise.

virtual void setScaleX ( float scaleX )

overridevirtual

Sets the scale (x) of the node.

It is a scaling factor that multiplies the width of the node and its children.

Parameters

scaleX The scale factor on X axis.

Warning: The physics body doesn't support this.

Reimplemented from Node.

var setScaleX ( var scaleX )

overridevirtual

Sets the scale (x) of the node.

It is a scaling factor that multiplies the width of the node and its children.

Parameters

scaleX The scale factor on X axis.

Warning: The physics body doesn't support this.

Reimplemented from Node.

local setScaleX ( local scaleX )

overridevirtual

Sets the scale (x) of the node.

It is a scaling factor that multiplies the width of the node and its children.

Parameters

scaleX The scale factor on X axis.

Warning: The physics body doesn't support this.

Reimplemented from Node.

virtual void setScaleY ( float scaleY )

overridevirtual

Sets the scale (y) of the node.

It is a scaling factor that multiplies the height of the node and its children.

Parameters

scaleY The scale factor on Y axis.

Warning: The physics body doesn't support this.

Reimplemented from Node.

var setScaleY ( var scaleY )

overridevirtual

Sets the scale (y) of the node.

It is a scaling factor that multiplies the height of the node and its children.

Parameters

scaleY The scale factor on Y axis.

Warning: The physics body doesn't support this.

Reimplemented from Node.

local setScaleY ( local scaleY )

overridevirtual

Sets the scale (y) of the node.

It is a scaling factor that multiplies the height of the node and its children.

Parameters

scaleY The scale factor on Y axis.

Warning: The physics body doesn't support this.

Reimplemented from Node.

virtual void setScale ( float scale )

overridevirtual

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

It is a scaling factor that multiplies the width, height and depth of the node and its children.

Parameters

scale The scale factor for both X and Y axis.

Warning: The physics body doesn't support this.

Reimplemented from Node.

var setScale ( var scale )

overridevirtual

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

It is a scaling factor that multiplies the width, height and depth of the node and its children.

Parameters

scale The scale factor for both X and Y axis.

Warning: The physics body doesn't support this.

Reimplemented from Node.

local setScale ( local scale )

overridevirtual

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

It is a scaling factor that multiplies the width, height and depth of the node and its children.

Parameters

scale The scale factor for both X and Y axis.

Warning: The physics body doesn't support this.

Reimplemented from Node.

virtual void setScale	(	float	scaleX,
		float	scaleY
	)

overridevirtual

Sets the scale (x,y) of the node.

It is a scaling factor that multiplies the width and height of the node and its children.

Parameters

scaleX	The scale factor on X axis.
scaleY	The scale factor on Y axis.

Warning: The physics body doesn't support this.

Reimplemented from Node.

var setScale	(	var	scaleX,
		var	scaleY
	)

overridevirtual

Sets the scale (x,y) of the node.

It is a scaling factor that multiplies the width and height of the node and its children.

Parameters

scaleX	The scale factor on X axis.
scaleY	The scale factor on Y axis.

Warning: The physics body doesn't support this.

Reimplemented from Node.

local setScale	(	local	scaleX,
		local	scaleY
	)

overridevirtual

Sets the scale (x,y) of the node.

It is a scaling factor that multiplies the width and height of the node and its children.

Parameters

scaleX	The scale factor on X axis.
scaleY	The scale factor on Y axis.

Warning: The physics body doesn't support this.

Reimplemented from Node.

virtual float getScaleX ( ) const

overridevirtual

Returns the scale factor on X axis of this node.

See also: setScaleX(float)

Returns: The scale factor on X axis.

Reimplemented from Node.

var getScaleX ( )

overridevirtual

Returns the scale factor on X axis of this node.

See also: setScaleX(float)

Returns: The scale factor on X axis.

Reimplemented from Node.

local getScaleX ( )

overridevirtual

Returns the scale factor on X axis of this node.

See also: setScaleX(float)

Returns: The scale factor on X axis.

Reimplemented from Node.

virtual float getScaleY ( ) const

overridevirtual

Returns the scale factor on Y axis of this node.

See also: setScaleY(float)

Returns: The scale factor on Y axis.

Reimplemented from Node.

var getScaleY ( )

overridevirtual

Returns the scale factor on Y axis of this node.

See also: setScaleY(float)

Returns: The scale factor on Y axis.

Reimplemented from Node.

local getScaleY ( )

overridevirtual

Returns the scale factor on Y axis of this node.

See also: setScaleY(float)

Returns: The scale factor on Y axis.

Reimplemented from Node.

virtual float getScale ( ) const

overridevirtual

Gets the scale factor of the node, when X and Y have the same scale factor.

Warning: Assert when _scaleX != _scaleY

See also: setScale(float)

Returns: The scale factor of the node.

Reimplemented from Node.

var getScale ( )

overridevirtual

Gets the scale factor of the node, when X and Y have the same scale factor.

Warning: Assert when _scaleX != _scaleY

See also: setScale(float)

Returns: The scale factor of the node.

Reimplemented from Node.

local getScale ( )

overridevirtual

Gets the scale factor of the node, when X and Y have the same scale factor.

Warning: Assert when _scaleX != _scaleY

See also: setScale(float)

Returns: The scale factor of the node.

Reimplemented from Node.

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