Gradient.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_SDL2_GRADIENT_HPP
#define NOMLIB_SDL2_GRADIENT_HPP
 
#include <iostream>
#include <string>
#include <vector>
#include <memory>
 
#include "nomlib/config.hpp"
#include "nomlib/math/Size2.hpp"
#include "nomlib/math/Transformable.hpp"
#include "nomlib/math/Color4.hpp"
#include "nomlib/graphics/IDrawable.hpp"
#include "nomlib/graphics/shapes/Rectangle.hpp"
#include "nomlib/core/unique_ptr.hpp"
 
namespace nom {
 
// Forward declarations
class Texture;

class Gradient: public Transformable
 
{
  public:
    typedef Gradient self_type;
    typedef Transformable derived_class;
 
    typedef self_type* raw_ptr;
    typedef std::unique_ptr<self_type> unique_ptr;
    typedef std::shared_ptr<self_type> shared_ptr;

    enum FillDirection
    {
      Top = 0,    // Top down
      Bottom,     // Bottom's up!
      Left,       // Left to right
      Right       // Right to left
    };

    Gradient( void );

    Gradient  (
                const Color4iColors& colors,
                const Point2i& pos,
                const Size2i& size,
                const Point2i& margin,
                Gradient::FillDirection direction
              );

    virtual ~Gradient( void );

    IDrawable::raw_ptr clone( void ) const;

    ObjectTypeInfo type( void ) const;

    Texture* texture() const;

    bool valid( void ) const;

    const Color4i& start_color( void ) const;

    const Color4i& end_color( void ) const;
 
    Gradient::FillDirection fill_direction ( void ) const;
    bool dithering( void ) const;
    const Point2i& margins ( void ) const;

    const Color4iColors& colors( void ) const;

    void set_position( const Point2i& coords );

    void set_size( const Size2i& size );

    void set_colors( const Color4iColors& colors );

    void reverse_colors( void );
 
    void set_fill_direction ( Gradient::FillDirection direction );
 
    //void set_size ( const Size2i& size );
    void set_margins ( const Point2i& margin );
    void set_dithering( bool state );

    void draw( RenderTarget& target ) const;
 
  private:
    void update( void );
 
    void strategy_top_down( void );
    void strategy_left_right( void );

    bool update_cache();

    std::vector<Rectangle> rectangles_;

    std::shared_ptr<Texture> texture_;

    Color4iColors gradient_;

    Point2i margins_;

    enum Gradient::FillDirection fill_direction_;

    bool dithering_;
};
 
} // namespace nom
 
#endif // include guard defined