frame.hpp

Go to the documentation of this file.

/*
   Copyright (C) 2006 - 2016 by Jeremy Rosen <[email protected]>
   Part of the Battle for Wesnoth Project http://www.wesnoth.org/

   This program is free software; you can redistribute it and/or modify
   it under the terms of the GNU General Public License as published by
   the Free Software Foundation; either version 2 of the License, or
   (at your option) any later version.
   This program is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY.

   See the COPYING file for more details.
*/

/**
 *  @file
 *  Frame for unit's animation sequence.
 */

#ifndef UNIT_FRAME_H_INCLUDED
#define UNIT_FRAME_H_INCLUDED

#include "halo.hpp"
#include "image.hpp"

class config;

class progressive_string {
    public:
        progressive_string(const std::string& data = "",int duration = 0);
        int duration() const;
        const std::string & get_current_element(int time) const;
        bool does_not_change() const { return data_.size() <= 1; }
        std::string get_original() const { return input_; }
    private:
        std::vector<std::pair<std::string,int> > data_;
        std::string input_;
};

class progressive_image {
    public:
        progressive_image(const std::string& data = "",int duration = 0);
        int duration() const;
        const image::locator & get_current_element(int time) const;
        bool does_not_change() const { return data_.size() <= 1; }
        std::string get_original() const { return input_; }
    private:
        std::vector<std::pair<image::locator,int> > data_;
        std::string input_;
};

template <class T>
class progressive_
{
    std::vector<std::pair<std::pair<T, T>, int> > data_;
    std::string input_;
public:
    progressive_(const std::string& data = "", int duration = 0);
    int duration() const;
    const T get_current_element(int time,T default_val=0) const;
    bool does_not_change() const;
    std::string get_original() const { return input_; }
};

typedef progressive_<int> progressive_int;
typedef progressive_<double> progressive_double;

typedef enum tristate {t_false,t_true,t_unset} tristate;
bool tristate_to_bool(tristate tri, bool def);
/** All parameters from a frame at a given instant */
class frame_parameters{
    public:
    frame_parameters();

    int duration;
    image::locator image;
    image::locator image_diagonal;
    std::string image_mod;
    std::string halo;
    int halo_x;
    int halo_y;
    std::string halo_mod;
    std::string sound;
    std::string text;
    Uint32 text_color;
    Uint32 blend_with;
    double blend_ratio;
    double highlight_ratio;
    double offset;
    double submerge;
    int x;
    int y;
    int directional_x;
    int directional_y;
    tristate auto_vflip;
    tristate auto_hflip;
    tristate primary_frame;
    int drawing_layer;
} ;
/**
 * easily build frame parameters with the serialized constructors
 */
class frame_parsed_parameters;
class frame_builder {
    public:
        frame_builder();
        frame_builder(const config& cfg,const std::string &frame_string = "");
        /** allow easy chained modifications will raised assert if used after initialization */
        frame_builder & duration(const int duration);
        frame_builder & image(const std::string& image ,const std::string & image_mod="");
        frame_builder & image_diagonal(const std::string& image_diagonal,const std::string & image_mod="");
        frame_builder & sound(const std::string& sound);
        frame_builder & text(const std::string& text,const  Uint32 text_color);
        frame_builder & halo(const std::string &halo, const std::string &halo_x, const std::string& halo_y,const std::string& halo_mod);
        frame_builder & blend(const std::string& blend_ratio,const Uint32 blend_color);
        frame_builder & highlight(const std::string& highlight);
        frame_builder & offset(const std::string& offset);
        frame_builder & submerge(const std::string& submerge);
        frame_builder & x(const std::string& x);
        frame_builder & y(const std::string& y);
        frame_builder & directional_x(const std::string& directional_x);
        frame_builder & directional_y(const std::string& directional_y);
        frame_builder & auto_vflip(const bool auto_vflip);
        frame_builder & auto_hflip(const bool auto_hflip);
        frame_builder & primary_frame(const bool primary_frame);
        frame_builder & drawing_layer(const std::string& drawing_layer);
        /** getters for the different parameters */
    private:
        friend class frame_parsed_parameters;
        int duration_;
        std::string image_;
        std::string image_diagonal_;
        std::string image_mod_;
        std::string halo_;
        std::string halo_x_;
        std::string halo_y_;
        std::string halo_mod_;
        std::string sound_;
        std::string text_;
        Uint32 text_color_;
        Uint32 blend_with_;
        std::string blend_ratio_;
        std::string highlight_ratio_;
        std::string offset_;
        std::string submerge_;
        std::string x_;
        std::string y_;
        std::string directional_x_;
        std::string directional_y_;
        tristate auto_vflip_;
        tristate auto_hflip_;
        tristate primary_frame_;
        std::string drawing_layer_;
};
/**
 * keep most parameters in a separate class to simplify handling of large
 * number of parameters handling is common for frame level and animation level
 */
class frame_parsed_parameters {
    public:
        frame_parsed_parameters(const frame_builder& builder=frame_builder(),int override_duration = 0);
        /** allow easy chained modifications will raised assert if used after initialization */
        void override( int duration
                , const std::string& highlight = ""
                , const std::string& blend_ratio =""
                , Uint32 blend_color = 0
                , const std::string& offset = ""
                , const std::string& layer = ""
                , const std::string& modifiers = "");
        /** getters for the different parameters */
        const frame_parameters parameters(int current_time) const ;

        int duration() const{ return duration_;}
        bool does_not_change() const;
        bool need_update() const;
        std::vector<std::string> debug_strings() const; //contents of frame in strings
    private:
        int duration_;
        progressive_image image_;
        progressive_image image_diagonal_;
        std::string image_mod_;
        progressive_string halo_;
        progressive_int halo_x_;
        progressive_int halo_y_;
        std::string halo_mod_;
        std::string sound_;
        std::string text_;
        Uint32 text_color_;
        Uint32 blend_with_;
        progressive_double blend_ratio_;
        progressive_double highlight_ratio_;
        progressive_double offset_;
        progressive_double submerge_;
        progressive_int x_;
        progressive_int y_;
        progressive_int directional_x_;
        progressive_int directional_y_;
        tristate auto_vflip_;
        tristate auto_hflip_;
        tristate primary_frame_;
        progressive_int drawing_layer_;
};
/** Describe a unit's animation sequence. */
class unit_frame {
    public:
        // Constructors
        unit_frame(const frame_builder& builder=frame_builder()):builder_(builder){}
        void redraw(const int frame_time,bool on_start_time,bool in_scope_of_frame,const map_location & src,const map_location & dst,halo::handle & halo_id, halo::manager & halo_man, const frame_parameters & animation_val,const frame_parameters & engine_val)const;
        const frame_parameters merge_parameters(int current_time,const frame_parameters & animation_val,const frame_parameters & engine_val=frame_parameters()) const;
        const frame_parameters parameters(int current_time) const {return builder_.parameters(current_time);}
        const frame_parameters end_parameters() const {return builder_.parameters(duration());}

        int duration() const { return builder_.duration();}
        bool does_not_change() const{ return builder_.does_not_change();}
        bool need_update() const{ return builder_.need_update();}
        std::set<map_location> get_overlaped_hex(const int frame_time,const map_location & src,const map_location & dst,const frame_parameters & animation_val,const frame_parameters & engine_val) const;
        std::vector<std::string> debug_strings() const { return builder_.debug_strings();} //contents of frame in strings
    private:
        frame_parsed_parameters builder_;

};

#endif