Cocos2d-x  v4
Scale9Sprite Class Reference

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

Inherits Sprite.

Public Types

enum  State
 Builtin shader state. More...
 

Public Member Functions

 Scale9Sprite ()
 Default constructor. More...
 
virtual ~Scale9Sprite ()
 Default destructor. More...
 
virtual bool initWithFile (const std::string &file, const Rect &rect, const Rect &capInsets)
 Initializes a 9-slice sprite with a texture file, a delimitation zone and with the specified cap insets. More...
 
virtual bool initWithFile (const Rect &capInsets, const std::string &file)
 Initializes a 9-slice sprite with a texture file and with the specified cap insets. More...
 
virtual bool initWithSpriteFrame (SpriteFrame *spriteFrame, const Rect &capInsets)
 Initializes a 9-slice sprite with an sprite frame and with the specified cap insets. More...
 
virtual bool initWithSpriteFrameName (const std::string &spriteFrameName, const Rect &capInsets)
 Initializes a 9-slice sprite with an sprite frame name and with the specified cap insets. More...
 
virtual bool initWithFile (const std::string &file, const Rect &rect) override
 Initializes a 9-slice sprite with a texture file and a delimitation zone. More...
 
virtual bool initWithFile (const std::string &file) override
 Initializes a 9-slice sprite with a texture file. More...
 
virtual bool initWithSpriteFrameName (const std::string &spriteFrameName) override
 Initializes a 9-slice sprite with an sprite frame name. More...
 
virtual bool init (Sprite *sprite, const Rect &rect, bool rotated, const Rect &capInsets)
 Initializes a 9-slice sprite with an sprite instance. More...
 
virtual bool init (Sprite *sprite, const Rect &rect, const Rect &capInsets)
 Initializes a 9-slice sprite with an sprite instance. More...
 
virtual bool init (Sprite *sprite, const Rect &rect, bool rotated, const Vec2 &offset, const Size &originalSize, const Rect &capInsets)
 Initializes a 9-slice sprite with an sprite instance. More...
 
Scale9SpriteresizableSpriteWithCapInsets (const Rect &capInsets) const
 Creates and returns a new sprite object with the specified cap insets. More...
 
virtual bool updateWithSprite (Sprite *sprite, const Rect &rect, bool rotated, const Rect &capInsets)
 Update Scale9Sprite with a specified sprite. More...
 
virtual bool updateWithSprite (Sprite *sprite, const Rect &rect, bool rotated, const Vec2 &offset, const Size &originalSize, const Rect &capInsets)
 Update Scale9Sprite with a specified sprite. More...
 
virtual void setSpriteFrame (SpriteFrame *spriteFrame, const Rect &capInsets)
 Change inner sprite's sprite frame. More...
 
void setState (State state)
 Change the state of 9-slice sprite. More...
 
State getState () const
 Query the current bright state. More...
 
Size getOriginalSize () const
 Query the sprite's original size. More...
 
void setPreferredSize (const Size &size)
 Change the preferred size of Scale9Sprite. More...
 
Size getPreferredSize () const
 Query the Scale9Sprite's preferred size. More...
 
void setInsetLeft (float leftInset)
 Change the left sprite's cap inset. More...
 
float getInsetLeft () const
 Query the left sprite's cap inset. More...
 
void setInsetTop (float topInset)
 Change the top sprite's cap inset. More...
 
float getInsetTop () const
 Query the top sprite's cap inset. More...
 
void setInsetRight (float rightInset)
 Change the right sprite's cap inset. More...
 
float getInsetRight () const
 Query the right sprite's cap inset. More...
 
void setInsetBottom (float bottomInset)
 Change the bottom sprite's cap inset. More...
 
float getInsetBottom () const
 Query the bottom sprite's cap inset. More...
 
void setScale9Enabled (bool enabled)
 Toggle 9-slice feature. More...
 
bool isScale9Enabled () const
 Query whether the Scale9Sprite is enable 9-slice or not. More...
 
SpritegetSprite ()
 Get the original no 9-sliced sprite. More...
 
void copyTo (Scale9Sprite *copy) const
 copies self to copy
 
void setRenderingType (RenderingType type)
 Set the slice sprite rendering type. More...
 
RenderingType getRenderingType () const
 Return the slice sprite rendering type.
 
void setCapInsets (const Rect &insets)
 Set the Cap Insets in Points using the untrimmed size as reference.
 
Rect getCapInsets () const
 Returns the Cap Insets.
 
virtual bool initWithFile (const std::string &filename)
 Initializes a sprite with an image filename. More...
 
virtual bool initWithFile (const std::string &filename, const Rect &rect)
 Initializes a sprite with an image filename, and a rect. More...
 
virtual bool initWithSpriteFrame (SpriteFrame *spriteFrame)
 Initializes a sprite with an SpriteFrame. More...
 
virtual bool initWithSpriteFrameName (const std::string &spriteFrameName)
 Initializes a sprite with an sprite frame name. More...
 
virtual void setSpriteFrame (const std::string &spriteFrameName)
 
- Public Member Functions inherited from Sprite
virtual bool isFrameDisplayed (SpriteFrame *frame) const
 Returns whether or not a SpriteFrame is being displayed.
 
virtual SpriteFramegetSpriteFrame () const
 Returns the current displayed frame.
 
V3F_C4B_T2F_Quad getQuad () const
 Returns the quad (tex coords, vertex coords and color) information. More...
 
bool isTextureRectRotated () const
 Returns whether or not the texture rectangle is rotated.
 
unsigned int getAtlasIndex () const
 Returns the index used on the TextureAtlas.
 
void setAtlasIndex (unsigned int atlasIndex)
 Sets the index used on the TextureAtlas. More...
 
const RectgetTextureRect () const
 Returns the rect of the Sprite in points.
 
TextureAtlasgetTextureAtlas () const
 Gets the weak reference of the TextureAtlas when the sprite is rendered using via SpriteBatchNode.
 
virtual void setProgramState (backend::ProgramState *programState) override
 Set ProgramState.
 
virtual backend::ProgramState * getProgramState () const override
 Get current ProgramState.
 
void setTextureAtlas (TextureAtlas *textureAtlas)
 Sets the weak reference of the TextureAtlas when the sprite is rendered using via SpriteBatchNode.
 
const Vec2getOffsetPosition () const
 Gets the offset position of the sprite. More...
 
bool isFlippedX () const
 Returns the flag which indicates whether the sprite is flipped horizontally or not. More...
 
void setFlippedX (bool flippedX)
 Sets whether the sprite should be flipped horizontally or not. More...
 
bool isFlippedY () const
 Return the flag which indicates whether the sprite is flipped vertically or not. More...
 
void setFlippedY (bool flippedY)
 Sets whether the sprite should be flipped vertically or not. More...
 
const PolygonInfogetPolygonInfo () const
 returns a reference of the polygon information associated with this sprite More...
 
void setPolygonInfo (const PolygonInfo &info)
 set the sprite to use this new PolygonInfo More...
 
void setStretchEnabled (bool enabled)
 whether or not contentSize stretches the sprite's texture
 
bool isStretchEnabled () const
 returns whether or not contentSize stretches the sprite's texture
 
virtual void updateTransform () override
 Updates the quad according the rotation, position, scale values.
 
virtual SpriteBatchNodegetBatchNode () const
 Returns the batch node object if this sprite is rendered by SpriteBatchNode. More...
 
virtual void setBatchNode (SpriteBatchNode *spriteBatchNode)
 Sets the batch node to sprite. More...
 
virtual void setTexture (const std::string &filename)
 Sets a new texture (from a filename) to the sprite. More...
 
virtual void setTexture (Texture2D *texture) override
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.The Texture's rect is not changed.
 
virtual Texture2DgetTexture () const override
 Returns the Texture2D object used by the sprite.
 
virtual void setTextureRect (const Rect &rect)
 Updates the texture rect of the Sprite in points. More...
 
virtual void setTextureRect (const Rect &rect, bool rotated, const Size &untrimmedSize)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.It will update the texture coordinates and the vertex rectangle.
 
virtual void setVertexRect (const Rect &rect)
 Sets the vertex rect. More...
 
virtual void setCenterRectNormalized (const Rect &rect)
 setCenterRectNormalized More...
 
virtual Rect getCenterRectNormalized () const
 getCenterRectNormalized More...
 
virtual void setCenterRect (const Rect &rect)
 
virtual Rect getCenterRect () const
 Returns the Cap Insets rect. More...
 
virtual void setSpriteFrame (const std::string &spriteFrameName)
 
virtual void setSpriteFrame (SpriteFrame *newFrame)
 
virtual void setDisplayFrameWithAnimationName (const std::string &animationName, unsigned int frameIndex)
 Changes the display frame with animation name and index. More...
 
virtual bool isDirty () const
 Whether or not the Sprite needs to be updated in the Atlas. More...
 
virtual void setDirty (bool dirty)
 Makes the Sprite to be updated in the Atlas.
 
virtual std::string getDescription () const override
 @js NA
 
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...
 
virtual void setScale (float scaleX, float scaleY) override
 Sets the scale (x,y) of the node. More...
 
virtual void setPosition (const Vec2 &pos) override
 @js NA @lua NA
 
virtual void setPosition (float x, float y) override
 Sets the position (x,y) of the node in its parent's coordinate system. More...
 
virtual void setRotation (float rotation) override
 Sets the rotation (angle) of the node in degrees. More...
 
virtual void setRotationSkewX (float rotationX) override
 Sets the X rotation (angle) of the node in degrees which performs a horizontal rotational skew. More...
 
virtual void setRotationSkewY (float rotationY) override
 Sets the Y rotation (angle) of the node in degrees which performs a vertical rotational skew. More...
 
virtual void setSkewX (float sx) override
 Changes the X skew angle of the node in degrees. More...
 
virtual void setSkewY (float sy) override
 Changes the Y skew angle of the node in degrees. More...
 
virtual void removeChild (Node *child, bool cleanup) override
 Removes a child from the container. More...
 
virtual void removeAllChildrenWithCleanup (bool cleanup) override
 Removes all children from the container, and do a cleanup to all running actions depending on the cleanup parameter. More...
 
virtual void reorderChild (Node *child, int zOrder) override
 Reorders a child according to a new z value. More...
 
virtual void addChild (Node *child, int zOrder, int tag) override
 Adds a child to the container with z order and tag. More...
 
virtual void addChild (Node *child, int zOrder, const std::string &name) override
 Adds a child to the container with z order and tag. More...
 
virtual void sortAllChildren () override
 Sorts the children array once before drawing, instead of every time when a child is added or reordered. More...
 
virtual void setScale (float scale) override
 Sets the scale (x,y,z) of the node. More...
 
virtual void setPositionZ (float positionZ) override
 Sets the 'z' coordinate in the position. More...
 
virtual void setAnchorPoint (const Vec2 &anchor) override
 Sets the anchor point in percent. More...
 
virtual void setContentSize (const Size &size) override
 Sets the untransformed size of the node. More...
 
virtual void setIgnoreAnchorPointForPosition (bool value) override
 Sets whether the anchor point will be (0,0) when you position this node. More...
 
virtual void setVisible (bool bVisible) override
 Sets whether the node is visible. More...
 
virtual void draw (Renderer *renderer, const Mat4 &transform, uint32_t flags) override
 Override this method to draw your own node. More...
 
virtual void setOpacityModifyRGB (bool modify) override
 If you want the opacity affect the color property, then set to true. More...
 
virtual bool isOpacityModifyRGB () const override
 If node opacity will modify the RGB color value, then you should override this method and return true. More...
 
virtual void addChild (Node *child)
 Adds a child to the container with z-order as 0. More...
 
virtual void addChild (Node *child, int localZOrder)
 Adds a child to the container with a local z-order. More...
 
virtual void addChild (Node *child, int localZOrder, int 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...
 
void setBlendFunc (const BlendFunc &blendFunc) override
 
const BlendFuncgetBlendFunc () const override
 @js NA @lua NA
 
static Spritecreate ()
 Creates an empty sprite without texture. More...
 
- Public Member Functions inherited from Node
virtual bool isRunning () const
 Returns whether or not the node is "running". More...
 
void scheduleUpdateWithPriorityLua (int handler, int priority)
 Schedules for lua script. More...
 
virtual void cleanup ()
 Stops all running actions and schedulers.
 
virtual void visit (Renderer *renderer, const Mat4 &parentTransform, uint32_t parentFlags)
 Visits this node's children and draw them recursively. More...
 
virtual ScenegetScene () const
 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 void setEventDispatcher (EventDispatcher *dispatcher)
 Set event dispatcher for scene. More...
 
virtual EventDispatchergetEventDispatcher () const
 Get the event dispatcher of scene. More...
 
virtual uint8_t getOpacity () const
 Return the node's opacity. More...
 
virtual uint8_t getDisplayedOpacity () const
 Return the node's display opacity. More...
 
virtual void setOpacity (uint8_t opacity)
 Change node opacity. More...
 
virtual void updateDisplayedOpacity (uint8_t parentOpacity)
 Update the displayed opacity of node with it's parent opacity;. More...
 
virtual bool isCascadeOpacityEnabled () const
 Whether cascadeOpacity is enabled or not. More...
 
virtual void setCascadeOpacityEnabled (bool cascadeOpacityEnabled)
 Change node's cascadeOpacity property. More...
 
virtual const Color3BgetColor () const
 Query node's color value. More...
 
virtual const Color3BgetDisplayedColor () const
 Query node's displayed color. More...
 
virtual void setColor (const Color3B &color)
 Change the color of node. More...
 
virtual void updateDisplayedColor (const Color3B &parentColor)
 Update node's displayed color with its parent color. More...
 
virtual bool isCascadeColorEnabled () const
 Query whether cascadeColor is enabled or not. More...
 
virtual void setCascadeColorEnabled (bool cascadeColorEnabled)
 If you want node's color affect the children node's color, then set it to true. More...
 
void setOnEnterCallback (const std::function< void()> &callback)
 Set the callback of event onEnter. More...
 
const std::function< void()> & getOnEnterCallback () const
 Get the callback of event onEnter. More...
 
void setOnExitCallback (const std::function< void()> &callback)
 Set the callback of event onExit. More...
 
const std::function< void()> & getOnExitCallback () const
 Get the callback of event onExit. More...
 
void setOnEnterTransitionDidFinishCallback (const std::function< void()> &callback)
 Set the callback of event EnterTransitionDidFinish. More...
 
const std::function< void()> & getOnEnterTransitionDidFinishCallback () const
 Get the callback of event EnterTransitionDidFinish. More...
 
void setOnExitTransitionDidStartCallback (const std::function< void()> &callback)
 Set the callback of event ExitTransitionDidStart. More...
 
const std::function< void()> & getOnExitTransitionDidStartCallback () const
 Get the callback of event ExitTransitionDidStart. More...
 
unsigned short getCameraMask () const
 get & set camera mask, the node is visible by the camera whose camera flag & node's camera mask is true
 
virtual void setCameraMask (unsigned short mask, bool applyChildren=true)
 Modify the camera mask for current node. More...
 
virtual void setLocalZOrder (std::int32_t localZOrder)
 LocalZOrder is the 'key' used to sort the node relative to its siblings. More...
 
virtual void _setLocalZOrder (std::int32_t z)
 
void updateOrderOfArrival ()
 !!! ONLY FOR INTERNAL USE Sets the arrival order when this node has a same ZOrder with other children. More...
 
virtual std::int32_t getLocalZOrder () const
 Gets the local Z order of this node. More...
 
virtual void setGlobalZOrder (float globalZOrder)
 Defines the order in which the nodes are renderer. More...
 
virtual float getGlobalZOrder () const
 Returns the Node's Global Z Order. More...
 
virtual float getScaleX () const
 Returns the scale factor on X axis of this node. More...
 
virtual float getScaleY () const
 Returns the scale factor on Y axis of this node. More...
 
virtual void setScaleZ (float scaleZ)
 Changes the scale factor on Z axis of this node. More...
 
virtual float getScaleZ () const
 Returns the scale factor on Z axis of this node. More...
 
virtual float getScale () const
 Gets the scale factor of the node, when X and Y have the same scale factor. More...
 
virtual void setPositionNormalized (const Vec2 &position)
 Sets the position (x,y) using values between 0 and 1. More...
 
virtual void setNormalizedPosition (const Vec2 &position)
 
virtual const Vec2getPosition () const
 Gets the position (x,y) of the node in its parent's coordinate system. More...
 
virtual const Vec2getPositionNormalized () const
 Returns the normalized position. More...
 
virtual const Vec2getNormalizedPosition () const
 
virtual void getPosition (float *x, float *y) const
 Gets position in a more efficient way, returns two number instead of a Vec2 object. More...
 
virtual void setPositionX (float x)
 Gets/Sets x or y coordinate individually for position. More...
 
virtual float getPositionX () 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 () 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 float getPositionZ () const
 Gets position Z coordinate of this node. More...
 
virtual float getSkewX () const
 Returns the X skew angle of the node in degrees. More...
 
virtual float getSkewY () const
 Returns the Y skew angle of the node in degrees. More...
 
virtual const Vec2getAnchorPoint () const
 Returns the anchor point in percent. More...
 
virtual const Vec2getAnchorPointInPoints () const
 Returns the anchorPoint in absolute pixels. More...
 
virtual const Size & getContentSize () const
 Returns the untransformed size of the node. More...
 
virtual bool isVisible () const
 Determines if the node is visible. More...
 
virtual float getRotation () const
 Returns the rotation of the node in degrees. More...
 
virtual void setRotation3D (const Vec3 &rotation)
 Sets the rotation (X,Y,Z) in degrees. More...
 
virtual Vec3 getRotation3D () const
 Returns the rotation (X,Y,Z) in degrees. More...
 
virtual void setRotationQuat (const Quaternion &quat)
 Set rotation by quaternion. More...
 
virtual Quaternion getRotationQuat () const
 Return the rotation by quaternion, Note that when _rotationZ_X == _rotationZ_Y, the returned quaternion equals to RotationZ_X * RotationY * RotationX, it equals to RotationY * RotationX otherwise. More...
 
virtual float getRotationSkewX () const
 Gets the X rotation (angle) of the node in degrees which performs a horizontal rotation skew. More...
 
virtual float getRotationSkewY () const
 Gets the Y rotation (angle) of the node in degrees which performs a vertical rotational skew. More...
 
virtual bool isIgnoreAnchorPointForPosition () const
 Gets whether the anchor point will be (0,0) when you position this node. More...
 
virtual int getTag () const
 Returns a tag that is used to identify the node easily. More...
 
virtual void setTag (int tag)
 Changes the tag that is used to identify the node easily. More...
 
virtual const std::string & getName () const
 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...
 
virtual void * getUserData ()
 Returns a custom user data pointer. More...
 
virtual const void * getUserData () const
 @lua NA
 
virtual void setUserData (void *userData)
 Sets a custom user data pointer. More...
 
virtual RefgetUserObject ()
 Returns a user assigned Object. More...
 
virtual const RefgetUserObject () const
 @lua NA
 
virtual void setUserObject (Ref *userObject)
 Returns a user assigned Object. More...
 
virtual void onEnter ()
 Event callback that is invoked every time when Node enters the 'stage'. More...
 
virtual void onEnterTransitionDidFinish ()
 Event callback that is invoked when the Node enters in the 'stage'. More...
 
virtual void onExit ()
 Event callback that is invoked every time the Node leaves the 'stage'. More...
 
virtual void onExitTransitionDidStart ()
 Event callback that is called every time the Node leaves the 'stage'. More...
 
virtual void setActionManager (ActionManager *actionManager)
 Sets the ActionManager object that is used by all actions. More...
 
virtual ActionManagergetActionManager ()
 Gets the ActionManager object that is used by all actions. More...
 
virtual const ActionManagergetActionManager () const
 
virtual ActionrunAction (Action *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...
 
void stopActionByTag (int tag)
 Removes an action from the running action list by its tag. More...
 
void stopAllActionsByTag (int tag)
 Removes all actions from the running action list by its tag. More...
 
void stopActionsByFlags (unsigned int flags)
 Removes all actions from the running action list by its flags. More...
 
ActiongetActionByTag (int tag)
 Gets an action from the running action list by its tag. More...
 
ssize_t getNumberOfRunningActions () const
 Returns the numbers of actions that are running plus the ones that are schedule to run (actions in actionsToAdd and actions arrays). More...
 
ssize_t getNumberOfRunningActionsByTag (int tag) const
 Returns the numbers of actions that are running plus the ones that are schedule to run (actions in actionsToAdd and actions arrays) with a specific tag. More...
 
virtual void setScheduler (Scheduler *scheduler)
 Sets a Scheduler object that is used to schedule all "updates" and timers. More...
 
virtual SchedulergetScheduler ()
 Gets a Scheduler object. More...
 
virtual const SchedulergetScheduler () const
 
bool isScheduled (SEL_SCHEDULE selector) const
 Checks whether a selector is scheduled. More...
 
bool isScheduled (const std::string &key) const
 Checks whether a lambda function is scheduled. More...
 
void scheduleUpdate ()
 Schedules the "update" method. More...
 
void scheduleUpdateWithPriority (int priority)
 Schedules the "update" method with a custom priority. More...
 
void unscheduleUpdate ()
 
void schedule (SEL_SCHEDULE selector, float interval, unsigned int repeat, float delay)
 Schedules a custom selector. More...
 
void schedule (SEL_SCHEDULE selector, float interval)
 Schedules a custom selector with an interval time in seconds. More...
 
void scheduleOnce (SEL_SCHEDULE selector, float delay)
 Schedules a selector that runs only once, with a delay of 0 or larger. More...
 
void scheduleOnce (const std::function< void(float)> &callback, float delay, const std::string &key)
 Schedules a lambda function that runs only once, with a delay of 0 or larger. More...
 
void schedule (SEL_SCHEDULE selector)
 Schedules a custom selector, the scheduled selector will be ticked every frame. More...
 
void schedule (const std::function< void(float)> &callback, const std::string &key)
 Schedules a lambda function. More...
 
void schedule (const std::function< void(float)> &callback, float interval, const std::string &key)
 Schedules a lambda function. More...
 
void schedule (const std::function< void(float)> &callback, float interval, unsigned int repeat, float delay, const std::string &key)
 Schedules a lambda function. More...
 
void unschedule (SEL_SCHEDULE selector)
 Unschedules a custom selector. More...
 
void unschedule (const std::string &key)
 Unschedules a lambda function. More...
 
void unscheduleAllCallbacks ()
 Unschedule all scheduled selectors and lambda functions: custom selectors, and the 'update' selector and lambda functions. More...
 
virtual void resume ()
 Resumes all scheduled selectors, actions and event listeners. More...
 
virtual void pause ()
 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...
 
virtual const Mat4getNodeToParentTransform () const
 Returns the matrix that transform the node's (local) space coordinates into the parent's space coordinates. More...
 
virtual AffineTransform getNodeToParentAffineTransform () const
 
virtual Mat4 getNodeToParentTransform (Node *ancestor) const
 Returns the matrix that transform the node's (local) space coordinates into the parent's space coordinates. More...
 
virtual AffineTransform getNodeToParentAffineTransform (Node *ancestor) const
 Returns the affine transform matrix that transform the node's (local) space coordinates into the parent's space coordinates. More...
 
virtual void setNodeToParentTransform (const Mat4 &transform)
 Sets the transformation matrix manually. More...
 
virtual const Mat4getParentToNodeTransform () const
 Returns the matrix that transform parent's space coordinates to the node's (local) space coordinates. More...
 
virtual AffineTransform getParentToNodeAffineTransform () const
 
virtual Mat4 getNodeToWorldTransform () const
 Returns the world affine transform matrix. More...
 
virtual AffineTransform getNodeToWorldAffineTransform () const
 
virtual Mat4 getWorldToNodeTransform () const
 Returns the inverse world affine transform matrix. More...
 
virtual AffineTransform getWorldToNodeAffineTransform () const
 
Vec2 convertToNodeSpace (const Vec2 &worldPoint) const
 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 (const Mat4 *additionalTransform)
 Sets an additional transform matrix to the node. More...
 
void setAdditionalTransform (const Mat4 &additionalTransform)
 
void setAdditionalTransform (const AffineTransform &additionalTransform)
 
Component * getComponent (const std::string &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 void addChild (Node *child)
 Adds a child to the container with z-order as 0. More...
 
virtual void addChild (Node *child, int localZOrder)
 Adds a child to the container with a local z-order. More...
 
virtual NodegetChildByTag (int tag) const
 Gets a child from the container with its tag. More...
 
template<typename T >
getChildByTag (int tag) const
 Gets a child from the container with its tag that can be cast to Type T. More...
 
virtual NodegetChildByName (const std::string &name) const
 Gets a child from the container with its name. More...
 
template<typename 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...
 
virtual const Vector< Node * > & getChildren () const
 
virtual ssize_t getChildrenCount () const
 Returns the amount of children. More...
 
virtual void setParent (Node *parent)
 Sets the parent node. More...
 
virtual NodegetParent ()
 Returns a pointer to the parent node. More...
 
virtual const NodegetParent () 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...
 
virtual void removeChildByTag (int tag, bool cleanup=true)
 Removes a child from the container by tag value. More...
 
virtual void removeChildByName (const std::string &name, bool cleanup=true)
 Removes a child from the container by tag value. More...
 
virtual void removeAllChildren ()
 Removes all children from the container with a cleanup. More...
 
- Public Member Functions inherited from Ref
void retain ()
 Retains the ownership. More...
 
void release ()
 Releases the ownership immediately. More...
 
Refautorelease ()
 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 Scale9Spritecreate ()
 Create an empty Scale9Sprite. More...
 
static Scale9Spritecreate (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 Scale9Spritecreate (const Rect &capInsets, const std::string &file)
 Creates a 9-slice sprite with a texture file. More...
 
static Scale9Spritecreate (const std::string &file, const Rect &rect)
 Creates a 9-slice sprite with a texture file and a delimitation zone. More...
 
static Scale9Spritecreate (const std::string &file)
 Creates a 9-slice sprite with a texture file. More...
 
static Scale9SpritecreateWithSpriteFrame (SpriteFrame *spriteFrame)
 Creates a 9-slice sprite with an sprite frame. More...
 
static Scale9SpritecreateWithSpriteFrame (SpriteFrame *spriteFrame, const Rect &capInsets)
 Creates a 9-slice sprite with an sprite frame and the centre of its zone. More...
 
static Scale9SpritecreateWithSpriteFrameName (const std::string &spriteFrameName)
 Creates a 9-slice sprite with an sprite frame name. More...
 
static Scale9SpritecreateWithSpriteFrameName (const std::string &spriteFrameName, const Rect &capInsets)
 Creates a 9-slice sprite with an sprite frame name and the centre of its zone. More...
 
- Static Public Member Functions inherited from Sprite
static Spritecreate (const std::string &filename)
 Creates a sprite with an image filename. More...
 
static Spritecreate (const PolygonInfo &info)
 Creates a polygon sprite with a polygon info. More...
 
static Spritecreate (const std::string &filename, const Rect &rect)
 Creates a sprite with an image filename and a rect. More...
 
static SpritecreateWithTexture (Texture2D *texture)
 Creates a sprite with a Texture2D object. More...
 
static SpritecreateWithTexture (Texture2D *texture, const Rect &rect, bool rotated=false)
 Creates a sprite with a texture and a rect. More...
 
static SpritecreateWithSpriteFrame (SpriteFrame *spriteFrame)
 Creates a sprite with an sprite frame. More...
 
static SpritecreateWithSpriteFrameName (const std::string &spriteFrameName)
 Creates a sprite with an sprite frame name. More...
 
- Static Public Member Functions inherited from Node
static Nodecreate ()
 Allocates and initializes a node. More...
 
static int getAttachedNodeCount ()
 Gets count of nodes those are attached to scene graph.
 
template<typename _T >
static void sortNodes (cocos2d::Vector< _T * > &nodes)
 Sorts helper function. More...
 

Additional Inherited Members

- Public Attributes inherited from Ref
unsigned int _ID
 object id, ScriptSupport need public _ID
 
int _luaID
 Lua reference id.
 
void * _scriptObject
 scriptObject, support for swift
 
bool _rooted
 When true, it means that the object was already rooted.
 
- Static Public Attributes inherited from Sprite
static const int INDEX_NOT_INITIALIZED = -1
 Sprite invalid index on the SpriteBatchNode.
 
- Static Public Attributes inherited from Node
static const int INVALID_TAG = -1
 Default tag used for all the nodes.
 
- Protected Member Functions inherited from Sprite
 Sprite ()
 @js ctor
 
virtual bool initWithTexture (Texture2D *texture)
 Initializes a sprite with a texture. More...
 
virtual bool initWithPolygon (const PolygonInfo &info)
 Initializes a sprite with a PolygonInfo. More...
 
virtual bool initWithTexture (Texture2D *texture, const Rect &rect)
 Initializes a sprite with a texture and a rect. More...
 
virtual bool initWithTexture (Texture2D *texture, const Rect &rect, bool rotated)
 Initializes a sprite with a texture and a rect in points, optionally rotated. More...
 
virtual bool initWithSpriteFrame (SpriteFrame *spriteFrame)
 Initializes a sprite with an SpriteFrame. More...
 

Detailed Description

A 9-slice sprite for cocos2d-x.

9-slice scaling allows you to specify how scaling is applied to specific areas of a sprite. With 9-slice scaling (3x3 grid), you can ensure that the sprite does not become distorted when scaled. Note: When you set _scale9Enabled to false, then you could call scale9Sprite->getSprite() to return the inner Sprite pointer. Then you could call any methods of Sprite class with the return pointers.

Member Enumeration Documentation

◆ State

enum State
strong

Builtin shader state.

Currently support Normal and Gray state.

Constructor & Destructor Documentation

◆ Scale9Sprite()

Default constructor.

@js ctor @lua new

◆ ~Scale9Sprite()

virtual ~Scale9Sprite ( )
virtual

Default destructor.

@js NA @lua NA

Member Function Documentation

◆ create() [1/5]

static Scale9Sprite* create ( )
static

Create an empty Scale9Sprite.

Returns
A Scale9Sprite instance.

◆ create() [2/5]

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
fileA texture file name.
rectA delimitation zone.
capInsetsA specified cap insets.
Returns
A Scale9Sprite instance.

◆ create() [3/5]

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
capInsetsA specified cap insets.
fileA texture file name.
Returns
A Scale9Sprite instance.

◆ create() [4/5]

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
fileA texture file name.
rectA delimitation zone.
Returns
A Scale9Sprite instance.

◆ create() [5/5]

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
fileA texture file name.
Returns
A Scale9Sprite instance.

◆ createWithSpriteFrame() [1/2]

static Scale9Sprite* createWithSpriteFrame ( SpriteFrame spriteFrame)
static

Creates a 9-slice sprite with an sprite frame.

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

See also
initWithSpriteFrame(SpriteFrame *spriteFrame)
Parameters
spriteFrameA sprite frame pointer.
Returns
A Scale9Sprite instance.

◆ createWithSpriteFrame() [2/2]

static Scale9Sprite* createWithSpriteFrame ( SpriteFrame spriteFrame,
const Rect capInsets 
)
static

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

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

See also
initWithSpriteFrame(SpriteFrame *spriteFrame, const Rect& capInsets)
Parameters
spriteFrameA sprite frame pointer.
capInsetsA delimitation zone.
Returns
A Scale9Sprite instance.

◆ createWithSpriteFrameName() [1/2]

static Scale9Sprite* createWithSpriteFrameName ( const std::string &  spriteFrameName)
static

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

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

See also
initWithSpriteFrameName(const char *spriteFrameName)
Parameters
spriteFrameNameA sprite frame name.
Returns
A Scale9Sprite instance.

◆ createWithSpriteFrameName() [2/2]

static Scale9Sprite* createWithSpriteFrameName ( const std::string &  spriteFrameName,
const Rect capInsets 
)
static

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

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

See also
initWithSpriteFrameName(const char *spriteFrameName, const Rect& capInsets)
Parameters
spriteFrameNameA sprite frame name.
capInsetsA delimitation zone.
Returns
A Scale9Sprite instance.

◆ initWithFile() [1/6]

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

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

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

Parameters
fileThe name of the texture file.
rectThe rectangle that describes the sub-part of the texture that is the whole image. If the shape is the whole texture, set this to the texture's full rect.
capInsetsThe values to use for the cap insets.
Returns
True if initialize success, false otherwise.

◆ initWithFile() [2/6]

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

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

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

Parameters
fileThe name of the texture file.
capInsetsThe values to use for the cap insets.
Returns
True if initializes success, false otherwise.

◆ initWithSpriteFrame() [1/2]

virtual bool initWithSpriteFrame ( SpriteFrame spriteFrame,
const Rect capInsets 
)
virtual

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

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

Parameters
spriteFrameThe sprite frame object.
capInsetsThe values to use for the cap insets.
Returns
True if initializes success, false otherwise.

◆ initWithSpriteFrameName() [1/3]

virtual bool initWithSpriteFrameName ( const std::string &  spriteFrameName,
const Rect capInsets 
)
virtual

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

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

Parameters
spriteFrameNameThe sprite frame name.
capInsetsThe values to use for the cap insets.
Returns
True if initializes success, false otherwise.

◆ initWithFile() [3/6]

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

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

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

Parameters
fileThe name of the texture file.
rectThe rectangle that describes the sub-part of the texture that is the whole image. If the shape is the whole texture, set this to the texture's full rect.
Returns
True if initializes success, false otherwise.

Reimplemented from Sprite.

◆ initWithFile() [4/6]

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

Initializes a 9-slice sprite with a texture file.

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

Parameters
fileThe name of the texture file.
Returns
True if initializes success, false otherwise.

Reimplemented from Sprite.

◆ initWithSpriteFrameName() [2/3]

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

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

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

Parameters
spriteFrameNameThe sprite frame name.
Returns
True if initializes success, false otherwise.

Reimplemented from Sprite.

◆ init() [1/3]

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

Initializes a 9-slice sprite with an sprite instance.

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

Parameters
spriteThe sprite instance.
rectA delimitation zone.
rotatedWhether the sprite is rotated or not.
capInsetsThe values to use for the cap insets.
Returns
True if initializes success, false otherwise.

◆ init() [2/3]

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

Initializes a 9-slice sprite with an sprite instance.

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

Parameters
spriteThe sprite instance.
rectA delimitation zone.
capInsetsThe values to use for the cap insets.
Returns
True if initializes success, false otherwise.

◆ init() [3/3]

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

Initializes a 9-slice sprite with an sprite instance.

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

Parameters
spriteThe sprite instance.
rectA delimitation zone.
rotatedWhether the sprite is rotated or not.
offsetThe offset when slice the sprite.
originalSizeThe original size of sprite.
capInsetsThe values to use for the cap insets.
Returns
True if initializes success, false otherwise.

◆ resizableSpriteWithCapInsets()

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
capInsetsThe values to use for the cap insets.
Returns
A Scale9Sprite instance.

◆ updateWithSprite() [1/2]

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

Update Scale9Sprite with a specified sprite.

Parameters
spriteA sprite pointer.
rectA delimitation zone.
rotatedWhether the sprite is rotated or not.
capInsetsThe Values to use for the cap insets.
Returns
True if update success, false otherwise. @js NA

◆ updateWithSprite() [2/2]

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
spriteA sprite pointer.
rectA delimitation zone.
rotatedWhether the sprite is rotated or not.
offsetThe offset when slice the sprite.
originalSizeThe original size of the sprite.
capInsetsThe Values to use for the cap insets.
Returns
True if update success, false otherwise. @js NA

◆ setSpriteFrame() [1/2]

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

Change inner sprite's sprite frame.

Parameters
spriteFrameA sprite frame pointer.
capInsetsThe values to use for the cap insets.

◆ setState()

void setState ( State  state)

Change the state of 9-slice sprite.

See also
State
Parameters
stateA enum value in State.
Since
v3.4

◆ getState()

State getState ( ) const

Query the current bright state.

Returns
See also
State
Since
v3.7

◆ getOriginalSize()

Size getOriginalSize ( ) const

Query the sprite's original size.

Returns
Sprite size.

◆ setPreferredSize()

void setPreferredSize ( const Size &  size)

Change the preferred size of Scale9Sprite.

Parameters
sizeA delimitation zone.

◆ getPreferredSize()

Size getPreferredSize ( ) const

Query the Scale9Sprite's preferred size.

Returns
Scale9Sprite's preferred size.

◆ setInsetLeft()

void setInsetLeft ( float  leftInset)

Change the left sprite's cap inset.

Parameters
leftInsetThe values to use for the cap inset.

◆ getInsetLeft()

float getInsetLeft ( ) const

Query the left sprite's cap inset.

Returns
The left sprite's cap inset.

◆ setInsetTop()

void setInsetTop ( float  topInset)

Change the top sprite's cap inset.

Parameters
topInsetThe values to use for the cap inset.

◆ getInsetTop()

float getInsetTop ( ) const

Query the top sprite's cap inset.

Returns
The top sprite's cap inset.

◆ setInsetRight()

void setInsetRight ( float  rightInset)

Change the right sprite's cap inset.

Parameters
rightInsetThe values to use for the cap inset.

◆ getInsetRight()

float getInsetRight ( ) const

Query the right sprite's cap inset.

Returns
The right sprite's cap inset.

◆ setInsetBottom()

void setInsetBottom ( float  bottomInset)

Change the bottom sprite's cap inset.

Parameters
bottomInsetThe values to use for the cap inset.

◆ getInsetBottom()

float getInsetBottom ( ) const

Query the bottom sprite's cap inset.

Returns
The bottom sprite's cap inset.

◆ setScale9Enabled()

void setScale9Enabled ( bool  enabled)

Toggle 9-slice feature.

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

Warning
: Don't use setScale9Enabled(false), use setRenderingType(RenderingType::SIMPLE) instead. The setScale9Enabled(false) is kept only for back back compatibility.
Parameters
enabledTrue to enable 9-slice, false otherwise. @js NA

◆ isScale9Enabled()

bool isScale9Enabled ( ) const

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

Returns
True if 9-slice is enabled, false otherwise. @js NA

◆ getSprite()

Sprite* getSprite ( )

Get the original no 9-sliced sprite.

Returns
A sprite instance.

◆ setRenderingType()

void setRenderingType ( RenderingType  type)

Set the slice sprite rendering type.

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

See also
RenderingType

◆ initWithFile() [5/6]

virtual bool initWithFile

Initializes a sprite with an image filename.

This method will find filename from local file system, load its content to Texture2D, then use Texture2D to create a sprite. After initialization, the rect used will be the size of the image. The offset will be (0,0).

Parameters
filenameThe path to an image file in local file system.
Returns
True if the sprite is initialized properly, false otherwise. @lua init

◆ initWithFile() [6/6]

virtual bool initWithFile

Initializes a sprite with an image filename, and a rect.

This method will find filename from local file system, load its content to Texture2D, then use Texture2D to create a sprite. After initialization, the offset will be (0,0).

Parameters
filenameThe path to an image file in local file system.
rectThe rectangle assigned the content area from texture.
Returns
True if the sprite is initialized properly, false otherwise. @lua init

◆ initWithSpriteFrame() [2/2]

virtual bool initWithSpriteFrame

Initializes a sprite with an SpriteFrame.

The texture and rect in SpriteFrame will be applied on this sprite.

Parameters
spriteFrameA SpriteFrame object. It should includes a valid texture and a rect.
Returns
True if the sprite is initialized properly, false otherwise.

◆ initWithSpriteFrameName() [3/3]

virtual bool initWithSpriteFrameName

Initializes a sprite with an sprite frame name.

A SpriteFrame will be fetched from the SpriteFrameCache by name. If the SpriteFrame doesn't exist it will raise an exception.

Parameters
spriteFrameNameA key string that can fetched a valid SpriteFrame from SpriteFrameCache.
Returns
True if the sprite is initialized properly, false otherwise.

◆ setSpriteFrame() [2/2]

virtual void setSpriteFrame

Sets a new SpriteFrame to the Sprite.


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