meteor::MSpriteSheet Class Reference

This class holds the Rects within a texture that form an Animation. More...

#include <spritesheet.h>

Inheritance diagram for meteor::MSpriteSheet:

Public Member Functions
	MSpriteSheet (std::string texturePath, std::vector< SRect > rects)
	Constructor.
MTexture *	getTexture ()
	Gets the Texture for this sprite-sheet.
SRect	sample (int &index, bool loop)
	Sample the sprite-sheet for a animation frame rect.
Public Member Functions inherited from meteor::MEntity
virtual bool	equals (MEntity *other)
	Checks equality between two entities.
std::string	getName ()
void	setName (std::string name)
	Sets name of entity.
virtual std::string	toString ()
	Get this object as a string.

Additional Inherited Members
Protected Attributes inherited from meteor::MEntity
std::string	name

Detailed Description

This class holds the Rects within a texture that form an Animation.

Constructor & Destructor Documentation

MSpriteSheet()

meteor::MSpriteSheet::MSpriteSheet	(	std::string	texturePath,
		std::vector< SRect >	rects )

Constructor.

Parameters

texturePath	Path to texture.
rects	List of rects that form the animation.

Member Function Documentation

getTexture()

MTexture * meteor::MSpriteSheet::getTexture

(

)

Gets the Texture for this sprite-sheet.

Returns

Ptr to Texture instance

sample()

SRect meteor::MSpriteSheet::sample	(	int &	index,
		bool	loop )

Sample the sprite-sheet for a animation frame rect.

Parameters

index	integer directly mapping to frame number.
loop	boolean flag to loop over the frames.

Returns

Rect for a specific animation frame.