1 /* === S Y N F I G ========================================================= */
3 ** \brief Layer Class Header
8 ** Copyright (c) 2002-2005 Robert B. Quattlebaum Jr., Adrian Bentley
9 ** Copyright (c) 2008 Chris Moore
11 ** This package is free software; you can redistribute it and/or
12 ** modify it under the terms of the GNU General Public License as
13 ** published by the Free Software Foundation; either version 2 of
14 ** the License, or (at your option) any later version.
16 ** This package is distributed in the hope that it will be useful,
17 ** but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ** MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
19 ** General Public License for more details.
22 /* ========================================================================= */
24 /* === S T A R T =========================================================== */
26 #ifndef __SYNFIG_LAYER_H
27 #define __SYNFIG_LAYER_H
29 /* === H E A D E R S ======================================================= */
31 #include "string_decl.h"
36 #include <sigc++/signal.h>
37 #include <sigc++/connection.h>
42 /* === M A C R O S ========================================================= */
45 #define SYNFIG_LAYER_MODULE_EXT \
47 static const char name__[], version__[], cvs_id__[], local_name__[], category__[]; \
48 static Layer *create();
50 //! Sets the name of the layer
51 #define SYNFIG_LAYER_SET_NAME(class,x) \
52 const char class::name__[]=x
54 //! Sets the local name of the layer
55 #define SYNFIG_LAYER_SET_LOCAL_NAME(class,x) \
56 const char class::local_name__[]=x;
58 //! Sets the category of the layer
59 #define SYNFIG_LAYER_SET_CATEGORY(class,x) \
60 const char class::category__[]=x
62 //! Sets the version string for the layer
63 #define SYNFIG_LAYER_SET_VERSION(class,x) \
64 const char class::version__[]=x
66 //! Sets the CVS ID string for the layer
67 #define SYNFIG_LAYER_SET_CVS_ID(class,x) \
68 const char class::cvs_id__[]=x
71 #define SYNFIG_LAYER_INIT(class) \
72 synfig::Layer* class::create() \
78 #define IMPORT_PLUS(x,y) \
79 if (param==#x && value.same_type_as(x)) \
89 #define IMPORT_AS(x,y) \
90 if (param==y && value.same_type_as(x)) \
101 #define EXPORT_AS(x,y) \
110 #define EXPORT_NAME() \
111 if (param=="Name" || param=="name" || param=="name__") \
113 else if (param=="local_name__") \
114 return dgettext("synfig",local_name__);
117 #define EXPORT_VERSION() \
118 if (param=="Version" || param=="version" || param=="version__") \
121 //! This is used as the category for layer book entries which represent aliases of layers.
122 //! It prevents these layers showing up in the menu.
123 #define CATEGORY_DO_NOT_USE "Do Not Use"
125 /* === T Y P E D E F S ===================================================== */
127 /* === C L A S S E S & S T R U C T S ======================================= */
133 typedef Vector Point;
142 class ProgressCallback;
154 class Layer : public Node
156 friend class ValueNode;
157 friend class Context;
160 -- ** -- T Y P E S -----------------------------------------------------------
165 //! Type that represents a pointer to a Layer's constructor.
166 /*! As a pointer to the constructor, it represents a "factory" of layers.
168 typedef Layer* (*Factory)();
179 BookEntry(Factory factory,
181 const String &local_name,
182 const String &category,
183 const String &cvs_id,
184 const String &version):
187 local_name(local_name),
193 //! Book of types of layers indexed by layer type name.
194 /*! While the sifz file is read, each time a new layer entry is found,
195 ** the factory constructor that the "factory" pointer member of the
196 ** "BookEntry" struct points to, is called, and a new layer of that type
198 ** \sa Layer::Factory
200 typedef std::map<String,BookEntry> Book;
202 static void register_in_book(const BookEntry &);
206 static bool subsys_init();
208 static bool subsys_stop();
210 typedef std::map<String,ValueBase> ParamList;
212 typedef etl::handle<Layer> Handle;
214 typedef etl::loose_handle<Layer> LooseHandle;
216 typedef etl::handle<const Layer> ConstHandle;
218 typedef std::map<String,etl::rhandle<ValueNode> > DynamicParamList;
220 //! A list type which describes all the parameters that a layer has.
221 /*! \see get_param_vocab() */
222 typedef ParamVocab Vocab;
225 -- ** -- D A T A -------------------------------------------------------------
230 /*! \c true if the layer is visible, \c false if it is to be skipped
231 ** \see set_active(), enable(), disable, active()
235 //! Handle to the canvas to which this layer belongs
236 etl::loose_handle<Canvas> canvas_;
238 DynamicParamList dynamic_param_list_;
240 //! A description of what this layer does
247 mutable Time dirty_time_;
249 //! Contains the name of the group that this layer belongs to
253 sigc::connection parent_death_connect_;
256 -- ** -- S I G N A L S -------------------------------------------------------
262 sigc::signal<void> signal_status_changed_;
264 //! Parameter changed
265 sigc::signal<void,String> signal_param_changed_;
267 //! Description Changed
268 sigc::signal<void> signal_description_changed_;
271 sigc::signal<void, int, etl::handle<Canvas> > signal_moved_;
273 sigc::signal<void, String> signal_added_to_group_;
275 sigc::signal<void, String> signal_removed_from_group_;
278 -- ** -- S I G N A L I N T E R F A C E -------------------------------------
284 sigc::signal<void>& signal_status_changed() { return signal_status_changed_; }
286 //! Parameter changed
287 sigc::signal<void,String>& signal_param_changed() { return signal_param_changed_; }
289 //! Description Changed
290 sigc::signal<void>& signal_description_changed() { return signal_description_changed_;}
293 sigc::signal<void, int, etl::handle<Canvas> >& signal_moved() { return signal_moved_; }
295 sigc::signal<void, String>& signal_added_to_group() { return signal_added_to_group_; }
297 sigc::signal<void, String>& signal_removed_from_group() { return signal_removed_from_group_; }
300 -- ** -- C O N S T R U C T O R S ---------------------------------------------
311 -- ** -- M E M B E R F U N C T I O N S -------------------------------------
316 virtual void on_canvas_set();
318 //! Adds this layer to the given layer group
319 void add_to_group(const String&);
321 //! Removes this layer from the given layer group
322 void remove_from_group(const String&);
324 //! Removes this layer from all layer groups
325 void remove_from_all_groups();
327 //! Gets the name of the group that this layer belongs to
328 String get_group()const;
331 //DynamicParamList &dynamic_param_list() { return dynamic_param_list_; }
334 const DynamicParamList &dynamic_param_list()const { return dynamic_param_list_; }
336 bool connect_dynamic_param(const String& param, etl::loose_handle<ValueNode>);
337 bool disconnect_dynamic_param(const String& param);
339 //! Enables the layer for rendering (Making it \em active)
340 void enable() { set_active(true); }
342 //! Disables the layer for rendering. (Making it \em inactive)
343 /*! When a layer is disabled, it will be skipped when the
344 ** canvas is rendered. */
345 void disable() { set_active(false); }
347 //! Sets the 'active' flag for the Layer to the state described by \a x
348 /*! When a layer is disabled, it will be skipped when the
349 ** canvas is rendered. */
350 void set_active(bool x);
352 //! Returns that status of the 'active' flag
353 bool active()const { return active_; }
355 //! Returns the position of the layer in the canvas.
356 /*! Returns negative on error */
357 int get_depth()const;
360 float get_z_depth()const { return z_depth_; }
363 float get_z_depth(const synfig::Time& t)const;
366 void set_z_depth(float x) { z_depth_=x; }
368 //! Sets the Canvas that this Layer is a part of
369 void set_canvas(etl::loose_handle<Canvas> canvas);
371 //! Returns a handle to the Canvas to which this Layer belongs
372 etl::loose_handle<Canvas> get_canvas()const;
375 const String& get_description()const { return description_; }
378 void set_description(const String& x);
380 //! Returns the layer's description if it's not empty, else its local name
381 const String get_non_empty_description()const { return get_description().empty() ? get_local_name() : get_description(); }
383 //! Returns the localised version of the given layer parameter
384 const String get_param_local_name(const String ¶m_name)const;
387 -- ** -- V I R T U A L F U N C T I O N S -----------------------------------
391 virtual Rect get_bounding_rect()const;
393 virtual Rect get_full_bounding_rect(Context context)const;
395 //! Returns a string containing the name of the Layer
396 virtual String get_name()const;
398 //! Returns a string containing the localized name of the Layer
399 virtual String get_local_name()const;
401 //! Gets the parameter vocabulary
402 virtual Vocab get_param_vocab()const;
404 //! Gets the version string for this layer
405 virtual String get_version()const;
408 virtual etl::handle<Transform> get_transform()const;
410 //! Sets the virtual version to use for backwards-compatibility
412 ** \see reset_version() */
413 virtual bool set_version(const String &ver);
415 //! Resets the virtual version
417 ** \see set_version() */
418 virtual void reset_version();
420 //! Sets the parameter described by \a param to \a value.
421 /*! \param param The name of the parameter to set
422 ** \param value What the parameter is to be set to.
423 ** \return \c true on success, \c false upon rejection or failure.
424 ** If it returns \c false, then the Layer is assumed to remain unchanged.
426 ** \todo \a param should be of the type <tt>const String \¶m</tt>
428 virtual bool set_param(const String ¶m, const ValueBase &value);
430 //! Sets a list of parameters
431 virtual bool set_param_list(const ParamList &);
433 //! Get the value of the specified parameter.
434 /*! \return The requested parameter value, or (upon failure) a NIL ValueBase.
436 ** \todo \a param should be of the type <tt>const String \&</tt>
438 virtual ValueBase get_param(const String ¶m)const;
440 //! Get a list of all of the parameters and their values
441 virtual ParamList get_param_list()const;
443 //! Sets the \a time for the selected Layer and those under it
444 /*! \param context Context iterator referring to next Layer.
445 ** \param time writeme
446 ** \see Handle::set_time()
448 virtual void set_time(Context context, Time time)const;
450 //! Sets the \a time for the selected Layer and those under it for a specific \a point
451 /*! \param context Context iterator referring to next Layer.
452 ** \param time writeme
453 ** \param point writeme
454 ** \see Handle::set_time()
455 ** \todo \a point should be of the type <tt>const Point \&</tt> */
456 virtual void set_time(Context context, Time time, const Point &point)const;
458 //! Gets the color of the Canvas at \a pos
459 /*! \param context Context iterator referring to next Layer.
460 ** \param pos Point which indicates where the Color should come from
461 ** \see Handle::get_color()
463 virtual Color get_color(Context context, const Point &pos)const;
465 //! Renders the Canvas to the given Surface in an accelerated manner
466 /*! \param context Context iterator referring to next Layer.
467 ** \param surface Pointer to Surface to render to.
468 ** \param quality The requested quality-level to render at.
469 ** \param renddesc The associated RendDesc.
470 ** \param cb Pointer to callback object. May be NULL if there is no callback.
471 ** \return \c true on success, \c false on failure
472 ** \see Handle::accelerated_render()
474 virtual bool accelerated_render(Context context,Surface *surface,int quality, const RendDesc &renddesc, ProgressCallback *cb)const;
476 //! Checks to see if a part of the layer is directly under \a point
477 /*! \param context Context iterator referring to next Layer.
478 ** \param point The point to check
479 ** \return The handle of the layer under \a point. If there is not
480 ** a layer under \a point, then returns an empty handle. */
481 virtual Handle hit_check(Context context, const Point &point)const;
483 //! Duplicates the Layer
484 virtual Handle clone(const GUID& deriv_guid=GUID())const;
486 //! Returns true if the layer needs to be able to examine its context.
487 /*! context to render itself, other than for simple blending. For
488 ** example, the blur layer will return true - it can't do its job
489 ** if it can't see its context, and the circle layer will return
490 ** false - rendering a circle doesn't depend on the underlying
491 ** context until the final blend operation. */
492 virtual bool reads_context()const;
494 //! Duplicates the Layer without duplicating the value nodes
495 virtual Handle simple_clone()const;
499 //! This is called whenever a parameter is changed
500 virtual void on_changed();
502 //! Called to figure out the animation time information
503 virtual void get_times_vfunc(Node::time_set &set) const;
506 -- ** -- S T A T I C F U N C T I O N S --------------------------------------
511 //! Creates a Layer of type \a type
512 /*! If the Layer type is unknown, then a Mime layer is created in its place.
513 ** \param type A string describing the name of the layer to construct.
514 ** \return Always returns a handle to a new Layer.
517 static Layer::LooseHandle create(const String &type);
519 }; // END of class Layer
521 }; // END of namespace synfig
524 /* === E N D =============================================================== */