NasNas
An intuitive and beginner friendly 2D game framework for C++
Public Member Functions | List of all members
ns::SpriteSheet Class Reference

Public Member Functions

 SpriteSheet (const sf::Texture &texture)
 
 SpriteSheet (const sf::Texture &texture, const std::vector< Anim *> &anims)
 Constructs a Spritesheet object. More...
 
 ~SpriteSheet ()
 Delete all the Anim objects of this Spritesheet.
 
void setTexture (const sf::Texture &texture)
 
auto getTexture () const -> const sf::Texture *
 
void setGrid (const sf::Vector2i &cell_size, int columns_nb, int margin=0, int spacing=0)
 
void addAnim (Anim *new_anim)
 
void addAnim (const std::string &anim_name, unsigned int first_frame, unsigned int nb_of_frames, int duration, const sf::Vector2i &origin={0, 0})
 
void addAnim (const std::string &anim_name, unsigned int first_frame, unsigned int nb_of_frames, int duration, const std::vector< sf::Vector2i > &origins)
 
void addAnim (const std::string &anim_name, unsigned int first_frame, unsigned int nb_of_frames, const std::vector< int > &durations, const sf::Vector2i &origin={0, 0})
 
void addAnim (const std::string &anim_name, unsigned int first_frame, unsigned int nb_of_frames, const std::vector< int > &durations, const std::vector< sf::Vector2i > &origins)
 
void addAnim (const std::string &anim_name, const std::vector< unsigned int > &frames, int duration, const sf::Vector2i &origin={0, 0})
 
void addAnim (const std::string &anim_name, const std::vector< unsigned int > &frames, int duration, const std::vector< sf::Vector2i > &origins)
 
void addAnim (const std::string &anim_name, const std::vector< unsigned int > &frames, const std::vector< int > &durations, const sf::Vector2i &origin={0, 0})
 
void addAnim (const std::string &anim_name, const std::vector< unsigned int > &frames, const std::vector< int > &durations, const std::vector< sf::Vector2i > &origins)
 
auto getAnimsMap () -> const std::unordered_map< std::string, Anim *> &
 Get a map containing all the Anim objects. More...
 
auto getAnim (const std::string &anim_name) -> const Anim &
 Get an Anim by its name. More...
 

Detailed Description

Definition at line 19 of file SpriteSheet.hpp.

Constructor & Destructor Documentation

◆ SpriteSheet()

ns::SpriteSheet::SpriteSheet ( const sf::Texture &  texture,
const std::vector< Anim *> &  anims 
)

Constructs a Spritesheet object.

Parameters
nameSpritesheet name
textureSpritesheet texture
animsSpritesheet animations, vector of pointers to Anim objects

Member Function Documentation

◆ getAnim()

auto ns::SpriteSheet::getAnim ( const std::string &  anim_name) -> const Anim &

Get an Anim by its name.

Parameters
anim_nameAnim name
Returns
The Anim

◆ getAnimsMap()

auto ns::SpriteSheet::getAnimsMap ( ) -> const std::unordered_map< std::string, Anim *> &

Get a map containing all the Anim objects.

Returns
Unordered map of <Anim name, pointer to Anim>

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