2012-04-19 14:35:52 +08:00
|
|
|
/****************************************************************************
|
|
|
|
Copyright (c) 2008-2010 Ricardo Quesada
|
2014-01-07 11:25:07 +08:00
|
|
|
Copyright (c) 2010-2012 cocos2d-x.org
|
2012-04-19 14:35:52 +08:00
|
|
|
Copyright (c) 2011 Zynga Inc.
|
2014-01-07 11:25:07 +08:00
|
|
|
Copyright (c) 2013-2014 Chukong Technologies Inc.
|
2012-04-19 14:35:52 +08:00
|
|
|
|
|
|
|
http://www.cocos2d-x.org
|
|
|
|
|
|
|
|
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
|
|
of this software and associated documentation files (the "Software"), to deal
|
|
|
|
in the Software without restriction, including without limitation the rights
|
|
|
|
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
|
|
copies of the Software, and to permit persons to whom the Software is
|
|
|
|
furnished to do so, subject to the following conditions:
|
|
|
|
|
|
|
|
The above copyright notice and this permission notice shall be included in
|
|
|
|
all copies or substantial portions of the Software.
|
|
|
|
|
|
|
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
|
|
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
|
|
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
|
|
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
|
|
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
|
|
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
|
|
|
THE SOFTWARE.
|
|
|
|
****************************************************************************/
|
|
|
|
|
2013-11-11 11:00:50 +08:00
|
|
|
#ifndef __SPRITE_NODE_CCSPRITE_H__
|
|
|
|
#define __SPRITE_NODE_CCSPRITE_H__
|
2012-04-19 14:35:52 +08:00
|
|
|
|
2014-08-28 17:03:29 +08:00
|
|
|
#include <string>
|
2014-04-27 01:11:22 +08:00
|
|
|
#include "2d/CCNode.h"
|
2014-09-26 17:14:55 +08:00
|
|
|
#include "2d/CCDrawNode.h"
|
2014-05-17 05:36:00 +08:00
|
|
|
#include "base/CCProtocols.h"
|
|
|
|
#include "renderer/CCTextureAtlas.h"
|
2014-04-30 08:37:36 +08:00
|
|
|
#include "renderer/CCQuadCommand.h"
|
|
|
|
#include "renderer/CCCustomCommand.h"
|
2012-04-19 14:35:52 +08:00
|
|
|
|
|
|
|
NS_CC_BEGIN
|
|
|
|
|
2013-06-20 14:13:12 +08:00
|
|
|
class SpriteBatchNode;
|
|
|
|
class SpriteFrame;
|
|
|
|
class Animation;
|
|
|
|
class Rect;
|
|
|
|
class Size;
|
|
|
|
class Texture2D;
|
2012-04-19 14:35:52 +08:00
|
|
|
struct transformValues_;
|
|
|
|
|
2012-06-20 18:09:11 +08:00
|
|
|
/**
|
|
|
|
* @addtogroup sprite_nodes
|
|
|
|
* @{
|
|
|
|
*/
|
|
|
|
|
2013-11-11 11:00:50 +08:00
|
|
|
/**
|
2015-03-17 11:26:33 +08:00
|
|
|
* Sprite is a 2d image ( http://en.wikipedia.org/wiki/Sprite_(computer_graphics) ).
|
2013-01-14 16:54:20 +08:00
|
|
|
*
|
2013-06-20 14:13:12 +08:00
|
|
|
* Sprite can be created with an image, or with a sub-rectangle of an image.
|
2013-01-14 16:54:20 +08:00
|
|
|
*
|
2014-03-07 08:14:06 +08:00
|
|
|
* To optimize the Sprite rendering, please follow the following best practices:
|
2015-03-17 11:26:33 +08:00
|
|
|
* - Put all your sprites in the same spritesheet (http://www.codeandweb.com/what-is-a-sprite-sheet).
|
|
|
|
* - Use the same blending function for all your sprites.
|
2014-03-07 08:14:06 +08:00
|
|
|
* - ...and the Renderer will automatically "batch" your sprites (will draw all of them in one OpenGL call).
|
2013-01-14 16:54:20 +08:00
|
|
|
*
|
2014-03-07 08:14:06 +08:00
|
|
|
* To gain an additional 5% ~ 10% more in the rendering, you can parent your sprites into a `SpriteBatchNode`.
|
|
|
|
* But doing so carries the following limitations:
|
|
|
|
*
|
|
|
|
* - The Alias/Antialias property belongs to `SpriteBatchNode`, so you can't individually set the aliased property.
|
|
|
|
* - The Blending function property belongs to `SpriteBatchNode`, so you can't individually set the blending function property.
|
|
|
|
* - `ParallaxNode` is not supported, but can be simulated with a "proxy" sprite.
|
|
|
|
* - Sprites can only have other Sprites (or subclasses of Sprite) as children.
|
2013-01-14 16:54:20 +08:00
|
|
|
*
|
2013-06-20 14:13:12 +08:00
|
|
|
* The default anchorPoint in Sprite is (0.5, 0.5).
|
2013-01-14 16:54:20 +08:00
|
|
|
*/
|
2013-12-06 18:07:16 +08:00
|
|
|
class CC_DLL Sprite : public Node, public TextureProtocol
|
2012-04-19 14:35:52 +08:00
|
|
|
{
|
|
|
|
public:
|
2015-03-17 11:26:33 +08:00
|
|
|
/** Sprite invalid index on the SpriteBatchNode. */
|
|
|
|
static const int INDEX_NOT_INITIALIZED = -1;
|
2013-07-20 13:01:27 +08:00
|
|
|
|
2013-01-14 16:54:20 +08:00
|
|
|
/// @name Creators
|
2015-03-17 11:26:33 +08:00
|
|
|
/// @{
|
2013-11-11 11:00:50 +08:00
|
|
|
|
2013-01-14 16:54:20 +08:00
|
|
|
/**
|
|
|
|
* Creates an empty sprite without texture. You can call setTexture method subsequently.
|
|
|
|
*
|
2015-03-17 11:26:33 +08:00
|
|
|
* @memberof Sprite
|
2014-03-07 08:14:06 +08:00
|
|
|
* @return An autoreleased sprite object.
|
2012-04-19 14:35:52 +08:00
|
|
|
*/
|
2013-06-20 14:13:12 +08:00
|
|
|
static Sprite* create();
|
2013-11-11 11:00:50 +08:00
|
|
|
|
2013-01-14 16:54:20 +08:00
|
|
|
/**
|
|
|
|
* Creates a sprite with an image filename.
|
|
|
|
*
|
|
|
|
* After creation, the rect of sprite will be the size of the image,
|
|
|
|
* and the offset will be (0,0).
|
|
|
|
*
|
2014-03-07 08:14:06 +08:00
|
|
|
* @param filename A path to image file, e.g., "scene1/monster.png"
|
|
|
|
* @return An autoreleased sprite object.
|
2013-01-14 16:54:20 +08:00
|
|
|
*/
|
2013-11-06 11:02:03 +08:00
|
|
|
static Sprite* create(const std::string& filename);
|
2013-11-11 11:00:50 +08:00
|
|
|
|
2013-01-14 16:54:20 +08:00
|
|
|
/**
|
|
|
|
* Creates a sprite with an image filename and a rect.
|
|
|
|
*
|
2014-03-07 08:14:06 +08:00
|
|
|
* @param filename A path to image file, e.g., "scene1/monster.png"
|
|
|
|
* @param rect A subrect of the image file
|
|
|
|
* @return An autoreleased sprite object
|
2013-01-14 16:54:20 +08:00
|
|
|
*/
|
2013-11-06 11:02:03 +08:00
|
|
|
static Sprite* create(const std::string& filename, const Rect& rect);
|
2013-11-11 11:00:50 +08:00
|
|
|
|
2013-01-14 16:54:20 +08:00
|
|
|
/**
|
2014-03-07 08:14:06 +08:00
|
|
|
* Creates a sprite with a Texture2D object.
|
|
|
|
*
|
2013-01-14 21:51:47 +08:00
|
|
|
* After creation, the rect will be the size of the texture, and the offset will be (0,0).
|
2013-01-14 16:54:20 +08:00
|
|
|
*
|
2013-07-26 06:53:24 +08:00
|
|
|
* @param texture A pointer to a Texture2D object.
|
2014-03-07 08:14:06 +08:00
|
|
|
* @return An autoreleased sprite object
|
2012-06-14 15:13:16 +08:00
|
|
|
*/
|
2013-07-26 06:53:24 +08:00
|
|
|
static Sprite* createWithTexture(Texture2D *texture);
|
2013-11-11 11:00:50 +08:00
|
|
|
|
2013-01-14 16:54:20 +08:00
|
|
|
/**
|
|
|
|
* Creates a sprite with a texture and a rect.
|
|
|
|
*
|
|
|
|
* After creation, the offset will be (0,0).
|
|
|
|
*
|
2015-03-17 11:26:33 +08:00
|
|
|
* @param texture A pointer to an existing Texture2D object.
|
2013-06-20 14:13:12 +08:00
|
|
|
* You can use a Texture2D object for many sprites.
|
2013-01-14 21:51:47 +08:00
|
|
|
* @param rect Only the contents inside the rect of this texture will be applied for this sprite.
|
2015-03-17 11:26:33 +08:00
|
|
|
* @param rotated Whether or not the rect is rotated.
|
|
|
|
* @return An autoreleased sprite object.
|
2012-06-14 15:13:16 +08:00
|
|
|
*/
|
2013-11-14 07:55:36 +08:00
|
|
|
static Sprite* createWithTexture(Texture2D *texture, const Rect& rect, bool rotated=false);
|
2013-11-11 11:00:50 +08:00
|
|
|
|
2013-01-14 16:54:20 +08:00
|
|
|
/**
|
|
|
|
* Creates a sprite with an sprite frame.
|
|
|
|
*
|
2015-03-17 11:26:33 +08:00
|
|
|
* @param spriteFrame A sprite frame which involves a texture and a rect.
|
|
|
|
* @return An autoreleased sprite object.
|
2013-01-14 16:54:20 +08:00
|
|
|
*/
|
2014-03-07 08:14:06 +08:00
|
|
|
static Sprite* createWithSpriteFrame(SpriteFrame *spriteFrame);
|
2013-11-11 11:00:50 +08:00
|
|
|
|
2013-01-14 16:54:20 +08:00
|
|
|
/**
|
|
|
|
* Creates a sprite with an sprite frame name.
|
|
|
|
*
|
2013-07-26 06:53:24 +08:00
|
|
|
* A SpriteFrame will be fetched from the SpriteFrameCache by spriteFrameName param.
|
2013-06-20 14:13:12 +08:00
|
|
|
* If the SpriteFrame doesn't exist it will raise an exception.
|
2013-01-14 16:54:20 +08:00
|
|
|
*
|
2013-07-26 06:53:24 +08:00
|
|
|
* @param spriteFrameName A null terminated string which indicates the sprite frame name.
|
2015-03-17 11:26:33 +08:00
|
|
|
* @return An autoreleased sprite object.
|
2012-04-19 14:35:52 +08:00
|
|
|
*/
|
2013-11-06 11:02:03 +08:00
|
|
|
static Sprite* createWithSpriteFrameName(const std::string& spriteFrameName);
|
2013-11-11 11:00:50 +08:00
|
|
|
|
2015-03-17 11:26:33 +08:00
|
|
|
// end of creators group
|
|
|
|
/// @}
|
2013-11-11 11:00:50 +08:00
|
|
|
|
|
|
|
|
2013-01-14 16:54:20 +08:00
|
|
|
/// @{
|
|
|
|
/// @name BatchNode methods
|
2013-11-11 11:00:50 +08:00
|
|
|
|
2013-01-14 16:54:20 +08:00
|
|
|
/**
|
2013-11-11 11:00:50 +08:00
|
|
|
* Updates the quad according the rotation, position, scale values.
|
2012-04-19 14:35:52 +08:00
|
|
|
*/
|
2015-03-15 02:33:15 +08:00
|
|
|
virtual void updateTransform() override;
|
2013-11-11 11:00:50 +08:00
|
|
|
|
2013-01-14 16:54:20 +08:00
|
|
|
/**
|
2015-03-17 11:26:33 +08:00
|
|
|
* Returns the batch node object if this sprite is rendered by SpriteBatchNode.
|
2013-01-14 16:54:20 +08:00
|
|
|
*
|
2013-06-20 14:13:12 +08:00
|
|
|
* @return The SpriteBatchNode object if this sprite is rendered by SpriteBatchNode,
|
2013-12-18 17:47:20 +08:00
|
|
|
* nullptr if the sprite isn't used batch node.
|
2012-04-19 14:35:52 +08:00
|
|
|
*/
|
2014-11-26 09:53:52 +08:00
|
|
|
virtual SpriteBatchNode* getBatchNode() const;
|
2013-01-14 16:54:20 +08:00
|
|
|
/**
|
|
|
|
* Sets the batch node to sprite
|
|
|
|
* @warning This method is not recommended for game developers. Sample code for using batch node
|
|
|
|
* @code
|
2013-06-20 14:13:12 +08:00
|
|
|
* SpriteBatchNode *batch = SpriteBatchNode::create("Images/grossini_dance_atlas.png", 15);
|
2013-07-12 14:30:26 +08:00
|
|
|
* Sprite *sprite = Sprite::createWithTexture(batch->getTexture(), Rect(0, 0, 57, 57));
|
2013-01-14 16:54:20 +08:00
|
|
|
* batch->addChild(sprite);
|
|
|
|
* layer->addChild(batch);
|
|
|
|
* @endcode
|
2012-04-19 14:35:52 +08:00
|
|
|
*/
|
2013-07-26 06:53:24 +08:00
|
|
|
virtual void setBatchNode(SpriteBatchNode *spriteBatchNode);
|
2013-11-11 11:00:50 +08:00
|
|
|
|
2013-01-14 16:54:20 +08:00
|
|
|
/// @} end of BatchNode methods
|
2013-11-11 11:00:50 +08:00
|
|
|
|
|
|
|
|
2013-01-14 16:54:20 +08:00
|
|
|
/// @{
|
2013-11-14 07:55:36 +08:00
|
|
|
/// @name Texture / Frame methods
|
|
|
|
|
2013-11-15 07:37:43 +08:00
|
|
|
/** Sets a new texture (from a filename) to the sprite.
|
2015-03-17 11:26:33 +08:00
|
|
|
*
|
|
|
|
* @memberof Sprite
|
|
|
|
* It will call `setTextureRect()` with the texture's content size.
|
2013-11-15 07:37:43 +08:00
|
|
|
*/
|
2013-11-14 07:55:36 +08:00
|
|
|
virtual void setTexture(const std::string &filename );
|
2013-11-11 11:00:50 +08:00
|
|
|
|
2015-03-17 11:26:33 +08:00
|
|
|
/** @overload
|
|
|
|
*
|
|
|
|
* The Texture's rect is not changed.
|
2013-11-15 07:37:43 +08:00
|
|
|
*/
|
|
|
|
virtual void setTexture(Texture2D *texture) override;
|
|
|
|
|
2015-03-17 11:26:33 +08:00
|
|
|
/** Returns the Texture2D object used by the sprite. */
|
2013-11-15 07:37:43 +08:00
|
|
|
virtual Texture2D* getTexture() const override;
|
|
|
|
|
2013-01-14 16:54:20 +08:00
|
|
|
/**
|
2013-06-20 14:13:12 +08:00
|
|
|
* Updates the texture rect of the Sprite in points.
|
2015-03-17 11:26:33 +08:00
|
|
|
*
|
2013-08-01 16:39:42 +08:00
|
|
|
* It will call setTextureRect(const Rect& rect, bool rotated, const Size& untrimmedSize) with \p rotated = false, and \p utrimmedSize = rect.size.
|
2012-04-19 14:35:52 +08:00
|
|
|
*/
|
2013-06-20 14:13:12 +08:00
|
|
|
virtual void setTextureRect(const Rect& rect);
|
2013-11-11 11:00:50 +08:00
|
|
|
|
2015-03-17 11:26:33 +08:00
|
|
|
/** @overload
|
|
|
|
*
|
2013-01-14 16:54:20 +08:00
|
|
|
* It will update the texture coordinates and the vertex rectangle.
|
2012-04-19 14:35:52 +08:00
|
|
|
*/
|
2013-06-20 14:13:12 +08:00
|
|
|
virtual void setTextureRect(const Rect& rect, bool rotated, const Size& untrimmedSize);
|
2013-11-11 11:00:50 +08:00
|
|
|
|
2013-01-14 16:54:20 +08:00
|
|
|
/**
|
|
|
|
* Sets the vertex rect.
|
2015-03-17 11:26:33 +08:00
|
|
|
*
|
2013-01-14 16:54:20 +08:00
|
|
|
* 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.
|
2012-04-19 14:35:52 +08:00
|
|
|
*/
|
2013-06-20 14:13:12 +08:00
|
|
|
virtual void setVertexRect(const Rect& rect);
|
2013-11-11 11:00:50 +08:00
|
|
|
|
2015-03-17 11:26:33 +08:00
|
|
|
/** @{
|
2013-11-14 07:55:36 +08:00
|
|
|
* Sets a new SpriteFrame to the Sprite.
|
2012-04-19 14:35:52 +08:00
|
|
|
*/
|
2013-11-14 07:55:36 +08:00
|
|
|
virtual void setSpriteFrame(const std::string &spriteFrameName);
|
2014-01-04 21:53:03 +08:00
|
|
|
virtual void setSpriteFrame(SpriteFrame* newFrame);
|
2015-03-17 11:26:33 +08:00
|
|
|
/** @} */
|
2013-11-14 07:55:36 +08:00
|
|
|
|
|
|
|
/** @deprecated Use `setSpriteFrame()` instead. */
|
2013-11-15 07:37:43 +08:00
|
|
|
CC_DEPRECATED_ATTRIBUTE virtual void setDisplayFrame(SpriteFrame *newFrame) { setSpriteFrame(newFrame); }
|
2013-11-11 11:00:50 +08:00
|
|
|
|
2013-01-14 16:54:20 +08:00
|
|
|
/**
|
2015-03-17 11:26:33 +08:00
|
|
|
* Returns whether or not a SpriteFrame is being displayed.
|
2012-04-19 14:35:52 +08:00
|
|
|
*/
|
2014-12-30 11:55:54 +08:00
|
|
|
virtual bool isFrameDisplayed(SpriteFrame *frame) const;
|
2013-11-11 11:00:50 +08:00
|
|
|
|
2013-01-14 16:54:20 +08:00
|
|
|
/**
|
|
|
|
* Returns the current displayed frame.
|
|
|
|
*/
|
2013-11-15 07:37:43 +08:00
|
|
|
virtual SpriteFrame* getSpriteFrame() const;
|
2015-03-17 11:26:33 +08:00
|
|
|
/** @deprecated Use `getSpriteFrame()` instead. */
|
2013-11-15 07:37:43 +08:00
|
|
|
CC_DEPRECATED_ATTRIBUTE virtual SpriteFrame* getDisplayFrame() const { return getSpriteFrame(); }
|
2015-03-17 11:26:33 +08:00
|
|
|
/** @deprecated Use `getSpriteFrame()` instead. */
|
2013-11-15 07:37:43 +08:00
|
|
|
CC_DEPRECATED_ATTRIBUTE virtual SpriteFrame* displayFrame() const { return getSpriteFrame(); };
|
2013-11-11 11:00:50 +08:00
|
|
|
|
2013-01-14 16:54:20 +08:00
|
|
|
/// @} End of frames methods
|
2013-11-11 11:00:50 +08:00
|
|
|
|
2012-04-19 14:35:52 +08:00
|
|
|
|
2013-01-14 16:54:20 +08:00
|
|
|
/// @{
|
|
|
|
/// @name Animation methods
|
|
|
|
/**
|
|
|
|
* Changes the display frame with animation name and index.
|
2015-03-17 11:26:33 +08:00
|
|
|
* The animation name will be get from the AnimationCache.
|
2013-01-14 16:54:20 +08:00
|
|
|
*/
|
2013-12-12 12:07:20 +08:00
|
|
|
virtual void setDisplayFrameWithAnimationName(const std::string& animationName, ssize_t frameIndex);
|
2013-01-14 16:54:20 +08:00
|
|
|
/// @}
|
2013-11-11 11:00:50 +08:00
|
|
|
|
|
|
|
|
2013-01-14 16:54:20 +08:00
|
|
|
/// @{
|
2015-03-17 11:26:33 +08:00
|
|
|
/// @name Sprite Properties' setter/getters.
|
2013-11-11 11:00:50 +08:00
|
|
|
|
|
|
|
/**
|
2013-01-14 16:54:20 +08:00
|
|
|
* Whether or not the Sprite needs to be updated in the Atlas.
|
|
|
|
*
|
|
|
|
* @return true if the sprite needs to be updated in the Atlas, false otherwise.
|
|
|
|
*/
|
2014-12-30 11:55:54 +08:00
|
|
|
virtual bool isDirty() const { return _dirty; }
|
2013-11-11 11:00:50 +08:00
|
|
|
|
|
|
|
/**
|
2013-01-14 16:54:20 +08:00
|
|
|
* Makes the Sprite to be updated in the Atlas.
|
|
|
|
*/
|
2014-02-25 07:18:07 +08:00
|
|
|
virtual void setDirty(bool dirty) { _dirty = dirty; }
|
2013-11-11 11:00:50 +08:00
|
|
|
|
2013-01-14 16:54:20 +08:00
|
|
|
/**
|
2013-09-13 11:41:20 +08:00
|
|
|
* Returns the quad (tex coords, vertex coords and color) information.
|
|
|
|
* @js NA
|
|
|
|
* @lua NA
|
2013-01-14 16:54:20 +08:00
|
|
|
*/
|
2014-12-30 11:55:54 +08:00
|
|
|
inline V3F_C4B_T2F_Quad getQuad() const { return _quad; }
|
2012-04-19 14:35:52 +08:00
|
|
|
|
2013-11-11 11:00:50 +08:00
|
|
|
/**
|
2013-01-14 16:54:20 +08:00
|
|
|
* Returns whether or not the texture rectangle is rotated.
|
|
|
|
*/
|
2014-12-30 11:55:54 +08:00
|
|
|
inline bool isTextureRectRotated() const { return _rectRotated; }
|
2013-11-11 11:00:50 +08:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Returns the index used on the TextureAtlas.
|
2013-01-14 16:54:20 +08:00
|
|
|
*/
|
2014-12-30 11:55:54 +08:00
|
|
|
inline ssize_t getAtlasIndex() const { return _atlasIndex; }
|
2013-11-11 11:00:50 +08:00
|
|
|
|
|
|
|
/**
|
2013-01-14 16:54:20 +08:00
|
|
|
* Sets the index used on the TextureAtlas.
|
2015-03-17 11:26:33 +08:00
|
|
|
*
|
|
|
|
* @warning Don't modify this value unless you know what you are doing.
|
2013-01-14 16:54:20 +08:00
|
|
|
*/
|
2013-12-12 12:07:20 +08:00
|
|
|
inline void setAtlasIndex(ssize_t atlasIndex) { _atlasIndex = atlasIndex; }
|
2012-04-19 14:35:52 +08:00
|
|
|
|
2013-11-11 11:00:50 +08:00
|
|
|
/**
|
2015-03-17 11:26:33 +08:00
|
|
|
* Returns the rect of the Sprite in points.
|
2013-01-14 16:54:20 +08:00
|
|
|
*/
|
2014-12-30 11:55:54 +08:00
|
|
|
inline const Rect& getTextureRect() const { return _rect; }
|
2012-04-19 14:35:52 +08:00
|
|
|
|
2013-01-14 16:54:20 +08:00
|
|
|
/**
|
2015-03-17 11:26:33 +08:00
|
|
|
* Gets the weak reference of the TextureAtlas when the sprite is rendered using via SpriteBatchNode.
|
2013-01-14 16:54:20 +08:00
|
|
|
*/
|
2014-12-30 11:55:54 +08:00
|
|
|
inline TextureAtlas* getTextureAtlas() const { return _textureAtlas; }
|
2013-11-11 11:00:50 +08:00
|
|
|
|
2013-01-14 16:54:20 +08:00
|
|
|
/**
|
2015-03-17 11:26:33 +08:00
|
|
|
* Sets the weak reference of the TextureAtlas when the sprite is rendered using via SpriteBatchNode.
|
2013-01-14 16:54:20 +08:00
|
|
|
*/
|
2014-12-30 11:55:54 +08:00
|
|
|
inline void setTextureAtlas(TextureAtlas *textureAtlas) { _textureAtlas = textureAtlas; }
|
2012-04-19 14:35:52 +08:00
|
|
|
|
2013-11-11 11:00:50 +08:00
|
|
|
/**
|
2013-01-14 16:54:20 +08:00
|
|
|
* Gets the offset position of the sprite. Calculated automatically by editors like Zwoptex.
|
|
|
|
*/
|
2014-12-30 11:55:54 +08:00
|
|
|
inline const Vec2& getOffsetPosition() const { return _offsetPosition; }
|
2012-04-19 14:35:52 +08:00
|
|
|
|
|
|
|
|
2013-11-11 11:00:50 +08:00
|
|
|
/**
|
2013-01-14 16:54:20 +08:00
|
|
|
* 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);
|
|
|
|
*
|
2013-11-11 11:00:50 +08:00
|
|
|
* @return true if the sprite is flipped horizontally, false otherwise.
|
2013-01-14 16:54:20 +08:00
|
|
|
*/
|
2014-12-30 11:55:54 +08:00
|
|
|
bool isFlippedX() const;
|
2013-01-14 16:54:20 +08:00
|
|
|
/**
|
|
|
|
* Sets whether the sprite should be flipped horizontally or not.
|
|
|
|
*
|
2013-11-11 11:00:50 +08:00
|
|
|
* @param flippedX true if the sprite should be flipped horizontally, false otherwise.
|
2013-01-14 16:54:20 +08:00
|
|
|
*/
|
2013-09-13 11:41:20 +08:00
|
|
|
void setFlippedX(bool flippedX);
|
2013-11-11 11:00:50 +08:00
|
|
|
|
2015-03-17 11:26:33 +08:00
|
|
|
/** @deprecated Use isFlippedX() instead.
|
2013-09-13 11:41:20 +08:00
|
|
|
* @js NA
|
|
|
|
* @lua NA
|
|
|
|
*/
|
|
|
|
CC_DEPRECATED_ATTRIBUTE bool isFlipX() { return isFlippedX(); };
|
|
|
|
/** @deprecated Use setFlippedX() instead */
|
2013-11-11 11:00:50 +08:00
|
|
|
CC_DEPRECATED_ATTRIBUTE void setFlipX(bool flippedX) { setFlippedX(flippedX); };
|
|
|
|
|
|
|
|
/**
|
2013-01-14 16:54:20 +08:00
|
|
|
* Return the flag which indicates whether the sprite is flipped vertically or not.
|
2013-11-11 11:00:50 +08:00
|
|
|
*
|
2013-01-14 16:54:20 +08:00
|
|
|
* 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);
|
2013-11-11 11:00:50 +08:00
|
|
|
*
|
|
|
|
* @return true if the sprite is flipped vertically, false otherwise.
|
2013-01-14 16:54:20 +08:00
|
|
|
*/
|
2014-12-30 11:55:54 +08:00
|
|
|
bool isFlippedY() const;
|
2013-01-14 16:54:20 +08:00
|
|
|
/**
|
|
|
|
* Sets whether the sprite should be flipped vertically or not.
|
|
|
|
*
|
2013-11-11 11:00:50 +08:00
|
|
|
* @param flippedY true if the sprite should be flipped vertically, false otherwise.
|
2013-01-14 16:54:20 +08:00
|
|
|
*/
|
2013-09-13 11:41:20 +08:00
|
|
|
void setFlippedY(bool flippedY);
|
2013-11-11 11:00:50 +08:00
|
|
|
|
2013-01-14 16:54:20 +08:00
|
|
|
/// @} End of Sprite properties getter/setters
|
2013-11-11 11:00:50 +08:00
|
|
|
|
2013-09-13 11:41:20 +08:00
|
|
|
/** @deprecated Use isFlippedY() instead */
|
|
|
|
CC_DEPRECATED_ATTRIBUTE bool isFlipY() { return isFlippedY(); };
|
|
|
|
/** @deprecated Use setFlippedY() instead */
|
2013-11-11 11:00:50 +08:00
|
|
|
CC_DEPRECATED_ATTRIBUTE void setFlipY(bool flippedY) { setFlippedY(flippedY); };
|
2013-07-16 03:43:22 +08:00
|
|
|
|
|
|
|
//
|
|
|
|
// Overrides
|
|
|
|
//
|
|
|
|
/// @{
|
|
|
|
/// @name Functions inherited from TextureProtocol
|
2013-09-13 11:41:20 +08:00
|
|
|
/**
|
|
|
|
*@code
|
2015-03-17 11:26:33 +08:00
|
|
|
*When this function bound into js or lua,the parameter will be changed.
|
2013-09-13 11:41:20 +08:00
|
|
|
*In js: var setBlendFunc(var src, var dst)
|
|
|
|
*In lua: local setBlendFunc(local src, local dst)
|
|
|
|
*@endcode
|
|
|
|
*/
|
2013-07-16 03:43:22 +08:00
|
|
|
inline void setBlendFunc(const BlendFunc &blendFunc) override { _blendFunc = blendFunc; }
|
2013-09-13 11:41:20 +08:00
|
|
|
/**
|
|
|
|
* @js NA
|
|
|
|
* @lua NA
|
|
|
|
*/
|
2013-07-23 18:26:26 +08:00
|
|
|
inline const BlendFunc& getBlendFunc() const override { return _blendFunc; }
|
2013-07-16 03:43:22 +08:00
|
|
|
/// @}
|
|
|
|
|
2013-12-13 06:30:22 +08:00
|
|
|
virtual std::string getDescription() const override;
|
|
|
|
|
2013-07-16 03:43:22 +08:00
|
|
|
/// @{
|
2015-03-17 11:26:33 +08:00
|
|
|
/// @name Functions inherited from Node.
|
2013-07-27 21:44:49 +08:00
|
|
|
virtual void setScaleX(float scaleX) override;
|
|
|
|
virtual void setScaleY(float scaleY) override;
|
2013-11-06 21:42:31 +08:00
|
|
|
virtual void setScale(float scaleX, float scaleY) override;
|
2013-09-13 11:41:20 +08:00
|
|
|
/**
|
|
|
|
* @js NA
|
|
|
|
* @lua NA
|
|
|
|
*/
|
2014-05-15 01:07:09 +08:00
|
|
|
virtual void setPosition(const Vec2& pos) override;
|
2013-11-05 01:14:22 +08:00
|
|
|
virtual void setPosition(float x, float y) override;
|
2013-08-01 17:47:37 +08:00
|
|
|
virtual void setRotation(float rotation) override;
|
2014-02-23 17:09:52 +08:00
|
|
|
virtual void setRotationSkewX(float rotationX) override;
|
|
|
|
virtual void setRotationSkewY(float rotationY) override;
|
2013-07-16 03:43:22 +08:00
|
|
|
virtual void setSkewX(float sx) override;
|
|
|
|
virtual void setSkewY(float sy) override;
|
2013-08-01 17:47:37 +08:00
|
|
|
virtual void removeChild(Node* child, bool cleanup) override;
|
|
|
|
virtual void removeAllChildrenWithCleanup(bool cleanup) override;
|
2013-07-26 07:27:24 +08:00
|
|
|
virtual void reorderChild(Node *child, int zOrder) override;
|
2013-12-23 16:58:26 +08:00
|
|
|
using Node::addChild;
|
2013-07-26 07:27:24 +08:00
|
|
|
virtual void addChild(Node *child, int zOrder, int tag) override;
|
2014-06-25 11:27:48 +08:00
|
|
|
virtual void addChild(Node *child, int zOrder, const std::string &name) override;
|
2013-07-16 03:43:22 +08:00
|
|
|
virtual void sortAllChildren() override;
|
2013-08-01 17:47:37 +08:00
|
|
|
virtual void setScale(float scale) override;
|
2014-02-23 17:09:52 +08:00
|
|
|
virtual void setPositionZ(float positionZ) override;
|
2014-05-15 01:07:09 +08:00
|
|
|
virtual void setAnchorPoint(const Vec2& anchor) override;
|
2013-07-16 03:43:22 +08:00
|
|
|
virtual void ignoreAnchorPointForPosition(bool value) override;
|
|
|
|
virtual void setVisible(bool bVisible) override;
|
2014-05-31 07:42:05 +08:00
|
|
|
virtual void draw(Renderer *renderer, const Mat4 &transform, uint32_t flags) override;
|
2013-07-16 03:43:22 +08:00
|
|
|
virtual void setOpacityModifyRGB(bool modify) override;
|
2014-12-30 11:55:54 +08:00
|
|
|
virtual bool isOpacityModifyRGB() const override;
|
2013-07-16 03:43:22 +08:00
|
|
|
/// @}
|
|
|
|
|
2014-03-21 13:44:29 +08:00
|
|
|
CC_CONSTRUCTOR_ACCESS:
|
2013-11-14 07:55:36 +08:00
|
|
|
|
2014-12-30 11:55:54 +08:00
|
|
|
Sprite();
|
|
|
|
virtual ~Sprite();
|
2013-11-14 07:55:36 +08:00
|
|
|
|
|
|
|
/* Initializes an empty sprite with nothing init. */
|
2015-03-15 02:33:15 +08:00
|
|
|
virtual bool init() override;
|
2013-11-14 07:55:36 +08:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Initializes a sprite with a texture.
|
|
|
|
*
|
|
|
|
* After initialization, the rect used will be the size of the texture, and the offset will be (0,0).
|
|
|
|
*
|
|
|
|
* @param texture A pointer to an existing Texture2D object.
|
|
|
|
* You can use a Texture2D object for many sprites.
|
|
|
|
* @return true if the sprite is initialized properly, false otherwise.
|
|
|
|
*/
|
|
|
|
virtual bool initWithTexture(Texture2D *texture);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Initializes a sprite with a texture and a rect.
|
|
|
|
*
|
|
|
|
* After initialization, the offset will be (0,0).
|
|
|
|
*
|
|
|
|
* @param texture A pointer to an exisiting Texture2D object.
|
|
|
|
* You can use a Texture2D object for many sprites.
|
|
|
|
* @param rect Only the contents inside rect of this texture will be applied for this sprite.
|
|
|
|
* @return true if the sprite is initialized properly, false otherwise.
|
|
|
|
*/
|
|
|
|
virtual bool initWithTexture(Texture2D *texture, const Rect& rect);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Initializes a sprite with a texture and a rect in points, optionally rotated.
|
|
|
|
*
|
|
|
|
* After initialization, the offset will be (0,0).
|
|
|
|
* @note This is the designated initializer.
|
|
|
|
*
|
|
|
|
* @param texture A Texture2D object whose texture will be applied to this sprite.
|
|
|
|
* @param rect A rectangle assigned the contents of texture.
|
|
|
|
* @param rotated Whether or not the texture rectangle is rotated.
|
|
|
|
* @return true if the sprite is initialized properly, false otherwise.
|
|
|
|
*/
|
|
|
|
virtual bool initWithTexture(Texture2D *texture, const Rect& rect, bool rotated);
|
|
|
|
|
|
|
|
/**
|
2015-03-17 11:26:33 +08:00
|
|
|
* Initializes a sprite with an SpriteFrame. The texture and rect in SpriteFrame will be applied on this sprite.
|
2013-11-14 07:55:36 +08:00
|
|
|
*
|
2015-03-17 11:26:33 +08:00
|
|
|
* @param pSpriteFrame A SpriteFrame object. It should includes a valid texture and a rect.
|
2013-11-14 07:55:36 +08:00
|
|
|
* @return true if the sprite is initialized properly, false otherwise.
|
|
|
|
*/
|
2014-12-30 11:55:54 +08:00
|
|
|
virtual bool initWithSpriteFrame(SpriteFrame *spriteFrame);
|
2013-11-14 07:55:36 +08:00
|
|
|
|
|
|
|
/**
|
|
|
|
* 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.
|
|
|
|
*
|
2015-03-17 11:26:33 +08:00
|
|
|
* @param spriteFrameName A key string that can fected a volid SpriteFrame from SpriteFrameCache.
|
2013-11-14 07:55:36 +08:00
|
|
|
* @return true if the sprite is initialized properly, false otherwise.
|
|
|
|
*/
|
|
|
|
virtual bool initWithSpriteFrameName(const std::string& spriteFrameName);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* 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).
|
|
|
|
*
|
2015-03-17 11:26:33 +08:00
|
|
|
* @param filename The path to an image file in local file system.
|
2013-11-14 07:55:36 +08:00
|
|
|
* @return true if the sprite is initialized properly, false otherwise.
|
|
|
|
* @js init
|
|
|
|
* @lua init
|
|
|
|
*/
|
|
|
|
virtual bool initWithFile(const std::string& filename);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* 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).
|
|
|
|
*
|
|
|
|
* @param filename The path to an image file in local file system.
|
|
|
|
* @param rect The rectangle assigned the content area from texture.
|
|
|
|
* @return true if the sprite is initialized properly, false otherwise.
|
|
|
|
* @js init
|
|
|
|
* @lua init
|
|
|
|
*/
|
|
|
|
virtual bool initWithFile(const std::string& filename, const Rect& rect);
|
|
|
|
|
2014-03-21 13:44:29 +08:00
|
|
|
protected:
|
|
|
|
|
2015-03-15 02:33:15 +08:00
|
|
|
void updateColor() override;
|
2013-06-20 14:13:12 +08:00
|
|
|
virtual void setTextureCoords(Rect rect);
|
2014-12-30 11:55:54 +08:00
|
|
|
virtual void updateBlendFunc();
|
|
|
|
virtual void setReorderChildDirtyRecursively();
|
|
|
|
virtual void setDirtyRecursively(bool value);
|
2012-04-19 14:35:52 +08:00
|
|
|
|
|
|
|
//
|
2013-06-20 14:13:12 +08:00
|
|
|
// Data used when the sprite is rendered using a SpriteSheet
|
2012-04-19 14:35:52 +08:00
|
|
|
//
|
2013-07-20 13:01:27 +08:00
|
|
|
TextureAtlas* _textureAtlas; /// SpriteBatchNode texture atlas (weak reference)
|
2013-12-12 12:07:20 +08:00
|
|
|
ssize_t _atlasIndex; /// Absolute (real) Index on the SpriteSheet
|
2013-07-20 13:01:27 +08:00
|
|
|
SpriteBatchNode* _batchNode; /// Used batch node (weak reference)
|
2013-11-11 11:00:50 +08:00
|
|
|
|
2013-07-20 13:01:27 +08:00
|
|
|
bool _dirty; /// Whether the sprite needs to be updated
|
|
|
|
bool _recursiveDirty; /// Whether all of the sprite's children needs to be updated
|
|
|
|
bool _shouldBeHidden; /// should not be drawn because one of the ancestors is not visible
|
2014-05-15 01:07:09 +08:00
|
|
|
Mat4 _transformToBatch;
|
2013-11-11 11:00:50 +08:00
|
|
|
|
2012-04-19 14:35:52 +08:00
|
|
|
//
|
|
|
|
// Data used when the sprite is self-rendered
|
|
|
|
//
|
2013-07-05 16:49:22 +08:00
|
|
|
BlendFunc _blendFunc; /// It's required for TextureProtocol inheritance
|
2013-07-20 13:01:27 +08:00
|
|
|
Texture2D* _texture; /// Texture2D object that is used to render the sprite
|
2014-12-08 21:04:15 +08:00
|
|
|
SpriteFrame* _spriteFrame;
|
2013-12-26 16:36:03 +08:00
|
|
|
QuadCommand _quadCommand; /// quad command
|
2014-02-24 20:02:48 +08:00
|
|
|
#if CC_SPRITE_DEBUG_DRAW
|
2014-09-11 15:39:56 +08:00
|
|
|
DrawNode *_debugDrawNode;
|
2014-02-24 20:02:48 +08:00
|
|
|
#endif //CC_SPRITE_DEBUG_DRAW
|
2012-04-19 14:35:52 +08:00
|
|
|
//
|
|
|
|
// Shared data
|
|
|
|
//
|
|
|
|
|
|
|
|
// texture
|
2013-07-20 13:01:27 +08:00
|
|
|
Rect _rect; /// Retangle of Texture2D
|
|
|
|
bool _rectRotated; /// Whether the texture is rotated
|
2012-04-19 14:35:52 +08:00
|
|
|
|
|
|
|
// Offset Position (used by Zwoptex)
|
2014-05-15 01:07:09 +08:00
|
|
|
Vec2 _offsetPosition;
|
|
|
|
Vec2 _unflippedOffsetPositionFromCenter;
|
2012-04-19 14:35:52 +08:00
|
|
|
|
|
|
|
// vertex coords, texture coords and color info
|
2013-07-05 16:49:22 +08:00
|
|
|
V3F_C4B_T2F_Quad _quad;
|
2012-04-19 14:35:52 +08:00
|
|
|
|
|
|
|
// opacity and RGB protocol
|
2013-06-15 14:03:30 +08:00
|
|
|
bool _opacityModifyRGB;
|
2012-04-19 14:35:52 +08:00
|
|
|
|
|
|
|
// image is flipped
|
2013-11-14 07:55:36 +08:00
|
|
|
bool _flippedX; /// Whether the sprite is flipped horizontally or not
|
|
|
|
bool _flippedY; /// Whether the sprite is flipped vertically or not
|
|
|
|
|
2014-03-01 08:10:48 +08:00
|
|
|
bool _insideBounds; /// whether or not the sprite was inside bounds the previous frame
|
2013-11-14 07:55:36 +08:00
|
|
|
private:
|
|
|
|
CC_DISALLOW_COPY_AND_ASSIGN(Sprite);
|
2012-04-19 14:35:52 +08:00
|
|
|
};
|
|
|
|
|
2012-07-13 09:53:38 +08:00
|
|
|
|
2012-06-20 18:09:11 +08:00
|
|
|
// end of sprite_nodes group
|
|
|
|
/// @}
|
|
|
|
|
2012-04-19 14:35:52 +08:00
|
|
|
NS_CC_END
|
|
|
|
|
2013-11-11 11:00:50 +08:00
|
|
|
#endif // __SPRITE_NODE_CCSPRITE_H__
|