Fixed the name of the last parameter in the set_time() prototype to match that of...
[synfig.git] / synfig-core / trunk / src / synfig / context.h
1 /* === S Y N F I G ========================================================= */
2 /*!     \file context.h
3 **      \brief Template Header
4 **
5 **      $Id: context.h,v 1.2 2005/01/24 03:08:17 darco Exp $
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 **      \todo writeme
53 **      \see Layer, Canvas */
54 class Context : public CanvasBase::const_iterator
55 {
56 public:
57         Context() { }
58
59         Context(const CanvasBase::const_iterator &x):CanvasBase::const_iterator(x) { }
60
61         Context operator=(const CanvasBase::const_iterator &x)
62         { return CanvasBase::const_iterator::operator=(x); }
63
64         /*!     \todo write me */
65         Color get_color(const Point &pos)const;
66
67         /*!     \todo write me */
68         bool accelerated_render(Surface *surface,int quality, const RendDesc &renddesc, ProgressCallback *cb) const;
69
70         /*!     \todo write me */
71         void set_time(Time time)const;
72
73         /*!     \writeme */
74         void set_time(Time time,const Vector &pos)const;
75
76         Rect get_full_bounding_rect()const;
77
78         /*! \writeme */
79         etl::handle<Layer> hit_check(const Point &point)const;
80
81 }; // END of class Context
82
83 }; // END of namespace synfig
84
85 /* === E N D =============================================================== */
86
87 #endif