SpriteSheet.hpp

/******************************************************************************
 
  nomlib - C++11 cross-platform game engine
 
Copyright (c) 2013, 2014 Jeffrey Carpenter <i8degrees@gmail.com>
All rights reserved.
 
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
 
1. Redistributions of source code must retain the above copyright notice, this
   list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice,
   this list of conditions and the following disclaimer in the documentation
   and/or other materials provided with the distribution.
 
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
******************************************************************************/
#ifndef NOMLIB_GRAPHICS_SPRITE_SPRITE_SHEET_HPP
#define NOMLIB_GRAPHICS_SPRITE_SPRITE_SHEET_HPP
 
#include <string>
#include <map>
#include <memory>
 
#include "nomlib/config.hpp"
#include "nomlib/version.hpp"
#include "nomlib/math/Rect.hpp"
#include "nomlib/ptree.hpp"
 
// #define NOM_DEBUG_SPRITE_SHEET_JSON_LOAD
 
namespace nom {

class SpriteSheet
{
  public:
    static const VersionInfo VERSION;
 
    typedef SpriteSheet self_type;

    SpriteSheet();

    ~SpriteSheet();

    SpriteSheet* clone() const;

    const IntRect& dimensions(int index) const;

    int frames() const;

    bool empty() const;

    std::string version() const;

    const std::string& sheet_filename() const;

    int sheet_width() const;

    int sheet_height() const;

    int sheet_padding() const;

    int sheet_spacing() const;

    int total_frames() const;

    bool load_file(const std::string& filename);

    bool load_sheet_object(const Value& object);
 
    bool insert_frame(nom::size_type frame_num, const IntRect& frame_bounds);
    bool append_frame(const IntRect& frame_bounds);

    bool remove_frame(nom::size_type frame);

    void remove_frames();

    void dump() const;
 
  private:
    std::map<int, IntRect> sheet_;

    std::string sheet_filename_;

    int sheet_spacing_;

    int sheet_padding_;

    int sheet_width_;

    int sheet_height_;

    int total_frames_;
};
 
} // namespace nom
 
#endif // include guard defined