/usr/include/synfig-1.0/synfig/context.h is in libsynfig-dev 1.0.2-1+b6.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 | /* === S Y N F I G ========================================================= */
/*! \file context.h
** \brief Iterator for the layers behind the current Layer.
**
** $Id$
**
** \legal
** Copyright (c) 2002-2005 Robert B. Quattlebaum Jr., Adrian Bentley
** Copyright (c) 2012-2013 Carlos López
**
** This package 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 package is distributed in the hope that it will be useful,
** but WITHOUT ANY WARRANTY; without even the implied warranty of
** MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
** General Public License for more details.
** \endlegal
*/
/* ========================================================================= */
/* === 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
** \brief IndependentContext is a class to warp the iterator for a double queue of layers
* (that is the CanvasBase).
** \see Layer, Canvas, CanvasBase, Context */
class IndependentContext: public CanvasBase::const_iterator
{
public:
IndependentContext() { }
//! Constructor based on other CanvasBase iterator
IndependentContext(const CanvasBase::const_iterator &x):CanvasBase::const_iterator(x) { }
//! Assignation operator
IndependentContext operator=(const CanvasBase::const_iterator &x)
{ return CanvasBase::const_iterator::operator=(x); }
//! Sets the context to the Time \time. It is done recursively.
void set_time(Time time)const;
//! Sets the context to the Time \time. It is done recursively. Vector \pos is not used
void set_time(Time time,const Vector &pos)const;
//! Sets dirty (dirty_time_= Time::end()) to all Outline type layers
void set_dirty_outlines();
};
/*! \class ContextParams
** \brief ContextParams is a class to store rendering parameters significant for Context.
** \see Context */
class ContextParams {
public:
//! When \c true layers with exclude_from_rendering flag should be rendered
bool render_excluded_contexts;
//! When \c true layers are visible only in Z_Depth range
bool z_range;
//! Defines the starting position to apply Z_Depth visibility
Real z_range_position;
//! Defines the depth of the range of the Z_Depth visibility
Real z_range_depth;
//! Layers with z_Depth inside transition are partially visibile
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
** \brief Context is a class to warp the iterator for a double queue of layers
* (that is the CanvasBase) with additional information about rendering parameters.
** \see Layer, Canvas, CanvasBase, IndependentContext, ContextParams */
class Context : public IndependentContext
{
private:
//! Rendering parameters significant for Context.
ContextParams params;
public:
Context() { }
//! Constructor based on IndependentContext.
Context(const IndependentContext &x, const ContextParams ¶ms):
IndependentContext(x), params(params) { }
//! Constructor based on IndependentContext and other Context (to get parameters).
Context(const IndependentContext &x, const Context &context):
IndependentContext(x), params(context.params) { }
//! Constructor based on other CanvasBase iterator and other Context (to get parameters).
Context(const CanvasBase::const_iterator &x, const ContextParams ¶ms):
IndependentContext(x), params(params) { }
Context(const CanvasBase::const_iterator &x, const Context &context):
IndependentContext(x), params(context.params) { }
//! Returns next iterator.
Context get_next()const { return Context(*this+1, params); }
//! Returns previous iterator.
Context get_previous()const { return Context(*this-1, params); }
//! Get rendering parameters.
const ContextParams& get_params()const { return params; }
//! Returns the color of the context at the Point \pos.
//! It is the blended color of the context
Color get_color(const Point &pos)const;
CairoColor get_cairocolor(const Point &pos)const;
//! With a given \quality and a given render description it puts the context
//! blend result into the painting \surface */
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;
//! Returns the bounding rectangle of all the context.
//! It is the union of all the layers's bounding rectangle.
Rect get_full_bounding_rect()const;
//! Returns the first context's layer's handle that intesects the given \point */
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);
//! Returns \c true if layer is active with this context_params
static inline bool active(const ContextParams &context_params, const Layer &layer) {
return layer.active()
&& (context_params.render_excluded_contexts
|| !layer.get_exclude_from_rendering());
}
//! Returns a value between 1.0 and 0.0 for layer visibility in z_depth range with this context_params
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;
}
//! Returns \c true if layer is active in this context
inline bool active(const Layer &layer) {
return active(params, layer);
}
//! Returns \c true if layers is visible in z_depth range in this context
inline float z_depth_visibility(const Layer &layer) {
return z_depth_visibility(params, layer);
}
//! Returns \c true if layer is active in this context
inline bool active()const {
return !(operator*()).empty()
&& active(params, *(operator*()));
}
//! Returns \c true if layer is visible in z_depth range in this context
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
|