cocos2d-x  3.0
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

virtual ~SpriteFrame (void)
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 Point &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 Point &offset, const Size &originalSize)
 Initializes a SpriteFrame with a texture, rect, rotated, offset and originalSize in pixels. More...
 
const RectgetRectInPixels () const
void setRectInPixels (const Rect &rectInPixels)
bool isRotated (void) const
void setRotated (bool rotated)
const RectgetRect (void) const
 get rect of the frame More...
 
void setRect (const Rect &rect)
 set rect of the frame More...
 
const PointgetOffsetInPixels (void) const
 get offset of the frame More...
 
void setOffsetInPixels (const Point &offsetInPixels)
 set offset of the frame More...
 
const SizegetOriginalSizeInPixels (void) const
 get original size of the trimmed image More...
 
void setOriginalSizeInPixels (const Size &sizeInPixels)
 set original size of the trimmed image More...
 
const SizegetOriginalSize (void) const
 get original size of the trimmed image More...
 
void setOriginalSize (const Size &sizeInPixels)
 set original size of the trimmed image More...
 
Texture2DgetTexture (void)
 get texture of the frame More...
 
void setTexture (Texture2D *pobTexture)
 set texture of the frame, the texture is retained More...
 
const PointgetOffset (void) const
void setOffset (const Point &offsets)
virtual SpriteFrameclone () const override
 returns a copy of the Ref More...
 
- Public Member Functions inherited from Ref
void retain ()
 Retains the ownership. More...
 
void release ()
 Release the ownership immediately. More...
 
Refautorelease ()
 Release the ownership sometime soon automatically. More...
 
unsigned int getReferenceCount () const
 Returns the Ref's current reference count. More...
 
virtual ~Ref ()
- 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 Point &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 Point &offset, const Size &originalSize)
 Create a SpriteFrame with a texture, rect, rotated, offset and originalSize in pixels. More...
 

Protected Attributes

Point _offset
Size _originalSize
Rect _rectInPixels
bool _rotated
Rect _rect
Point _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 ( void  )
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.

static SpriteFrame* create ( const std::string &  filename,
const Rect rect,
bool  rotated,
const Point 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.

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.

static SpriteFrame*
createWithTexture
( Texture2D pobTexture,
const Rect rect,
bool  rotated,
const Point 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.

const Point& getOffset ( void  ) const
const Point& getOffsetInPixels ( void  ) const

get offset of the frame

const Size& getOriginalSize ( void  ) const
inline

get original size of the trimmed image

const Size& getOriginalSizeInPixels ( void  ) const
inline

get original size of the trimmed image

const Rect& getRect ( void  ) const
inline

get rect of the frame

const Rect& getRectInPixels ( ) const
inline
Texture2D* getTexture ( void  )

get texture of the 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 Point 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 Point 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 ( void  ) const
inline
void setOffset ( const Point offsets)
void setOffsetInPixels ( const Point offsetInPixels)

set offset of the frame

void setOriginalSize ( const Size sizeInPixels)
inline

set original size of the trimmed image

void setOriginalSizeInPixels ( const Size sizeInPixels)
inline

set original size of the trimmed image

void setRect ( const Rect rect)

set rect of the frame

void setRectInPixels ( const Rect rectInPixels)
void setRotated ( bool  rotated)
inline
void setTexture ( Texture2D pobTexture)

set texture of the frame, the texture is retained

Member Data Documentation

Point _offset
protected
Point _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: