context.h

Go to the documentation of this file.

/* === S Y N F I G ========================================================= */
/* ========================================================================= */

/* === S T A R T =========================================================== */

#ifndef __SYNFIG_CONTEXT_H
#define __SYNFIG_CONTEXT_H

/* === H E A D E R S ======================================================= */

#include "canvasbase.h"
#include "rect.h"
#include "renddesc.h"
#include "surface.h"
#include <synfig/layers/layer_composite.h>
#include "general.h"

/* === M A C R O S ========================================================= */

/* === T Y P E D E F S ===================================================== */

/* === C L A S S E S & S T R U C T S ======================================= */

namespace synfig {

class Vector;
typedef Vector Point;
class Color;
class Surface;
class CairoSurface;
class RendDesc;
class ProgressCallback;
class Layer;
class Time;
class Rect;

class IndependentContext: public CanvasBase::const_iterator
{
public:
    IndependentContext() { }

    IndependentContext(const CanvasBase::const_iterator &x):CanvasBase::const_iterator(x) { }

    IndependentContext operator=(const CanvasBase::const_iterator &x)
    { return CanvasBase::const_iterator::operator=(x); }

    void set_time(Time time)const;

    void set_time(Time time,const Vector &pos)const;

    void set_dirty_outlines();
};


class ContextParams {
public:
    bool render_excluded_contexts;
    bool z_range;
    Real z_range_position;
    Real z_range_depth;
    Real z_range_blur;

    explicit ContextParams(bool render_excluded_contexts = false):
    render_excluded_contexts(render_excluded_contexts),
    z_range(false),
    z_range_position(0.0),
    z_range_depth(0.0),
    z_range_blur(0.0){ }
};

class Context : public IndependentContext
{
private:
    ContextParams params;

public:

    Context() { }

    Context(const IndependentContext &x, const ContextParams &params):
        IndependentContext(x), params(params) { }

    Context(const IndependentContext &x, const Context &context):
        IndependentContext(x), params(context.params) { }

    Context(const CanvasBase::const_iterator &x, const ContextParams &params):
        IndependentContext(x), params(params) { }

    Context(const CanvasBase::const_iterator &x, const Context &context):
        IndependentContext(x), params(context.params) { }

    Context get_next()const { return Context(*this+1, params); }

    Context get_previous()const { return Context(*this-1, params); }

    const ContextParams& get_params()const { return params; }

    Color get_color(const Point &pos)const;
    CairoColor get_cairocolor(const Point &pos)const;

    bool accelerated_render(Surface *surface,int quality, const RendDesc &renddesc, ProgressCallback *cb) const;
    bool accelerated_cairorender(cairo_t *cr,int quality, const RendDesc &renddesc, ProgressCallback *cb) const;

    Rect get_full_bounding_rect()const;

    etl::handle<Layer> hit_check(const Point &point)const;

    // Set Render Method. Passes the information of the render method to use to the layers
    void set_render_method(RenderMethod x);

    static inline bool active(const ContextParams &context_params, const Layer &layer) {
        return layer.active()
            && (context_params.render_excluded_contexts
            || !layer.get_exclude_from_rendering());
    }

    static inline float z_depth_visibility(const ContextParams &cp, const Layer &layer) {
            if(!cp.z_range)
                return 1.0;
            float z=layer.get_true_z_depth();
            float p=cp.z_range_position;
            float d=cp.z_range_depth;
            float t=cp.z_range_blur;
            // Out of range
            if(z>p+d+t || z<p-t)
                return 0.0;
            else
            // Inside right range
            if(z>p+d)
                return t>0.0?(p+d+t-z)/t:0.0;
            else
            // Inside left range
            if(z<p)
                return t>0.0?(z-p+t)/t:0.0;
            else
            // Full visible
                return 1.0;
    }

    inline bool active(const Layer &layer) {
        return active(params, layer);
    }

    inline float z_depth_visibility(const Layer &layer) {
        return z_depth_visibility(params, layer);
    }

    inline bool active()const {
        return !(operator*()).empty()
             && active(params, *(operator*()));
    }

    inline bool in_z_range()const {
        return !(operator*()).empty()
             && z_depth_visibility(params, *(operator*()));
    }
    
}; // END of class Context

}; // END of namespace synfig

/* === E N D =============================================================== */

#endif