Classcc.Sprite

Defined in: CCSprite.js
Extends cc.NodeRGBA

Class Summary
Constructor Attributes	Constructor Name and Description
	cc.Sprite() cc.Sprite is a 2d image ( http://en.wikipedia.org/wiki/Sprite_(computer_graphics) ) cc.Sprite can be created with an image, or with a sub-rectangle of an image.

Field Summary
Field Attributes	Field Name and Description
	addChild Add child to sprite (override cc.Node )
	ctor Constructor
	draw draw sprite to canvas
	init Initializes an empty sprite with nothing init.
	initWithTexture Initializes a sprite with a texture and a rect in points, optionally rotated.
	isFrameDisplayed Returns whether or not a cc.SpriteFrame is being displayed
	setBatchNode Sets the batch node to sprite
	setBlendFunc conforms to cc.TextureProtocol protocol
	setColor color setter
	setDisplayFrame Sets a new display frame to the cc.Sprite.
	setOpacity opacity setter
	setOpacityModifyRGB opacity: conforms to CCRGBAProtocol protocol
	setTexture Texture of sprite setter
	setTextureRect updates the texture rect of the CCSprite in points.
	updateTransform updates the quad according the the rotation, position, scale values.

Fields borrowed from class cc.Node:: nodeToParentTransform, setNodeDirty, transform, visit

Method Summary

Method Attributes	Method Name and Description
<static>	cc.Sprite.create(fileName, rect) Create a sprite with filename and rect
<static>	cc.Sprite.createWithSpriteFrame(spriteFrame) Creates a sprite with a sprite frame.
<static>	cc.Sprite.createWithSpriteFrameName(spriteFrameName) Creates a sprite with a sprite frame.
<static>	cc.Sprite.createWithTexture(texture, rect) Creates 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).
	displayFrame() Returns the current displayed frame.
	getAtlasIndex() Returns the index used on the TextureAtlas.
	getBatchNode() Returns the batch node object if this sprite is rendered by cc.SpriteBatchNode
	getBlendFunc() conforms to cc.TextureProtocol protocol
	getOffsetPosition() Gets the offset position of the sprite.
	getQuad() Returns the quad (tex coords, vertex coords and color) information.
	getSpriteBatchNode() return the SpriteBatchNode of the cc.Sprite
	getTextureAtlas() Gets the weak reference of the cc.TextureAtlas when the sprite is rendered using via cc.SpriteBatchNode
	getTextureRect() returns the rect of the cc.Sprite in points
	ignoreAnchorPointForPosition(relative) IsRelativeAnchorPoint setter (override cc.Node )
	initWithFile(filename, rect) Initializes a sprite with an image filename.
	initWithSpriteFrame(spriteFrame) Initializes a sprite with an SpriteFrame.
	initWithSpriteFrameName(spriteFrameName) Initializes a sprite with a sprite frame name.
	isDirty() Whether or not the Sprite needs to be updated in the Atlas
	isFlippedX() Returns the flag which indicates whether the sprite is flipped horizontally or not.
	isFlippedY() Return the flag which indicates whether the sprite is flipped vertically or not.
	isOpacityModifyRGB() return IsOpacityModifyRGB value
	isTextureRectRotated() Returns whether or not the texture rectangle is rotated.
	removeAllChildren(cleanup) Removes all children from the container (override cc.Node )
	removeChild(child, cleanup) Removes a child from the sprite.
	reorderChild(child, zOrder) Reorders a child according to a new z value.
	SET_DIRTY_RECURSIVELY() HACK: optimization
	setAnchorPoint(anchor) AnchorPoint setter (override cc.Node )
	setAtlasIndex(atlasIndex) Set the index used on the TextureAtlas.
	setDirty(bDirty) Makes the Sprite to be updated in the Atlas.
	setDirtyRecursively(value) set Recursively is or isn't Dirty used only when parent is cc.SpriteBatchNode
	setDisplayFrameWithAnimationName(animationName, frameIndex) changes the display frame with animation name and index.
	setFlippedX(flippedX) Sets whether the sprite should be flipped horizontally or not.
	setFlippedY(flippedY) Sets whether the sprite should be flipped vertically or not.
	setPosition(pos) position setter (override cc.Node )
	setRotation(rotation) Rotation setter (override cc.Node )
	setScale(scale, scaleY) The scale factor of the node.
	setScaleX(scaleX) ScaleX setter (override cc.Node )
	setScaleY(scaleY) ScaleY setter (override cc.Node )
	setSkewX(sx) SkewX setter (override cc.Node )
	setSkewY(sy) SkewY setter (override cc.Node )
	setSpriteBatchNode(spriteBatchNode) set the SpriteBatchNode of the cc.Sprite
	setTextureAtlas(textureAtlas) Sets the weak reference of the cc.TextureAtlas when the sprite is rendered using via cc.SpriteBatchNode
	setVertexRect(rect) set the vertex rect.
	setVertexZ(vertexZ) VertexZ setter (override cc.Node )
	setVisible(visible) visible setter (override cc.Node )
	updateColor() Update sprite's color
	useBatchNode(batchNode) tell the sprite to use batch node render.

Methods borrowed from cc.Node:: addComponent; cleanup; convertToNodeSpace; convertToNodeSpaceAR; convertTouchToNodeSpace; convertTouchToNodeSpaceAR; convertToWorldSpace; convertToWorldSpaceAR; description; getActionByTag; getActionManager; getAnchorPoint; getAnchorPointInPoints; getBoundingBox; getBoundingBoxToWorld; getCamera; getChildByTag; getChildren; getChildrenCount; getComponent; getContentSize; getGLServerState; getGrid; getOrderOfArrival; getParent; getPosition; getPositionX; getPositionY; getRotation; getRotationX; getRotationY; getScale; getScaleX; getScaleY; getScheduler; getShaderProgram; getSkewX; getSkewY; getTag; getUserData; getUserObject; getVertexZ; getZOrder; isIgnoreAnchorPointForPosition; isRunning; isVisible; nodeToWorldTransform; numberOfRunningActions; onEnter; onEnterTransitionDidFinish; onExit; onExitTransitionDidStart; parentToNodeTransform; pauseSchedulerAndActions; removeAllChildrenWithCleanup; removeAllComponents; removeChildByTag; removeComponent; removeFromParent; removeFromParentAndCleanup; resumeSchedulerAndActions; retain; runAction; schedule; scheduleOnce; scheduleUpdate; scheduleUpdateWithPriority; setActionManager; setAdditionalTransform; setContentSize; setGLServerState; setGrid; setOrderOfArrival; setParent; setPositionX; setPositionY; setRotationX; setRotationY; setScheduler; setShaderProgram; setTag; setUserData; setUserObject; setZOrder; sortAllChildren; stopAction; stopActionByTag; stopAllActions; transformAncestors; unschedule; unscheduleAllCallbacks; unscheduleUpdate; update; worldToNodeTransform

Class Detail

cc.Sprite()

cc.Sprite is a 2d image ( http://en.wikipedia.org/wiki/Sprite_(computer_graphics) )
cc.Sprite can be created with an image, or with a sub-rectangle of an image.
If the parent or any of its ancestors is a cc.SpriteBatchNode then the following features/limitations are valid
- Features when the parent is a cc.BatchNode:
- MUCH faster rendering, specially if the cc.SpriteBatchNode has many children. All the children will be drawn in a single batch.
- Limitations
- Camera is not supported yet (eg: CCOrbitCamera action doesn't work)
- GridBase actions are not supported (eg: CCLens, CCRipple, CCTwirl)
- The Alias/Antialias property belongs to CCSpriteBatchNode, so you can't individually set the aliased property.
- The Blending function property belongs to CCSpriteBatchNode, so you can't individually set the blending function property.
- Parallax scroller is not supported, but can be simulated with a "proxy" sprite.
If the parent is an standard cc.Node, then cc.Sprite behaves like any other cc.Node:
- It supports blending functions
- It supports aliasing / antialiasing
- But the rendering will be slower: 1 draw per children.
The default anchorPoint in cc.Sprite is (0.5, 0.5).

var aSprite = new cc.Sprite();

aSprite.initWithFile("HelloHTML5World.png",cc.rect(0,0,480,320));

Field Detail

addChild

Add child to sprite (override cc.Node )

ctor

Constructor

draw

draw sprite to canvas

{Boolean} init

Initializes an empty sprite with nothing init.

{Boolean} initWithTexture

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.getInstance().addImage("HelloHTML5World.png");

var mySprite = new cc.Sprite();

mySprite.initWithTexture(img,cc.rect(0,0,480,320));

{Boolean} isFrameDisplayed

Returns whether or not a cc.SpriteFrame is being displayed

setBatchNode

Sets the batch node to sprite

 var batch = cc.SpriteBatchNode.create("Images/grossini_dance_atlas.png", 15);

 var sprite = cc.Sprite.createWithTexture(batch.getTexture(), cc.rect(0, 0, 57, 57));

 batch.addChild(sprite);

 layer.addChild(batch);

setBlendFunc

conforms to cc.TextureProtocol protocol

setColor

color setter

setDisplayFrame

Sets a new display frame to the cc.Sprite.

setOpacity

opacity setter

setOpacityModifyRGB

opacity: conforms to CCRGBAProtocol protocol

setTexture

Texture of sprite setter

setTextureRect

updates the texture rect of the CCSprite in points.

updateTransform

updates the quad according the the rotation, position, scale values.

Method Detail

<static> {cc.Sprite} cc.Sprite.create(fileName, rect)

Create a sprite with filename and rect
```
//create a sprite with filename

var sprite1 = cc.Sprite.create("HelloHTML5World.png");

//create a sprite with filename and rect

var sprite2 = cc.Sprite.create("HelloHTML5World.png",cc.rect(0,0,480,320));
```
Parameters:

{String} 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
<static> {cc.Sprite} cc.Sprite.createWithSpriteFrame(spriteFrame)

Creates a sprite with a sprite frame.

A CCSpriteFrame will be fetched from the CCSpriteFrameCache by pszSpriteFrameName param.
If the CCSpriteFrame doesn't exist it will raise an exception.
```
//get a sprite frame

var spriteFrame = cc.SpriteFrameCache.getInstance().getSpriteFrame("grossini_dance_01.png");

//create a sprite with a sprite frame

var sprite = cc.Sprite.createWithSpriteFrame(spriteFrame);
```
Parameters:

{cc.SpriteFrame} spriteFrame

A sprite frame which involves a texture and a rect

Returns:

{cc.Sprite} A valid sprite object
<static> {cc.Sprite} cc.Sprite.createWithSpriteFrameName(spriteFrameName)

Creates a sprite with a sprite frame.

A CCSpriteFrame will be fetched from the CCSpriteFrameCache by pszSpriteFrameName param.
If the CCSpriteFrame doesn't exist it will raise an exception.
```
//create a sprite with a sprite frame

var sprite = cc.Sprite.createWithSpriteFrameName('grossini_dance_01.png');
```
Parameters:

{String} spriteFrameName

A sprite frame which involves a texture and a rect

Returns:

{cc.Sprite} A valid sprite object
<static> {cc.Sprite} cc.Sprite.createWithTexture(texture, rect)

Creates 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).
```
//get an image

var img = cc.TextureCache.getInstance().addImage("HelloHTML5World.png");

//create a sprite with texture

var sprite1 = cc.Sprite.createWithTexture(img);

//create a sprite with texture and rect

var sprite2 = cc.Sprite.createWithTexture(img, cc.rect(0,0,480,320));
```
Parameters:

{cc.Texture2D} texture

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

{cc.Rect} rect

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

Returns:

{cc.Sprite} A valid sprite object
{cc.SpriteFrame} displayFrame()

Returns the current displayed frame.

Returns:

{cc.SpriteFrame}
{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.SpriteBatchNode} getSpriteBatchNode()

return the SpriteBatchNode of the cc.Sprite

Returns:

{cc.SpriteBatchNode}
{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} 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.getInstance().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} 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} 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
SET_DIRTY_RECURSIVELY()

HACK: optimization
setAnchorPoint(anchor)

AnchorPoint setter (override cc.Node )

Parameters:

{cc.Point} anchor
setAtlasIndex(atlasIndex)

Set the index used on the TextureAtlas.

Parameters:

{Number} atlasIndex
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
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.
setPosition(pos)

position setter (override cc.Node )

Parameters:

{cc.Point} pos
setRotation(rotation)

Rotation setter (override cc.Node )

Parameters:

{Number} rotation
setScale(scale, scaleY)

The scale factor of the node. 1.0 is the default scale factor.
It modifies the X and Y scale at the same time. (override cc.Node )

Parameters:

{Number} scale

{Number|null} scaleY Optional
setScaleX(scaleX)

ScaleX setter (override cc.Node )

Parameters:

{Number} scaleX
setScaleY(scaleY)

ScaleY setter (override cc.Node )

Parameters:

{Number} scaleY
setSkewX(sx)

SkewX setter (override cc.Node )

Parameters:

{Number} sx

SkewX value
setSkewY(sy)

SkewY setter (override cc.Node )

Parameters:

{Number} sy

SkewY value
setSpriteBatchNode(spriteBatchNode)

set the SpriteBatchNode of the cc.Sprite

Parameters:

{cc.SpriteBatchNode} spriteBatchNode
setTextureAtlas(textureAtlas)

Sets the weak reference of the cc.TextureAtlas when the sprite is rendered using via cc.SpriteBatchNode

Parameters:

{cc.TextureAtlas} textureAtlas
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:

rect
setVertexZ(vertexZ)

VertexZ setter (override cc.Node )

Parameters:

{Number} vertexZ
setVisible(visible)

visible setter (override cc.Node )

Parameters:

{Boolean} visible
updateColor()

Update sprite's color
useBatchNode(batchNode)

tell the sprite to use batch node render.

Parameters:

{cc.SpriteBatchNode} batchNode

cc.Sprite的更多相关文章

<9>cc.Sprite组件
1.精灵精灵(Sprite)是Cocos系列的核心概念之一,是Cocos Creator最常用的显示图像的组件. 游戏中显示一个图片,我们就可以把这个叫做”精灵” sprite,这只是简单理解概念. ...
cocos动画没有cc.Sprite.spriteFrame属性
对于新人来说总是有那么多的坑等着你. 新建动画节点的时候千万别[新建空节点]!!! 上面这个就是新建了空的节点,导致没有cc.Sprite.spriteFrame属性. 正确姿势: 粗略试了一下除了空 ...
cc.Sprite组件
1.精灵精灵(Sprite)是Cocos系列的核心概念之一,是Cocos Creator最常用的显示图像的组件. 游戏中显示一个图片,我们就可以把这个叫做"精灵" sprite, ...
cocos2d-js Shader系列2：在cc.Sprite上使用Shader（黑白、灰度、造旧效果）
在Sprite中使用Shader做特殊的颜色处理比较简单,只需要把Shader程序绑定到Sprite上即可: sprite.shaderProgram = alphaTestShader; Cocos ...
cc.Sprite 与 ccui.ImageView 改变图片
sprite.setTexture(fileName); imageView.loadTexture(fileName);
[cocos2d-js]cc.RenderTexture几种用法(数字图片、刮刮乐效果)
[转]http://blog.csdn.net/realcrazysun1/article/details/42393629 本文基于cocos2d-js 3.0版本引擎开发 RenderTextur ...
cocos2d-html5 sprite打印宽高都为0的问题
版本是2.1.4,在程序里直接通过图片路径addChild了一个cc.Sprite,想要缩放时通是不起做用,于是通过打印发现其宽,高都为0,查来查去,发现:原来是图片没有注册到Resource.js里 ...
cc.RepeatForever和cc.Spawn冲突
正确 var tmpShip3 = cc.Sprite.createWithSpriteFrameName("w1_1.png"); tmpShip3.setPosition(,) ...
Cocos2d-js中使用纹理对象创建Sprite对象
本节我们会通过一个实例介绍纹理对象创建Sprite对象使用,这个实例如图5-2所示,其中地面上的草是放在背景(如下图所示)中的,场景中的两棵树是从后图所示的“树”纹理图片中截取出来的,图5-5所示是树 ...

随机推荐

build.gradle(Project) 和 build.gradle(Module) 的区别
参考: http://stackoverflow.com/questions/28295933/difference-between-build-gradleproject-and-build-gra ...
选错实施顾问公司 ERP项目九死一生
今天接到一个朋友的电话,他是一家企业老总.这位老总感到非常头疼的是他的企业选择了一款国际上名气很大的ERP软件,但实施效果却强差人意.他的疑问是"不是说只要选对了ERP产品,谁实施都能成功吗 ...
How to install Node.js on Linux
How to install Node.js on Linux Posted on November 13, 2015 by Dan Nanni Leave a comment Question: H ...
hihoCoder #1174 : 拓扑排序·一 (判断循环图)
G++ 261ms 13MB 题意: 给出n门课程的修读所需要的前置课程的关系,按理说应该是个拓扑图,但是因为某些原因导致了混乱,所以有可能不是一个拓扑图.现在的问题是,判断该图是否为一个拓扑图(即无 ...
PHP实现站点pv，uv统计（一）
具体步骤分为数据采集脚本,数据收取服务,数据分析脚本,数据存储服务采集脚本一般有两种形式,一种是简单的页面插入一个图片进行请求,一种是复杂的动态生成js标签,引入一段js(这时采集服务器会网往客户端 ...
【英语】Bingo口语笔记(22) - Talk系列
talk back 顶嘴 talk somebody in to something 劝某人做某事 tal somebody out of something 劝某人不做某事
linux 下RMAN备份shell脚本
RMAN备份对于Oracle数据库的备份与恢复简单易用,成本低廉.对于使用非catalog方式而言,将RMAN脚本嵌入到shell脚本,然后再通过crontab来实现中小型数据库数据库备份无疑是首选. ...
android webview 遇到的问题：external/chromium/net/disk_cache/stat_hub.cc:216:
今天也遇到这个问题,界面显示无法访问,Baidu吧,结果有些含糊其词,有的说加网络权限,我看了下我的, 有个 <uses-permission android:name="androi ...
tomcat Manger App
转发链接,嘿嘿http://simeon.blog.51cto.com/18680/58877
Lists
List类主要提供了对List类的子类构造以及操作的静态方法.在类中支持构造ArrayList.LinkedList以及newCopyOnWriteArrayList对象的方法.其中提供了以下构造Ar ...

cc.Sprite