Class cc.Sprite

Class Detail

var aSprite = new cc.Sprite();
aSprite.initWithFile("HelloHTML5World.png",cc.rect(0,0,480,320));

Field Detail

Method Detail

• addChild(child, localZOrder, tag)
  Add child to sprite (override cc.Node )

  Parameters:

  {cc.Sprite} child

  {Number} localZOrder

  child's zOrder

  {String} tag

  child's tag
• <static> {cc.Sprite} cc.Sprite.create(fileName, rect)
  Create a sprite with image path or frame name or texture or spriteFrame.

  1.Create a sprite with image path and rect
  var sprite1 = cc.Sprite.create("res/HelloHTML5World.png");
  var sprite2 = cc.Sprite.create("res/HelloHTML5World.png",cc.rect(0,0,480,320));
  
  2.Create a sprite with a sprite frame name. Must add "#" before frame name.
  var sprite = cc.Sprite.create('#grossini_dance_01.png');
  
  3.Create a sprite with a sprite frame
  var spriteFrame = cc.spriteFrameCache.getSpriteFrame("grossini_dance_01.png");
  var sprite = cc.Sprite.create(spriteFrame);
  
  4.Create a sprite with an exsiting texture contained in a CCTexture2D object
       After creation, the rect will be the size of the texture, and the offset will be (0,0).
  var texture = cc.textureCache.addImage("HelloHTML5World.png");
  var sprite1 = cc.Sprite.create(texture);
  var sprite2 = cc.Sprite.create(texture, cc.rect(0,0,480,320));

  Parameters:

  {String|cc.SpriteFrame|HTMLImageElement|cc.Texture2D} fileName

  The string which indicates a path to image file, e.g., "scene1/monster.png".

  {cc.Rect} rect

  Only the contents inside rect of pszFileName's texture will be applied for this sprite.

  Returns:

  {cc.Sprite} A valid sprite object
• ctor(fileName, rect)
  Constructor

  Parameters:

  {String|cc.SpriteFrame|cc.SpriteBatchNode|HTMLImageElement|cc.Texture2D} fileName

  sprite construct parameter

  {cc.Rect} rect

  Only the contents inside rect of pszFileName's texture will be applied for this sprite.
• {cc.SpriteFrame} displayFrame()
  Returns the current displayed frame.

  Returns:

  {cc.SpriteFrame}
• draw()
  draw sprite to canvas
• {Number} getAtlasIndex()
  Returns the index used on the TextureAtlas.

  Returns:

  {Number}
• {cc.SpriteBatchNode|null} getBatchNode()
  Returns the batch node object if this sprite is rendered by cc.SpriteBatchNode

  Returns:

  {cc.SpriteBatchNode|null} The cc.SpriteBatchNode object if this sprite is rendered by cc.SpriteBatchNode, null if the sprite isn't used batch node.
• {cc.BlendFunc} getBlendFunc()
  conforms to cc.TextureProtocol protocol

  Returns:

  {cc.BlendFunc}
• {cc.Point} getOffsetPosition()
  Gets the offset position of the sprite. Calculated automatically by editors like Zwoptex.

  Returns:

  {cc.Point}
• {cc.V3F_C4B_T2F_Quad} getQuad()
  Returns the quad (tex coords, vertex coords and color) information.

  Returns:

  {cc.V3F_C4B_T2F_Quad}
• {cc.TextureAtlas} getTextureAtlas()
  Gets the weak reference of the cc.TextureAtlas when the sprite is rendered using via cc.SpriteBatchNode

  Returns:

  {cc.TextureAtlas}
• {cc.Rect} getTextureRect()
  returns the rect of the cc.Sprite in points

  Returns:

  {cc.Rect}
• ignoreAnchorPointForPosition(relative)
  IsRelativeAnchorPoint setter (override cc.Node )

  Parameters:

  {Boolean} relative
• {Boolean} init()
  Initializes an empty sprite with nothing init.

  Returns:

  {Boolean}
• {Boolean} initWithFile(filename, rect)

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

  var mySprite = new cc.Sprite();
  mySprite.initWithFile("HelloHTML5World.png",cc.rect(0,0,480,320));

  Parameters:

  {String} filename

  The path to an image file in local file system

  {cc.Rect} rect

  The rectangle assigned the content area from texture.

  Returns:

  {Boolean} true if the sprite is initialized properly, false otherwise.
• {Boolean} initWithSpriteFrame(spriteFrame)
  Initializes a sprite with an SpriteFrame. The texture and rect in SpriteFrame will be applied on this sprite

  var spriteFrame = cc.spriteFrameCache.getSpriteFrame("grossini_dance_01.png");
  var sprite = new cc.Sprite();
  sprite.initWithSpriteFrame(spriteFrame);

  Parameters:

  {cc.SpriteFrame} spriteFrame

  A CCSpriteFrame object. It should includes a valid texture and a rect

  Returns:

  {Boolean} true if the sprite is initialized properly, false otherwise.
• {Boolean} initWithSpriteFrameName(spriteFrameName)
  Initializes a sprite with a sprite frame name.
  A cc.SpriteFrame will be fetched from the cc.SpriteFrameCache by name.
  If the cc.SpriteFrame doesn't exist it will raise an exception.
  

  var sprite = new cc.Sprite();
  sprite.initWithSpriteFrameName("grossini_dance_01.png");

  Parameters:

  {String} spriteFrameName

  A key string that can fected a volid cc.SpriteFrame from cc.SpriteFrameCache

  Returns:

  {Boolean} true if the sprite is initialized properly, false otherwise.
• {Boolean} initWithTexture(texture, rect, rotated)
  Initializes a sprite with a texture and a rect in points, optionally rotated.
  After initialization, the rect used will be the size of the texture, and the offset will be (0,0).

  var img =cc.textureCache.addImage("HelloHTML5World.png");
  var mySprite = new cc.Sprite();
  mySprite.initWithTexture(img,cc.rect(0,0,480,320));

  Parameters:

  {cc.Texture2D|HTMLImageElement|HTMLCanvasElement} texture

  A pointer to an existing CCTexture2D object. You can use a CCTexture2D object for many sprites.

  {cc.Rect} rect

  Only the contents inside rect of this texture will be applied for this sprite.

  {Boolean} rotated Optional

  Whether or not the texture rectangle is rotated.

  Returns:

  {Boolean} true if the sprite is initialized properly, false otherwise.
• {Boolean} isDirty()
  Whether or not the Sprite needs to be updated in the Atlas

  Returns:

  {Boolean} true if the sprite needs to be updated in the Atlas, false otherwise.
• {Boolean} isFlippedX()

  Returns the flag which indicates whether the sprite is flipped horizontally or not.
  
  It only flips the texture of the sprite, and not the texture of the sprite'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:
  sprite->setScaleX(sprite->getScaleX() * -1);

  Returns:

  {Boolean} true if the sprite is flipped horizaontally, false otherwise.
• {Boolean} isFlippedY()

  Return the flag which indicates whether the sprite is flipped vertically or not.
  
  It only flips the texture of the sprite, and not the texture of the sprite'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:
  sprite->setScaleY(sprite->getScaleY() * -1);

  Returns:

  {Boolean} true if the sprite is flipped vertically, flase otherwise.
• {Boolean} isFrameDisplayed(frame)
  Returns whether or not a cc.SpriteFrame is being displayed

  Parameters:

  {cc.SpriteFrame} frame

  Returns:

  {Boolean}
• {Boolean} isOpacityModifyRGB()
  return IsOpacityModifyRGB value

  Returns:

  {Boolean}
• {Boolean} isTextureRectRotated()
  Returns whether or not the texture rectangle is rotated.

  Returns:

  {Boolean}
• removeAllChildren(cleanup)
  Removes all children from the container (override cc.Node )

  Parameters:

  cleanup

  whether or not cleanup all running actions
• removeChild(child, cleanup)
  Removes a child from the sprite. (override cc.Node )

  Parameters:

  child

  cleanup

  whether or not cleanup all running actions
• reorderChild(child, zOrder)
  Reorders a child according to a new z value. (override cc.Node )

  Parameters:

  {cc.Node} child

  {Number} zOrder
• setAtlasIndex(atlasIndex)
  Set the index used on the TextureAtlas.

  Parameters:

  {Number} atlasIndex
• setBatchNode(spriteBatchNode)
  Sets the batch node to sprite

   var batch = cc.SpriteBatchNode.create("Images/grossini_dance_atlas.png", 15);
   var sprite = cc.Sprite.create(batch.texture, cc.rect(0, 0, 57, 57));
   batch.addChild(sprite);
   layer.addChild(batch);

  Parameters:

  {cc.SpriteBatchNode|null} spriteBatchNode
• setBlendFunc(src, dst)
  conforms to cc.TextureProtocol protocol

  Parameters:

  {Number|cc.BlendFunc} src

  {Number} dst
• setColor(color3)
  Color setter

  Parameters:

  {cc.Color} color3
• setDirty(bDirty)
  Makes the Sprite to be updated in the Atlas.

  Parameters:

  {Boolean} bDirty
• setDirtyRecursively(value)
  set Recursively is or isn't Dirty used only when parent is cc.SpriteBatchNode

  Parameters:

  {Boolean} value
• setDisplayFrame(newFrame)
  Sets a new display frame to the cc.Sprite.

  Parameters:

  {cc.SpriteFrame|String} newFrame
• setDisplayFrameWithAnimationName(animationName, frameIndex)
  changes the display frame with animation name and index.
  The animation name will be get from the CCAnimationCache

  Parameters:

  animationName

  frameIndex
• setFlippedX(flippedX)
  Sets whether the sprite should be flipped horizontally or not.

  Parameters:

  {Boolean} flippedX

  true if the sprite should be flipped horizontally, false otherwise.
• setFlippedY(flippedY)
  Sets whether the sprite should be flipped vertically or not.

  Parameters:

  {Boolean} flippedY

  true if the sprite should be flipped vertically, false otherwise.
• setNodeDirty(norecursive)
  Make the node dirty

  Parameters:

  {Boolean} norecursive

  When true children will not be set dirty recursively, by default, they will be.
• setOpacity(opacity)
  Opacity setter

  Parameters:

  {Number} opacity
• setOpacityModifyRGB(modify)
  opacity: conforms to CCRGBAProtocol protocol

  Parameters:

  {Boolean} modify
• setSpriteFrame(newFrame)
  Sets a new spriteFrame to the cc.Sprite.

  Parameters:

  {cc.SpriteFrame|String} newFrame
• setTexture(texture)
  Texture of sprite setter

  Parameters:

  {cc.Texture2D|String} texture
• setTextureAtlas(textureAtlas)
  Sets the weak reference of the cc.TextureAtlas when the sprite is rendered using via cc.SpriteBatchNode

  Parameters:

  {cc.TextureAtlas} textureAtlas
• setTextureRect(rect, rotated, untrimmedSize)
  updates the texture rect of the CCSprite in points.

  Parameters:

  {cc.Rect} rect

  a rect of texture

  {Boolean} rotated

  {cc.Size} untrimmedSize
• setVertexRect(rect)

  set the vertex rect.
  It will be called internally by setTextureRect.
  Useful if you want to create 2x images from SD images in Retina Display.
  Do not call it manually. Use setTextureRect instead.
  (override this method to generate "double scale" sprites)

  Parameters:

  {cc.Rect} rect
• updateColor()
  Update sprite's color
• updateTransform()
  updates the quad according the the rotation, position, scale values.
• useBatchNode(batchNode)
  tell the sprite to use batch node render.

  Parameters:

  {cc.SpriteBatchNode} batchNode