synfig-core/src/synfig/context.h

   1 /* === S Y N F I G ========================================================= */
   2 /*!     \file context.h
   3 **      \brief Iterator for the layers behind the current Layer.
   4 **
   5 **      $Id$
   6 **
   7 **      \legal
   8 **      Copyright (c) 2002-2005 Robert B. Quattlebaum Jr., Adrian Bentley
   9 **
  10 **      This package is free software; you can redistribute it and/or
  11 **      modify it under the terms of the GNU General Public License as
  12 **      published by the Free Software Foundation; either version 2 of
  13 **      the License, or (at your option) any later version.
  14 **
  15 **      This package is distributed in the hope that it will be useful,
  16 **      but WITHOUT ANY WARRANTY; without even the implied warranty of
  17 **      MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  18 **      General Public License for more details.
  19 **      \endlegal
  20 */
  21 /* ========================================================================= */
  22
  23 /* === S T A R T =========================================================== */
  24
  25 #ifndef __SYNFIG_CONTEXT_H
  26 #define __SYNFIG_CONTEXT_H
  27
  28 /* === H E A D E R S ======================================================= */
  29
  30 #include "canvasbase.h"
  31 #include "rect.h"
  32
  33 /* === M A C R O S ========================================================= */
  34
  35 /* === T Y P E D E F S ===================================================== */
  36
  37 /* === C L A S S E S & S T R U C T S ======================================= */
  38
  39 namespace synfig {
  40
  41 class Vector;
  42 typedef Vector Point;
  43 class Color;
  44 class Surface;
  45 class RendDesc;
  46 class ProgressCallback;
  47 class Layer;
  48 class Time;
  49 class Rect;
  50
  51 /*!     \class Context
  52 **      \brief Context is a class to warp the iterator for a double queue of layers
  53 * (that is the CanvasBase).
  54 **      \see Layer, Canvas, CanvasBase */
  55 class Context : public CanvasBase::const_iterator
  56 {
  57 public:
  58         Context() { }
  59
  60         //! Constructor based on other CanvasBase iterator
  61         Context(const CanvasBase::const_iterator &x):CanvasBase::const_iterator(x) { }
  62
  63         //!Assignation operator
  64         Context operator=(const CanvasBase::const_iterator &x)
  65         { return CanvasBase::const_iterator::operator=(x); }
  66
  67         //!     Returns the color of the context at the Point \pos.
  68         //! It is the blended color of the context
  69         Color get_color(const Point &pos)const;
  70
  71         //!     With a given \quality and a given render description it puts the context
  72         //! blend result into the painting \surface */
  73         bool accelerated_render(Surface *surface,int quality, const RendDesc &renddesc, ProgressCallback *cb) const;
  74
  75         //! Sets the context to the Time \time. It is done recursively.
  76         void set_time(Time time)const;
  77
  78         //!     Sets the context to the Time \time. It is done recursively. Vector \pos is not used
  79         void set_time(Time time,const Vector &pos)const;
  80
  81         //! Returns the bounding rectangle of all the context.
  82         //! It is the union of all the layers's bounding rectangle.
  83         Rect get_full_bounding_rect()const;
  84
  85         //! Returns the first context's layer's handle that intesects the given \point */
  86         etl::handle<Layer> hit_check(const Point &point)const;
  87
  88 }; // END of class Context
  89
  90 }; // END of namespace synfig
  91
  92 /* === E N D =============================================================== */
  93
  94 #endif