CCSprite.h
25.6 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
/****************************************************************************
Copyright (c) 2008-2010 Ricardo Quesada
Copyright (c) 2010-2012 cocos2d-x.org
Copyright (c) 2011 Zynga Inc.
Copyright (c) 2013-2016 Chukong Technologies Inc.
Copyright (c) 2017-2018 Xiamen Yaji Software Co., Ltd.
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.
****************************************************************************/
#pragma once
#include <string>
#include "2d/CCNode.h"
#include "2d/CCDrawNode.h"
#include "base/CCProtocols.h"
#include "renderer/CCTextureAtlas.h"
#include "renderer/CCTrianglesCommand.h"
#include "renderer/CCCustomCommand.h"
#include "2d/CCAutoPolygon.h"
NS_CC_BEGIN
class SpriteBatchNode;
class SpriteFrame;
class Animation;
class Rect;
class Size;
class Texture2D;
struct transformValues_;
#ifdef SPRITE_RENDER_IN_SUBPIXEL
#undef SPRITE_RENDER_IN_SUBPIXEL
#endif
#if CC_SPRITEBATCHNODE_RENDER_SUBPIXEL
#define SPRITE_RENDER_IN_SUBPIXEL
#else
#define SPRITE_RENDER_IN_SUBPIXEL(__ARGS__) (ceil(__ARGS__))
#endif
/**
* @addtogroup _2d
* @{
*/
/**
* Sprite is a 2d image ( http://en.wikipedia.org/wiki/Sprite_(computer_graphics) ).
*
* Sprite can be created with an image, or with a sub-rectangle of an image.
*
* To optimize the Sprite rendering, please follow the following best practices:
* - 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.
* - ...and the Renderer will automatically "batch" your sprites (will draw all of them in one OpenGL call).
*
* Sprite has 4 types or rendering modes:
*
* - `QUAD`: Renders the sprite using 2 triangles (1 rectangle): uses small memory, but renders empty pixels (slow)
* - `POLYGON`: Renders the sprite using many triangles (depending on the setting): Uses more memory, but doesn't render so much empty pixels (faster)
* - `SLICE9`: Renders the sprite using 18 triangles (9 rectangles). Useful to to scale buttons an other rectangular sprites
* - `QUAD_BATCHNODE`: Renders the sprite using 2 triangles (1 rectangle) with a static batch, which has some limitations (see below)
*
* By default, the sprite uses `QUAD` mode. But can be changed to `POLYGON` when calling `setPolygonInfo()`. To use `SLICE9` call `setCenterRect()` or
* `serCenterRectNormalized()`. To use `QUAD_BATCHNODE` parent the sprite to a `SpriteBatchNode` object.
*
*
* `QUAD_BATCHNODE` is deprecated and should be avoid. It has 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.
*
* The default anchorPoint in Sprite is (0.5, 0.5).
*/
class CC_DLL Sprite : public Node, public TextureProtocol
{
public:
enum class RenderMode {
QUAD,
POLYGON,
SLICE9,
QUAD_BATCHNODE
};
/** Sprite invalid index on the SpriteBatchNode. */
static const int INDEX_NOT_INITIALIZED = -1;
/// @name Creators
/// @{
/**
* Creates an empty sprite without texture. You can call setTexture method subsequently.
*
* @memberof Sprite
* @return An autoreleased sprite object.
*/
static Sprite* create();
/**
* 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).
*
* @param filename A path to image file, e.g., "scene1/monster.png".
* @return An autoreleased sprite object.
*/
static Sprite* create(const std::string& filename);
/**
* Creates a polygon sprite with a polygon info.
*
* After creation, the rect of sprite will be the size of the image,
* and the offset will be (0,0).
*
* @param polygonInfo A path to image file, e.g., "scene1/monster.png".
* @return An autoreleased sprite object.
*/
static Sprite* create(const PolygonInfo& info);
/**
* Creates a sprite with an image filename and a rect.
*
* @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.
*/
static Sprite* create(const std::string& filename, const Rect& rect);
/**
* Creates a sprite with a Texture2D object.
*
* After creation, the rect will be the size of the texture, and the offset will be (0,0).
*
* @param texture A pointer to a Texture2D object.
* @return An autoreleased sprite object.
*/
static Sprite* createWithTexture(Texture2D *texture);
/**
* Creates a sprite with a texture and a rect.
*
* After creation, the offset will be (0,0).
*
* @param texture A pointer to an existing Texture2D object.
* You can use a Texture2D object for many sprites.
* @param rect Only the contents inside the rect of this texture will be applied for this sprite.
* @param rotated Whether or not the rect is rotated.
* @return An autoreleased sprite object.
*/
static Sprite* createWithTexture(Texture2D *texture, const Rect& rect, bool rotated=false);
/**
* Creates a sprite with an sprite frame.
*
* @param spriteFrame A sprite frame which involves a texture and a rect.
* @return An autoreleased sprite object.
*/
static Sprite* createWithSpriteFrame(SpriteFrame *spriteFrame);
/**
* Creates a sprite with an sprite frame name.
*
* A SpriteFrame will be fetched from the SpriteFrameCache by spriteFrameName param.
* If the SpriteFrame doesn't exist it will raise an exception.
*
* @param spriteFrameName The name of sprite frame.
* @return An autoreleased sprite object.
*/
static Sprite* createWithSpriteFrameName(const std::string& spriteFrameName);
// end of creators group
/// @}
/// @{
/// @name BatchNode methods
/**
* Updates the quad according the rotation, position, scale values.
*/
virtual void updateTransform() override;
/**
* Returns the batch node object if this sprite is rendered by SpriteBatchNode.
*
* @return The SpriteBatchNode object if this sprite is rendered by SpriteBatchNode,
* nullptr if the sprite isn't used batch node.
*/
virtual SpriteBatchNode* getBatchNode() const;
/**
* Sets the batch node to sprite.
* @warning This method is not recommended for game developers. Sample code for using batch node
* @code
* SpriteBatchNode *batch = SpriteBatchNode::create("Images/grossini_dance_atlas.png", 15);
* Sprite *sprite = Sprite::createWithTexture(batch->getTexture(), Rect(0, 0, 57, 57));
* batch->addChild(sprite);
* layer->addChild(batch);
* @endcode
*/
virtual void setBatchNode(SpriteBatchNode *spriteBatchNode);
/// @} end of BatchNode methods
/// @{
/// @name Texture / Frame methods
/** Sets a new texture (from a filename) to the sprite.
*
* @memberof Sprite
* It will call `setTextureRect()` with the texture's content size.
*/
virtual void setTexture(const std::string &filename );
/** @overload
*
* The Texture's rect is not changed.
*/
virtual void setTexture(Texture2D *texture) override;
/** Returns the Texture2D object used by the sprite. */
virtual Texture2D* getTexture() const override;
/**
* Updates the texture rect of the Sprite in points.
*
* It will call setTextureRect(const Rect& rect, bool rotated, const Size& untrimmedSize) with \p rotated = false, and \p utrimmedSize = rect.size.
*/
virtual void setTextureRect(const Rect& rect);
/** @overload
*
* It will update the texture coordinates and the vertex rectangle.
*/
virtual void setTextureRect(const Rect& rect, bool rotated, const Size& untrimmedSize);
/**
* Sets 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.
*/
virtual void setVertexRect(const Rect& rect);
/**
* setCenterRectNormalized
*
* Useful to implement "9 sliced" sprites.
* The default value is (0,0) - (1,1), which means that only one "slice" will be used: From top-left (0,0) to bottom-right (1,1).
* If the value is different than (0,0), (1,1), then the sprite will be sliced into a 3 x 3 grid. The four corners of this grid are applied without
* performing any scaling. The upper- and lower-middle parts are scaled horizontally, and the left- and right-middle parts are scaled vertically.
* The center is scaled in both directions.
* Important: The scaling is based the Sprite's trimmed size.
*
* Limitations: Does not work when the sprite is part of `SpriteBatchNode`.
*/
virtual void setCenterRectNormalized(const Rect& rect);
/**
* getCenterRectNormalized
*
* Returns the CenterRect in normalized coordinates
*/
virtual Rect getCenterRectNormalized() const;
/* setCenterRect
*
* Like `setCenterRectNormalized`, but instead of being in normalized coordinates, it is in points coordinates
*/
virtual void setCenterRect(const Rect& rect);
/**
* @brief Returns the Cap Insets rect
*
* @return Scale9Sprite's cap inset.
*/
virtual Rect getCenterRect() const;
/** @{
* Sets a new SpriteFrame to the Sprite.
*/
virtual void setSpriteFrame(const std::string &spriteFrameName);
virtual void setSpriteFrame(SpriteFrame* newFrame);
/** @} */
/**
* Returns whether or not a SpriteFrame is being displayed.
*/
virtual bool isFrameDisplayed(SpriteFrame *frame) const;
/**
* Returns the current displayed frame.
*/
virtual SpriteFrame* getSpriteFrame() const;
/// @} End of frames methods
/// @{
/// @name Animation methods
/**
* Changes the display frame with animation name and index.
* The animation name will be get from the AnimationCache.
*/
virtual void setDisplayFrameWithAnimationName(const std::string& animationName, unsigned int frameIndex);
/// @}
/// @{
/// @name Sprite Properties' setter/getters.
/**
* 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.
*/
virtual bool isDirty() const { return _dirty; }
/**
* Makes the Sprite to be updated in the Atlas.
*/
virtual void setDirty(bool dirty) { _dirty = dirty; }
/**
* @js NA
*/
virtual std::string getDescription() const override;
/// @{
/// @name Functions inherited from Node.
virtual void setScaleX(float scaleX) override;
virtual void setScaleY(float scaleY) override;
virtual void setScale(float scaleX, float scaleY) override;
/**
* @js NA
* @lua NA
*/
virtual void setPosition(const Vec2& pos) override;
virtual void setPosition(float x, float y) override;
virtual void setRotation(float rotation) override;
virtual void setRotationSkewX(float rotationX) override;
virtual void setRotationSkewY(float rotationY) override;
virtual void setSkewX(float sx) override;
virtual void setSkewY(float sy) override;
virtual void removeChild(Node* child, bool cleanup) override;
virtual void removeAllChildrenWithCleanup(bool cleanup) override;
virtual void reorderChild(Node *child, int zOrder) override;
using Node::addChild;
virtual void addChild(Node *child, int zOrder, int tag) override;
virtual void addChild(Node *child, int zOrder, const std::string &name) override;
virtual void sortAllChildren() override;
virtual void setScale(float scale) override;
virtual void setPositionZ(float positionZ) override;
virtual void setAnchorPoint(const Vec2& anchor) override;
virtual void setContentSize(const Size& size) override;
virtual void setIgnoreAnchorPointForPosition(bool value) override;
virtual void setVisible(bool bVisible) override;
virtual void draw(Renderer *renderer, const Mat4 &transform, uint32_t flags) override;
virtual void setOpacityModifyRGB(bool modify) override;
virtual bool isOpacityModifyRGB() const override;
/// @}
/**
* Returns the quad (tex coords, vertex coords and color) information.
* @js NA
* @lua NA
*/
V3F_C4B_T2F_Quad getQuad() const { return _quad; }
/**
* Returns whether or not the texture rectangle is rotated.
*/
bool isTextureRectRotated() const { return _rectRotated; }
/**
* Returns the index used on the TextureAtlas.
*/
unsigned int getAtlasIndex() const { return _atlasIndex; }
/**
* Sets the index used on the TextureAtlas.
*
* @warning Don't modify this value unless you know what you are doing.
*/
void setAtlasIndex(unsigned int atlasIndex) { _atlasIndex = atlasIndex; }
/**
* Returns the rect of the Sprite in points.
*/
const Rect& getTextureRect() const { return _rect; }
/**
* Gets the weak reference of the TextureAtlas when the sprite is rendered using via SpriteBatchNode.
*/
TextureAtlas* getTextureAtlas() const { return _textureAtlas; }
/**
* Set ProgramState
*/
virtual void setProgramState(backend::ProgramState *programState) override;
/**
* Get current ProgramState
*/
virtual backend::ProgramState *getProgramState() const override;
/**
* Sets the weak reference of the TextureAtlas when the sprite is rendered using via SpriteBatchNode.
*/
void setTextureAtlas(TextureAtlas *textureAtlas) { _textureAtlas = textureAtlas; }
/**
* Gets the offset position of the sprite. Calculated automatically by editors like Zwoptex.
*/
const Vec2& getOffsetPosition() const { return _offsetPosition; }
/**
* 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);
*
* @return true if the sprite is flipped horizontally, false otherwise.
*/
bool isFlippedX() const;
/**
* Sets whether the sprite should be flipped horizontally or not.
*
* @param flippedX true if the sprite should be flipped horizontally, false otherwise.
*/
virtual void setFlippedX(bool flippedX);
/**
* 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);
*
* @return true if the sprite is flipped vertically, false otherwise.
*/
bool isFlippedY() const;
/**
* Sets whether the sprite should be flipped vertically or not.
*
* @param flippedY true if the sprite should be flipped vertically, false otherwise.
*/
void setFlippedY(bool flippedY);
/// @} End of Sprite properties getter/setters
/**
* returns a reference of the polygon information associated with this sprite
*
* @return a reference of PolygonInfo
*/
const PolygonInfo& getPolygonInfo() const;
/**
* set the sprite to use this new PolygonInfo
*
* @param PolygonInfo the polygon information object
*/
void setPolygonInfo(const PolygonInfo& info);
/** whether or not contentSize stretches the sprite's texture */
void setStretchEnabled(bool enabled);
/** returns whether or not contentSize stretches the sprite's texture */
bool isStretchEnabled() const;
//
// Overrides
//
/// @{
/// @name Functions inherited from TextureProtocol.
/**
*@code
*When this function bound into js or lua,the parameter will be changed.
*In js: var setBlendFunc(var src, var dst).
*In lua: local setBlendFunc(local src, local dst).
*@endcode
*/
void setBlendFunc(const BlendFunc &blendFunc) override { _blendFunc = blendFunc; }
/**
* @js NA
* @lua NA
*/
const BlendFunc& getBlendFunc() const override { return _blendFunc; }
/// @}
int getResourceType() const { return _fileType; }
const std::string& getResourceName() const { return _fileName; }
CC_CONSTRUCTOR_ACCESS :
/**
* @js ctor
*/
Sprite();
virtual ~Sprite();
/* Initializes an empty sprite with no parameters. */
virtual bool init() override;
/**
* 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 PolygonInfo.
*
* After initialization, the rect used will be the size of the texture, and the offset will be (0,0).
*
* @param PolygonInfo a Polygon info contains the structure of the polygon.
* @return True if the sprite is initialized properly, false otherwise.
*/
virtual bool initWithPolygon(const PolygonInfo& info);
/**
* Initializes a sprite with a texture and a rect.
*
* After initialization, the offset will be (0,0).
*
* @param texture A pointer to an existing 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);
/**
* Initializes a sprite with an SpriteFrame. The texture and rect in SpriteFrame will be applied on this sprite.
*
* @param spriteFrame A SpriteFrame object. It should includes a valid texture and a rect.
* @return True if the sprite is initialized properly, false otherwise.
*/
virtual bool initWithSpriteFrame(SpriteFrame *spriteFrame);
/**
* 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.
*
* @param spriteFrameName A key string that can fetched a valid SpriteFrame from SpriteFrameCache.
* @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).
*
* @param filename The path to an image file in local file system.
* @return True if the sprite is initialized properly, false otherwise.
* @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.
* @lua init
*/
virtual bool initWithFile(const std::string& filename, const Rect& rect);
virtual void setVertexLayout();
virtual void updateShaders(const char* vert, const char* frag);
protected:
virtual void updateColor() override;
virtual void setTextureCoords(const Rect& rect);
virtual void setTextureCoords(const Rect& rect, V3F_C4B_T2F_Quad* outQuad);
virtual void setVertexCoords(const Rect& rect, V3F_C4B_T2F_Quad* outQuad);
virtual void updateBlendFunc();
virtual void setReorderChildDirtyRecursively();
virtual void setDirtyRecursively(bool value);
virtual void flipX();
virtual void flipY();
virtual void updateProgramStateTexture();
void updatePoly();
void updateStretchFactor();
void populateTriangle(int quadIndex, const V3F_C4B_T2F_Quad& quad);
void setMVPMatrixUniform();
void setProgramState(backend::ProgramType type);
//
// Data used when the sprite is rendered using a SpriteSheet
//
TextureAtlas* _textureAtlas = nullptr; /// SpriteBatchNode texture atlas (weak reference)
unsigned int _atlasIndex = 0; /// Absolute (real) Index on the SpriteSheet
SpriteBatchNode* _batchNode = nullptr; /// Used batch node (weak reference)
bool _dirty = false; /// Whether the sprite needs to be updated
bool _recursiveDirty = false; /// Whether all of the sprite's children needs to be updated
bool _shouldBeHidden = false; /// should not be drawn because one of the ancestors is not visible
Mat4 _transformToBatch;
//
// Data used when the sprite is self-rendered
//
BlendFunc _blendFunc; /// It's required for TextureProtocol inheritance
Texture2D* _texture = nullptr; /// Texture2D object that is used to render the sprite
SpriteFrame* _spriteFrame = nullptr;
TrianglesCommand _trianglesCommand;
backend::UniformLocation _mvpMatrixLocation;
backend::UniformLocation _textureLocation;
backend::UniformLocation _alphaTextureLocation;
#if CC_SPRITE_DEBUG_DRAW
DrawNode *_debugDrawNode = nullptr;
#endif //CC_SPRITE_DEBUG_DRAW
//
// Shared data
//
// texture
Rect _rect; /// Rectangle of Texture2D
bool _rectRotated = false; /// Whether the texture is rotated
Rect _centerRectNormalized = {0,0,1,1}; /// Rectangle to implement "slice 9"
RenderMode _renderMode = Sprite::RenderMode::QUAD; /// render mode used by the Sprite: Quad, Slice9, Polygon or Quad_Batchnode
Vec2 _stretchFactor = Vec2::ONE; /// stretch factor to match the contentSize. for 1- and 9- slice sprites
Size _originalContentSize = Size::ZERO; /// original content size
// Offset Position (used by Zwoptex)
Vec2 _offsetPosition;
Vec2 _unflippedOffsetPositionFromCenter;
// vertex coords, texture coords and color info
V3F_C4B_T2F_Quad _quad;
V3F_C4B_T2F* _trianglesVertex = nullptr;
unsigned short* _trianglesIndex = nullptr;
PolygonInfo _polyInfo;
// opacity and RGB protocol
bool _opacityModifyRGB = false;
// image is flipped
bool _flippedX = false; /// Whether the sprite is flipped horizontally or not
bool _flippedY = false; /// Whether the sprite is flipped vertically or not
bool _insideBounds = true; /// whether or not the sprite was inside bounds the previous frame
std::string _fileName;
int _fileType = 0;
bool _stretchEnabled = true;
private:
CC_DISALLOW_COPY_AND_ASSIGN(Sprite);
};
// end of sprite_nodes group
/// @}
NS_CC_END