A SpriteFrame has: More...

Inherits Ref, and Clonable.

Public Member Functions
const Rect &	getRectInPixels () const
	Get rect of the sprite frame. More...

var	getRectInPixels ()
	Get rect of the sprite frame. More...

local	getRectInPixels ()
	Get rect of the sprite frame. More...

void	setRectInPixels (const Rect &rectInPixels)
	Set rect of the sprite frame. More...

var	setRectInPixels ( var rectInPixels)
	Set rect of the sprite frame. More...

local	setRectInPixels ( local rectInPixels)
	Set rect of the sprite frame. More...

bool	isRotated () const
	Is the sprite frame rotated or not. More...

var	isRotated ()
	Is the sprite frame rotated or not. More...

local	isRotated ()
	Is the sprite frame rotated or not. More...

void	setRotated (bool rotated)
	Set rotated of the sprite frame. More...

var	setRotated ( var rotated)
	Set rotated of the sprite frame. More...

local	setRotated ( local rotated)
	Set rotated of the sprite frame. More...

const Rect &	getRect () const
	Get rect of the frame. More...

var	getRect ()
	Get rect of the frame. More...

local	getRect ()
	Get rect of the frame. More...

void	setRect (const Rect &rect)
	Set rect of the frame. More...

var	setRect ( var rect)
	Set rect of the frame. More...

local	setRect ( local rect)
	Set rect of the frame. More...

const Vec2 &	getOffsetInPixels () const
	Get offset of the frame. More...

var	getOffsetInPixels ()
	Get offset of the frame. More...

local	getOffsetInPixels ()
	Get offset of the frame. More...

void	setOffsetInPixels (const Vec2 &offsetInPixels)
	Set offset of the frame. More...

var	setOffsetInPixels ( var offsetInPixels)
	Set offset of the frame. More...

local	setOffsetInPixels ( local offsetInPixels)
	Set offset of the frame. More...

const Size &	getOriginalSizeInPixels () const
	Get original size of the trimmed image. More...

var	getOriginalSizeInPixels ()
	Get original size of the trimmed image. More...

local	getOriginalSizeInPixels ()
	Get original size of the trimmed image. More...

void	setOriginalSizeInPixels (const Size &sizeInPixels)
	Set original size of the trimmed image. More...

var	setOriginalSizeInPixels ( var sizeInPixels)
	Set original size of the trimmed image. More...

local	setOriginalSizeInPixels ( local sizeInPixels)
	Set original size of the trimmed image. More...

const Size &	getOriginalSize () const
	Get original size of the trimmed image. More...

var	getOriginalSize ()
	Get original size of the trimmed image. More...

local	getOriginalSize ()
	Get original size of the trimmed image. More...

void	setOriginalSize (const Size &sizeInPixels)
	Set original size of the trimmed image. More...

var	setOriginalSize ( var sizeInPixels)
	Set original size of the trimmed image. More...

local	setOriginalSize ( local sizeInPixels)
	Set original size of the trimmed image. More...

Texture2D *	getTexture ()
	Get texture of the frame. More...

var	getTexture ()
	Get texture of the frame. More...

local	getTexture ()
	Get texture of the frame. More...

void	setTexture (Texture2D *pobTexture)
	Set texture of the frame, the texture is retained. More...

var	setTexture ( var pobTexture)
	Set texture of the frame, the texture is retained. More...

local	setTexture ( local pobTexture)
	Set texture of the frame, the texture is retained. More...

const Vec2 &	getOffset () const
	Get offset of the frame. More...

var	getOffset ()
	Get offset of the frame. More...

local	getOffset ()
	Get offset of the frame. More...

void	setOffset (const Vec2 &offsets)
	Set offset of the frame. More...

var	setOffset ( var offsets)
	Set offset of the frame. More...

local	setOffset ( local offsets)
	Set offset of the frame. More...

const Vec2 &	getAnchorPoint () const
	Get anchor point of the frame. More...

var	getAnchorPoint ()
	Get anchor point of the frame. More...

local	getAnchorPoint ()
	Get anchor point of the frame. More...

void	setAnchorPoint (const Vec2 &anchorPoint)
	Set anchor point of the frame. More...

var	setAnchorPoint ( var anchorPoint)
	Set anchor point of the frame. More...

local	setAnchorPoint ( local anchorPoint)
	Set anchor point of the frame. More...

bool	hasAnchorPoint () const
	Check if anchor point is defined for the frame. More...

var	hasAnchorPoint ()
	Check if anchor point is defined for the frame. More...

local	hasAnchorPoint ()
	Check if anchor point is defined for the frame. More...

virtual SpriteFrame *	clone () const override
	Returns a copy of the Ref.

var	clone ()
	Returns a copy of the Ref.

local	clone ()
	Returns a copy of the Ref.

void	setPolygonInfo (const PolygonInfo &polygonInfo)
	Set the polygon info for polygon mesh sprites. More...

var	setPolygonInfo ( var polygonInfo)
	Set the polygon info for polygon mesh sprites. More...

local	setPolygonInfo ( local polygonInfo)
	Set the polygon info for polygon mesh sprites. More...

const PolygonInfo &	getPolygonInfo () const
	Get the polygonInfo for this sprite. More...

local	getPolygonInfo ()
	Get the polygonInfo for this sprite. More...

bool	hasPolygonInfo () const
	Check if sprite frame is a polygon sprite. More...

var	hasPolygonInfo ()
	Check if sprite frame is a polygon sprite. More...

local	hasPolygonInfo ()
	Check if sprite frame is a polygon sprite. More...

Public Member Functions inherited from Ref
void	retain ()
	Retains the ownership. More...

local	retain ()
	Retains the ownership. More...

void	release ()
	Releases the ownership immediately. More...

Ref *	autorelease ()
	Releases the ownership sometime soon automatically. More...

unsigned int	getReferenceCount () const
	Returns the Ref's current reference count. More...

local	getReferenceCount ()
	Returns the Ref's current reference count. More...

virtual	~Ref ()
	Destructor.

Public Member Functions inherited from Clonable
Ref *	copy () const
	Returns a copy of the Ref.

Static Public Member Functions
static SpriteFrame *	create (const std::string &filename, const Rect &rect)
	Create a SpriteFrame with a texture filename, rect in points. More...

var	create ( var filename, var rect)
	Create a SpriteFrame with a texture filename, rect in points. More...

local	create ( local filename, local rect)
	Create a SpriteFrame with a texture filename, rect in points. More...

static SpriteFrame *	create (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...

local	create ( local filename, local rect, local rotated, local offset, local originalSize)
	Create a SpriteFrame with a texture filename, rect, rotated, offset and originalSize in pixels. More...

static SpriteFrame *	createWithTexture (Texture2D *pobTexture, const Rect &rect)
	Create a SpriteFrame with a texture, rect in points. More...

static SpriteFrame *	createWithTexture (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...

var	createWithTexture ( var pobTexture, var rect, var rotated, var offset, var originalSize)
	Create a SpriteFrame with a texture, rect, rotated, offset and originalSize in pixels. More...

local	createWithTexture ( local pobTexture, local rect, local rotated, local offset, local originalSize)
	Create a SpriteFrame with a texture, rect, rotated, offset and originalSize in pixels. More...

Protected Member Functions
bool	initWithTexture (Texture2D *pobTexture, const Rect &rect)
	Initializes a SpriteFrame with a texture, rect in points. More...

var	initWithTexture ( var pobTexture, var rect)
	Initializes a SpriteFrame with a texture, rect in points. More...

local	initWithTexture ( local pobTexture, local 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.

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...

var	initWithTexture ( var pobTexture, var rect, var rotated, var offset, var originalSize)
	Initializes a SpriteFrame with a texture, rect, rotated, offset and originalSize in pixels. More...

local	initWithTexture ( local pobTexture, local rect, local rotated, local offset, local 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...

Additional Inherited Members
Public Attributes inherited from Ref
unsigned int	_ID
	object id, ScriptSupport need public _ID

local	_ID
	object id, ScriptSupport need public _ID

int	_luaID
	Lua reference id.

local	_luaID
	Lua reference id.

void *	_scriptObject
	scriptObject, support for swift

local	_scriptObject
	scriptObject, support for swift

bool	_rooted
	When true, it means that the object was already rooted.

local	_rooted
	When true, it means that the object was already rooted.

bool	_scriptOwned
	The life of the object is scrolled by the scripting engine. More...

local	_scriptOwned
	The life of the object is scrolled by the scripting engine. 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::createWithTexture(texture, rect);

sprite->setSpriteFrame(frame);

Member Function Documentation

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.

Texture file name. A specified rect. An autoreleased SpriteFrame object.

var create	(	var	filename,
		var	rect
	)

static

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

It is assumed that the frame was not trimmed.

Texture file name. A specified rect. An autoreleased SpriteFrame object.

local create	(	local	filename,
		local	rect
	)

static

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

It is assumed that the frame was not trimmed.

Texture file name. A specified rect. 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.

Texture filename A specified rect. Is rotated if true. A specified offset. A specified original size. An autoreleased SpriteFrame object.

var create	(	var	filename,
		var	rect,
		var	rotated,
		var	offset,
		var	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.

Texture filename A specified rect. Is rotated if true. A specified offset. A specified original size. An autoreleased SpriteFrame object.

local create	(	local	filename,
		local	rect,
		local	rotated,
		local	offset,
		local	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.

Texture filename A specified rect. Is rotated if true. A specified offset. A specified original size. 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. The texture pointer. A specified rect. An autoreleased SpriteFrame object.

var createWithTexture	(	var	pobTexture,
		var	rect
	)

static

Create a SpriteFrame with a texture, rect in points.

It is assumed that the frame was not trimmed. The texture pointer. A specified rect. An autoreleased SpriteFrame object.

local createWithTexture	(	local	pobTexture,
		local	rect
	)

static

Create a SpriteFrame with a texture, rect in points.

It is assumed that the frame was not trimmed. The texture pointer. A specified rect. 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. The texture pointer. A specified rect. Is rotated if true. A specified offset. A specified original size. An autoreleased SpriteFrame object.

var createWithTexture	(	var	pobTexture,
		var	rect,
		var	rotated,
		var	offset,
		var	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. The texture pointer. A specified rect. Is rotated if true. A specified offset. A specified original size. An autoreleased SpriteFrame object.

local createWithTexture	(	local	pobTexture,
		local	rect,
		local	rotated,
		local	offset,
		local	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. The texture pointer. A specified rect. Is rotated if true. A specified offset. A specified original size. An autoreleased SpriteFrame object.

const Rect& getRectInPixels ( ) const

inline

Get rect of the sprite frame.

The rect of the sprite frame, in pixels.

var getRectInPixels ( )

inline

Get rect of the sprite frame.

The rect of the sprite frame, in pixels.

local getRectInPixels ( )

inline

Get rect of the sprite frame.

The rect of the sprite frame, in pixels.

void setRectInPixels ( const Rect & rectInPixels )

Set rect of the sprite frame.

The rect of the sprite frame, in pixels.

var setRectInPixels ( var rectInPixels )

Set rect of the sprite frame.

The rect of the sprite frame, in pixels.

local setRectInPixels ( local rectInPixels )

Set rect of the sprite frame.

The rect of the sprite frame, in pixels.

bool isRotated ( ) const

inline

Is the sprite frame rotated or not.

Is rotated if true.

var isRotated ( )

inline

Is the sprite frame rotated or not.

Is rotated if true.

local isRotated ( )

inline

Is the sprite frame rotated or not.

Is rotated if true.

void setRotated ( bool rotated )

inline

Set rotated of the sprite frame.

Rotated the sprite frame if true.

var setRotated ( var rotated )

inline

Set rotated of the sprite frame.

Rotated the sprite frame if true.

local setRotated ( local rotated )

inline

Set rotated of the sprite frame.

Rotated the sprite frame if true.

const Rect& getRect ( ) const

inline

Get rect of the frame.

The rect of the sprite frame.

var getRect ( )

inline

Get rect of the frame.

The rect of the sprite frame.

local getRect ( )

inline

Get rect of the frame.

The rect of the sprite frame.

void setRect ( const Rect & rect )

Set rect of the frame.

The rect of the sprite.

var setRect ( var rect )

Set rect of the frame.

The rect of the sprite.

local setRect ( local rect )

Set rect of the frame.

The rect of the sprite.

const Vec2& getOffsetInPixels ( ) const

Get offset of the frame.