cocos2d-x  3.5
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
SpriteFrame Class Reference

A SpriteFrame has: More...

#include <CCSpriteFrame.h>

Inheritance diagram for SpriteFrame:
Ref Clonable

Public Member Functions

const RectgetRectInPixels () const
 Get rect of the sprite frame. More...
 
void setRectInPixels (const Rect &rectInPixels)
 Set rect of the sprite frame. More...
 
bool isRotated () const
 Is the sprite frame rotated or not. More...
 
void setRotated (bool rotated)
 Set rotated of the sprite frame. More...
 
const RectgetRect () const
 Get rect of the frame. More...
 
void setRect (const Rect &rect)
 Set rect of the frame. More...
 
const Vec2getOffsetInPixels () const
 Get offset of the frame. More...
 
void setOffsetInPixels (const Vec2 &offsetInPixels)
 Set offset of the frame. More...
 
const SizegetOriginalSizeInPixels () const
 Get original size of the trimmed image. More...
 
void setOriginalSizeInPixels (const Size &sizeInPixels)
 Set original size of the trimmed image. More...
 
const SizegetOriginalSize () const
 Get original size of the trimmed image. More...
 
void setOriginalSize (const Size &sizeInPixels)
 Set original size of the trimmed image. More...
 
Texture2DgetTexture ()
 Get texture of the frame. More...
 
void setTexture (Texture2D *pobTexture)
 Set texture of the frame, the texture is retained. More...
 
const Vec2getOffset () const
 Get offset of the frame. More...
 
void setOffset (const Vec2 &offsets)
 Set offset of the frame. More...
 
virtual SpriteFrameclone () const override
 Returns a copy of the Ref. More...
 
virtual ~SpriteFrame ()
bool initWithTexture (Texture2D *pobTexture, const Rect &rect)
 Initializes a SpriteFrame with a texture, rect in points. More...
 
bool initWithTextureFilename (const std::string &filename, const Rect &rect)
 Initializes a SpriteFrame with a texture filename, rect in points; It is assumed that the frame was not trimmed. More...
 
bool initWithTexture (Texture2D *pobTexture, const Rect &rect, bool rotated, const Vec2 &offset, const Size &originalSize)
 Initializes a SpriteFrame with a texture, rect, rotated, offset and originalSize in pixels. More...
 
bool initWithTextureFilename (const std::string &filename, const Rect &rect, bool rotated, const Vec2 &offset, const Size &originalSize)
 Initializes a SpriteFrame with a texture, rect, rotated, offset and originalSize in pixels. 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...
 
- Public Member Functions inherited from Clonable
virtual ~Clonable ()
Refcopy () const
 Returns a copy of the Ref. More...
 

Static Public Member Functions

static SpriteFramecreate (const std::string &filename, const Rect &rect)
 Create a SpriteFrame with a texture filename, rect in points. More...
 
static SpriteFramecreate (const std::string &filename, const Rect &rect, bool rotated, const Vec2 &offset, const Size &originalSize)
 Create a SpriteFrame with a texture filename, rect, rotated, offset and originalSize in pixels. More...
 
static SpriteFramecreateWithTexture (Texture2D *pobTexture, const Rect &rect)
 Create a SpriteFrame with a texture, rect in points. More...
 
static SpriteFramecreateWithTexture (Texture2D *pobTexture, const Rect &rect, bool rotated, const Vec2 &offset, const Size &originalSize)
 Create a SpriteFrame with a texture, rect, rotated, offset and originalSize in pixels. More...
 

Public Attributes

CC_CONSTRUCTOR_ACCESS __pad0__: SpriteFrame()

Protected Attributes

Vec2 _offset
Size _originalSize
Rect _rectInPixels
bool _rotated
Rect _rect
Vec2 _offsetInPixels
Size _originalSizeInPixels
Texture2D_texture
std::string _textureFilename
- Protected Attributes inherited from Ref
unsigned int _referenceCount
 count of references More...
 

Additional Inherited Members

- Protected Member Functions inherited from Ref
 Ref ()
 Constructor. More...
 

Detailed Description

A SpriteFrame has:

  • texture: A Texture2D that will be used by the Sprite
  • rectangle: A rectangle of the texture

You can modify the frame of a Sprite by doing:

SpriteFrame *frame = SpriteFrame::frameWithTexture(texture, rect, offset); sprite->setDisplayFrame(frame);

Constructor & Destructor Documentation

virtual ~SpriteFrame ( )
virtual

Member Function Documentation

virtual SpriteFrame* clone ( ) const
overridevirtual

Returns a copy of the Ref.

Implements Clonable.

static SpriteFrame* create ( const std::string &  filename,
const Rect rect 
)
static

Create a SpriteFrame with a texture filename, rect in points.

It is assumed that the frame was not trimmed.

Parameters
filenameTexture file name.
rectA specified rect.
Returns
An autoreleased SpriteFrame object.
static SpriteFrame* create ( const std::string &  filename,
const Rect rect,
bool  rotated,
const Vec2 offset,
const Size originalSize 
)
static

Create a SpriteFrame with a texture filename, rect, rotated, offset and originalSize in pixels.

The originalSize is the size in pixels of the frame before being trimmed.

Parameters
filenameTexture filename
rectA specified rect.
rotatedIs rotated if true.
offsetA specified offset.
originalSizeA specified original size.
Returns
An autoreleased SpriteFrame object.
static SpriteFrame*
createWithTexture
( Texture2D pobTexture,
const Rect rect 
)
static

Create a SpriteFrame with a texture, rect in points.

It is assumed that the frame was not trimmed.

Parameters
pobTextureThe texture pointer.
rectA specified rect.
Returns
An autoreleased SpriteFrame object.
static SpriteFrame*
createWithTexture
( Texture2D pobTexture,
const Rect rect,
bool  rotated,
const Vec2 offset,
const Size originalSize 
)
static

Create a SpriteFrame with a texture, rect, rotated, offset and originalSize in pixels.

The originalSize is the size in points of the frame before being trimmed.

Parameters
pobTextureThe texture pointer.
rectA specified rect.
rotatedIs rotated if true.
offsetA specified offset.
originalSizeA specified original size.
Returns
An autoreleased SpriteFrame object.
const Vec2& getOffset ( ) const

Get offset of the frame.

Returns
The offset of the sprite frame.
const Vec2& getOffsetInPixels ( ) const

Get offset of the frame.

Returns
The offset of the sprite frame, in pixels.
const Size& getOriginalSize ( ) const
inline

Get original size of the trimmed image.

Returns
The original size of the trimmed image.
const Size& getOriginalSizeInPixels ( ) const
inline

Get original size of the trimmed image.

Returns
The original size of the trimmed image, in pixels.
const Rect& getRect ( ) const
inline

Get rect of the frame.

Returns
The rect of the sprite frame.
const Rect& getRectInPixels ( ) const
inline

Get rect of the sprite frame.

Returns
The rect of the sprite frame, in pixels.
Texture2D* getTexture ( )

Get texture of the frame.

Returns
The texture of the sprite frame.
bool initWithTexture ( Texture2D pobTexture,
const Rect rect 
)

Initializes a SpriteFrame with a texture, rect in points.

It is assumed that the frame was not trimmed.

bool initWithTexture ( Texture2D pobTexture,
const Rect rect,
bool  rotated,
const Vec2 offset,
const Size originalSize 
)

Initializes a SpriteFrame with a texture, rect, rotated, offset and originalSize in pixels.

The originalSize is the size in points of the frame before being trimmed.

bool initWithTextureFilename ( const std::string &  filename,
const Rect rect 
)

Initializes a SpriteFrame with a texture filename, rect in points; It is assumed that the frame was not trimmed.

bool initWithTextureFilename ( const std::string &  filename,
const Rect rect,
bool  rotated,
const Vec2 offset,
const Size originalSize 
)

Initializes a SpriteFrame with a texture, rect, rotated, offset and originalSize in pixels.

The originalSize is the size in pixels of the frame before being trimmed.

Since
v1.1
bool isRotated ( ) const
inline

Is the sprite frame rotated or not.

Returns
Is rotated if true.
void setOffset ( const Vec2 offsets)

Set offset of the frame.

Parameters
offsetsThe offset of the sprite frame.
void setOffsetInPixels ( const Vec2 offsetInPixels)

Set offset of the frame.

Parameters
offsetInPixelsThe offset of the sprite frame, in pixels.
void setOriginalSize ( const Size sizeInPixels)
inline

Set original size of the trimmed image.

Parameters
sizeInPixelsThe original size of the trimmed image.
void setOriginalSizeInPixels ( const Size sizeInPixels)
inline

Set original size of the trimmed image.

Parameters
sizeInPixelsThe original size of the trimmed image, in pixels.
void setRect ( const Rect rect)

Set rect of the frame.

Parameters
Therect of the sprite.
void setRectInPixels ( const Rect rectInPixels)

Set rect of the sprite frame.

Parameters
rectInPixelsThe rect of the sprite frame, in pixels.
void setRotated ( bool  rotated)
inline

Set rotated of the sprite frame.

Parameters
rotatedRotated the sprite frame if true.
void setTexture ( Texture2D pobTexture)

Set texture of the frame, the texture is retained.

Parameters
pobTextureThe texture of the sprite frame.

Member Data Documentation

Vec2 _offset
protected
Vec2 _offsetInPixels
protected
Size _originalSize
protected
Size _originalSizeInPixels
protected
Rect _rect
protected
Rect _rectInPixels
protected
bool _rotated
protected
Texture2D* _texture
protected
std::string _textureFilename
protected

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