SpriteFrame Class Reference

A SpriteFrame has: More...

#include <SpriteFrame.h>

Inherits Object, and Clonable.

Public Member Functions
const Rect &	getRectInPixels () const
	Get rect of the sprite frame.
void	setRectInPixels (const Rect &rectInPixels)
	Set rect of the sprite frame.
bool	isRotated () const
	Is the sprite frame rotated or not.
void	setRotated (bool rotated)
	Set rotated of the sprite frame.
const Rect &	getRect () const
	Get rect of the frame.
void	setRect (const Rect &rect)
	Set rect of the frame.
const Rect &	getCenterRect () const
	Get center rect of the frame.
void	setCenterRectInPixels (const Rect &centerRect)
	setCenterRect
bool	hasCenterRect () const
	hasCenterRect
const Vec2 &	getOffsetInPixels () const
	Get offset of the frame.
void	setOffsetInPixels (const Vec2 &offsetInPixels)
	Set offset of the frame.
const Vec2 &	getOriginalSizeInPixels () const
	Get original size of the trimmed image.
void	setOriginalSizeInPixels (const Vec2 &sizeInPixels)
	Set original size of the trimmed image.
const Vec2 &	getOriginalSize () const
	Get original size of the trimmed image.
void	setOriginalSize (const Vec2 &sizeInPixels)
	Set original size of the trimmed image.
Texture2D *	getTexture ()
	Get texture of the frame.
void	setTexture (Texture2D *pobTexture)
	Set texture of the frame, the texture is retained.
const Vec2 &	getOffset () const
	Get offset of the frame.
void	setOffset (const Vec2 &offsets)
	Set offset of the frame.
const Vec2 &	getAnchorPoint () const
	Get anchor point of the frame.
void	setAnchorPoint (const Vec2 &anchorPoint)
	Set anchor point of the frame.
bool	hasAnchorPoint () const
	Check if anchor point is defined for the frame.
virtual SpriteFrame *	clone () const override
	Returns a copy of the Object.
void	setPolygonInfo (const PolygonInfo &polygonInfo)
	Set the polygon info for polygon mesh sprites.
const PolygonInfo &	getPolygonInfo () const
	Get the polygonInfo for this sprite.
bool	hasPolygonInfo () const
	Check if sprite frame is a polygon sprite.
	SpriteFrame ()
	@lua NA
virtual	~SpriteFrame ()
	@lua NA
bool	initWithTexture (Texture2D *pobTexture, const Rect &rect)
	Initializes a SpriteFrame with a texture, rect in points.
bool	initWithTextureFilename (std::string_view filename, const Rect &rect)
	Initializes a SpriteFrame with a texture filename, 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 Vec2 &originalSize)
	Initializes a SpriteFrame with a texture, rect, rotated, offset and originalSize in pixels.
bool	initWithTextureFilename (std::string_view filename, const Rect &rect, bool rotated, const Vec2 &offset, const Vec2 &originalSize)
	Initializes a SpriteFrame with a texture, rect, rotated, offset and originalSize in pixels.
Public Member Functions inherited from Object
void	retain ()
	Retains the ownership.
void	release ()
	Releases the ownership immediately.
Object *	autorelease ()
	Releases the ownership sometime soon automatically.
unsigned int	getReferenceCount () const
	Returns the Object's current reference count.
virtual	~Object ()
	Destructor.
Public Member Functions inherited from Clonable
virtual	~Clonable ()
	@js NA @lua NA

Static Public Member Functions
static SpriteFrame *	create (std::string_view filename, const Rect &rect)
	Create a SpriteFrame with a texture filename, rect in points.
static SpriteFrame *	create (std::string_view filename, const Rect &rect, bool rotated, const Vec2 &offset, const Vec2 &originalSize)
	Create a SpriteFrame with a texture filename, rect, rotated, offset and originalSize in pixels.
static SpriteFrame *	createWithTexture (Texture2D *pobTexture, const Rect &rect)
	Create a SpriteFrame with a texture, rect in points.
static SpriteFrame *	createWithTexture (Texture2D *pobTexture, const Rect &rect, bool rotated, const Vec2 &offset, const Vec2 &originalSize)
	Create a SpriteFrame with a texture, rect, rotated, offset and originalSize in pixels.

Additional Inherited Members
Public Attributes inherited from Object
unsigned int	_ID
	object id, ScriptSupport need public _ID
int	_luaID
	Lua reference id.

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::createWithTexture(texture, rect);
sprite->setSpriteFrame(frame);

Member Function Documentation

create() [1/2]

static SpriteFrame * create ( std::string_view 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

filename	Texture file name.
rect	A specified rect.

Returns

An autoreleased SpriteFrame object.

create() [2/2]

static SpriteFrame * create ( std::string_view filename, const Rect & rect, bool rotated, const Vec2 & offset, const Vec2 & 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

filename	Texture filename
rect	A specified rect.
rotated	Is rotated if true.
offset	A specified offset.
originalSize	A specified original size.

Returns

An autoreleased SpriteFrame object.

createWithTexture() [1/2]

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

pobTexture	The texture pointer.
rect	A specified rect.

Returns

An autoreleased SpriteFrame object.

createWithTexture() [2/2]

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

pobTexture	The texture pointer.
rect	A specified rect.
rotated	Is rotated if true.
offset	A specified offset.
originalSize	A specified original size.

Returns

An autoreleased SpriteFrame object.

getRectInPixels()

const Rect & getRectInPixels ( ) const

inline

Get rect of the sprite frame.

Returns

The rect of the sprite frame, in pixels.

setRectInPixels()

void setRectInPixels

(

const Rect &

rectInPixels

)

Set rect of the sprite frame.

Parameters

rectInPixels

The rect of the sprite frame, in pixels.

isRotated()

bool isRotated ( ) const

inline

Is the sprite frame rotated or not.

Returns

Is rotated if true.

setRotated()

void setRotated ( bool rotated )

inline

Set rotated of the sprite frame.

Parameters

rotated

Rotated the sprite frame if true.

getRect()

const Rect & getRect ( ) const

inline

Get rect of the frame.

Returns

The rect of the sprite frame.

setRect()

void setRect

(

const Rect &

rect

)

Set rect of the frame.

Parameters

rect	The rect of the sprite.

getCenterRect()

const Rect & getCenterRect ( ) const

inline

Get center rect of the frame.

Useful to create 9-slice sprites

Returns

The center rect of the sprite frame in points

setCenterRectInPixels()

void setCenterRectInPixels

(

const Rect &

centerRect

)

setCenterRect

Useful to implement "9 sliced" sprites. 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.

Parameters

centerRect

the Rect in points

hasCenterRect()

bool hasCenterRect

(

)

const

hasCenterRect

Returns

Whether or not it has a centerRect

getOffsetInPixels()

const Vec2 & getOffsetInPixels

(

)

const

Get offset of the frame.

Returns

The offset of the sprite frame, in pixels.

setOffsetInPixels()

void setOffsetInPixels

(

const Vec2 &

offsetInPixels

)

Set offset of the frame.

Parameters

offsetInPixels

The offset of the sprite frame, in pixels.

getOriginalSizeInPixels()

const Vec2 & getOriginalSizeInPixels ( ) const

inline

Get original size of the trimmed image.

Returns

The original size of the trimmed image, in pixels.

setOriginalSizeInPixels()

void setOriginalSizeInPixels ( const Vec2 & sizeInPixels )

inline

Set original size of the trimmed image.

Parameters

sizeInPixels

The original size of the trimmed image, in pixels.

getOriginalSize()

const Vec2 & getOriginalSize ( ) const

inline

Get original size of the trimmed image.

Returns

The original size of the trimmed image.

setOriginalSize()

void setOriginalSize ( const Vec2 & sizeInPixels )

inline

Set original size of the trimmed image.

Parameters

sizeInPixels

The original size of the trimmed image.

getTexture()

Texture2D * getTexture

(

)

Get texture of the frame.

Returns

The texture of the sprite frame.

setTexture()

void setTexture

(

Texture2D *

pobTexture

)

Set texture of the frame, the texture is retained.

Parameters

pobTexture

The texture of the sprite frame.

getOffset()

const Vec2 & getOffset

(

)

const

Get offset of the frame.

Returns

The offset of the sprite frame.

setOffset()

void setOffset

(

const Vec2 &

offsets

)

Set offset of the frame.

Parameters

offsets

The offset of the sprite frame.

getAnchorPoint()

const Vec2 & getAnchorPoint

(

)

const

Get anchor point of the frame.

Returns

The anchor point of the sprite frame.

setAnchorPoint()

void setAnchorPoint

(

const Vec2 &

anchorPoint

)

Set anchor point of the frame.

Parameters

anchorPoint

The anchor point of the sprite frame.

hasAnchorPoint()

bool hasAnchorPoint

(

)

const

Check if anchor point is defined for the frame.

Returns

true if anchor point is available.

setPolygonInfo()

void setPolygonInfo

(

const PolygonInfo &

polygonInfo

)

Set the polygon info for polygon mesh sprites.

Parameters

polygonInfo

triangle mesh of the sprite

getPolygonInfo()

const PolygonInfo & getPolygonInfo

(

)

const

Get the polygonInfo for this sprite.

Returns

a reference to the polygonInfo structure

hasPolygonInfo()

bool hasPolygonInfo

(

)

const

Check if sprite frame is a polygon sprite.

Returns

true if polygonInfo is available

initWithTexture() [1/2]

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.

initWithTexture() [2/2]

bool initWithTexture	(	Texture2D *	pobTexture,
		const Rect &	rect,
		bool	rotated,
		const Vec2 &	offset,
		const Vec2 &	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.

initWithTextureFilename()

bool initWithTextureFilename	(	std::string_view	filename,
		const Rect &	rect,
		bool	rotated,
		const Vec2 &	offset,
		const Vec2 &	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

---

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

• SpriteFrame.h