Added documentation for Factory and Book typedefs.
[synfig.git] / synfig-core / src / synfig / target.cpp
1 /* === S Y N F I G ========================================================= */
2 /*!     \file target.cpp
3 **      \brief Target Class Implementation
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 /* === H E A D E R S ======================================================= */
24
25 #define SYNFIG_NO_ANGLE
26
27 #ifdef HAVE_CONFIG_H
28 # include <config.h>
29 #endif
30
31 #include "target.h"
32 #include "string.h"
33 #include "canvas.h"
34 #include "target_null.h"
35 #include "target_null_tile.h"
36
37 using namespace synfig;
38 using namespace etl;
39 using namespace std;
40
41 synfig::Target::Book* synfig::Target::book_;
42 synfig::Target::ExtBook* synfig::Target::ext_book_;
43
44 static synfig::Gamma* default_gamma_;
45
46 /* === P R O C E D U R E S ================================================= */
47
48 bool
49 Target::subsys_init()
50 {
51         book_=new synfig::Target::Book();
52         ext_book_=new synfig::Target::ExtBook();
53
54         default_gamma_=new synfig::Gamma(1.0/2.2);
55         //default_gamma_->set_black_level(0.05); // Default to 5% black level.
56
57         // At least one target must be available.
58         book()["null"]=std::pair<synfig::Target::Factory,String>(Target_Null::create,"null");
59         ext_book()["null"]="null";
60         book()["null-tile"]=std::pair<synfig::Target::Factory,String>(Target_Null_Tile::create,"null-tile");
61         ext_book()["null-tile"]="null-tile";
62
63         return true;
64 }
65
66 bool
67 Target::subsys_stop()
68 {
69         delete book_;
70         delete ext_book_;
71         delete default_gamma_;
72         return true;
73 }
74
75 Target::Book&
76 Target::book()
77 {
78         return *book_;
79 }
80
81 Target::ExtBook&
82 Target::ext_book()
83 {
84         return *ext_book_;
85 }
86
87
88 /* === M E T H O D S ======================================================= */
89
90 Target::Target():
91         quality_(4),
92         gamma_(*default_gamma_),
93         remove_alpha(false),
94         avoid_time_sync_(false)
95 {
96 }
97
98 void
99 synfig::Target::set_canvas(etl::handle<Canvas> c)
100 {
101         canvas=c;
102         RendDesc desc=canvas->rend_desc();
103         set_rend_desc(&desc);
104 }
105
106
107 Target::Handle
108 Target::create(const String &name, const String &filename)
109 {
110         if(!book().count(name))
111                 return handle<Target>();
112
113         return Target::Handle(book()[name].first(filename.c_str()));
114 }