Sprite.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_HPP
#define NOMLIB_GRAPHICS_SPRITE_HPP
 
#include <memory>
 
#include "nomlib/config.hpp"
#include "nomlib/math/Transformable.hpp"
#include "nomlib/math/Rect.hpp"
#include "nomlib/math/Point2.hpp"
#include "nomlib/system/SDL_helpers.hpp"
 
namespace nom {
 
// Forward declarations
class Texture;
class RenderWindow;
typedef const RenderWindow RenderTarget;

class Sprite: public Transformable
{
  public:
    typedef Sprite self_type;
    typedef Transformable derived_class;
 
    Sprite();
 
    virtual ~Sprite();

    bool init_with_color(const Color4i& color, const Size2i& dims);

    ObjectTypeInfo type() const override;

    virtual void set_position(const Point2i& pos) override;

    virtual void set_size(const Size2i& dims) override;

    std::unique_ptr<Sprite> clone() const;
 
    std::shared_ptr<Texture> texture() const;
 
    bool valid() const;

    Color4i color() const;

    BlendMode color_blend_mode() const;

    uint8 alpha() const;

    bool set_texture(Texture& tex);

    bool set_texture(Texture* tex);

    bool set_texture(std::shared_ptr<Texture>& tex);
 
    bool set_alpha(uint8 opacity);
 
    bool set_color(const Color4i& color);
 
    bool set_color_blend_mode(BlendMode blend);

    void release_texture();
 
    virtual void draw(RenderTarget& target) const override;

    virtual void draw(RenderTarget& target, real64 angle) const;
 
  protected:
    std::shared_ptr<Texture> texture_;
 
  private:
    virtual void update() override;
 
    // TODO: Implement these member variables:
 
    // nom::SpriteBatch can begin using this immediately. Long term, I would
    // like to either re-implement some concept of rescaling, or at the very
    // minimum, let nom::Sprite always hold a reference to a value and do
    // calculations based off it from other APIs or what not.
    // Size2f scale_factor_ = 1.0f;
 
    // Render queues and z-sorting, oh my! Perhaps we could even just upgrade
    // nom::Transformable to Point3..?
    // real32 z_depth_;
};

std::unique_ptr<Sprite>
make_unique_sprite(Texture& tex);

std::unique_ptr<Sprite>
make_unique_sprite(Texture* tex);

std::unique_ptr<Sprite>
make_unique_sprite(std::shared_ptr<Texture>& tex);

std::shared_ptr<Sprite>
make_shared_sprite(Texture& tex);

std::shared_ptr<Sprite>
make_shared_sprite(Texture* tex);

std::shared_ptr<Sprite>
make_shared_sprite(std::shared_ptr<Texture>& tex);
 
} // namespace nom
 
#endif // include guard defined