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 ========================================================= */
44 //! Defines various variables and the create method, common for all importers.
45 //! To be used in the private part of the importer class definition.
46 #define SYNFIG_LAYER_MODULE_EXT \
48 static const char name__[], version__[], cvs_id__[], local_name__[], category__[]; \
49 static Layer *create();
51 //! Sets the name of the layer
52 #define SYNFIG_LAYER_SET_NAME(class,x) \
53 const char class::name__[]=x
55 //! Sets the local name of the layer
56 #define SYNFIG_LAYER_SET_LOCAL_NAME(class,x) \
57 const char class::local_name__[]=x;
59 //! Sets the category of the layer
60 #define SYNFIG_LAYER_SET_CATEGORY(class,x) \
61 const char class::category__[]=x
63 //! Sets the version string for the layer
64 #define SYNFIG_LAYER_SET_VERSION(class,x) \
65 const char class::version__[]=x
67 //! Sets the CVS ID string for the layer
68 #define SYNFIG_LAYER_SET_CVS_ID(class,x) \
69 const char class::cvs_id__[]=x
71 //! Defines de implementation of the create method for the importer
72 #define SYNFIG_LAYER_INIT(class) \
73 synfig::Layer* class::create() \
78 //! Imports a parameter 'x' and perform an action based usually based on
79 //! some condition 'y'
80 #define IMPORT_PLUS(x,y) \
81 if (param==#x && value.same_type_as(x)) \
84 set_param_static(#x,value.get_static()); \
91 //! Imports a parameter 'y' if it has the same type than 'x'
92 #define IMPORT_AS(x,y) \
93 if (param==y && value.same_type_as(x)) \
96 set_param_static(#x,value.get_static()); \
100 //! Imports a parameter if it is of the same type as param
104 //! Exports a parameter 'x' if param is same type as given 'y'
105 #define EXPORT_AS(x,y) \
108 synfig::ValueBase ret(x); \
109 ret.set_static(get_param_static(y)); \
113 //! Exports a parameter if it is the same type as value
117 //! Exports the name or the local name of the layer
118 #define EXPORT_NAME() \
119 if (param=="Name" || param=="name" || param=="name__") \
121 else if (param=="local_name__") \
122 return dgettext("synfig",local_name__);
124 //! Exports the version of the layer
125 #define EXPORT_VERSION() \
126 if (param=="Version" || param=="version" || param=="version__") \
129 //! This is used as the category for layer book entries which represent aliases of layers.
130 //! It prevents these layers showing up in the menu.
131 #define CATEGORY_DO_NOT_USE "Do Not Use"
133 //! x=variable name, y=static bool value
134 #define SET_STATIC(x,y) \
135 if(param==#x && x ## _static != y) \
141 #define GET_STATIC(x) \
143 return x ## _static; \
146 /* === T Y P E D E F S ===================================================== */
148 /* === C L A S S E S & S T R U C T S ======================================= */
154 typedef Vector Point;
163 class ProgressCallback;
175 class Layer : public Node
177 friend class ValueNode;
178 friend class Context;
181 -- ** -- T Y P E S -----------------------------------------------------------
186 //! Type that represents a pointer to a Layer's constructor.
187 /*! As a pointer to the constructor, it represents a "factory" of layers.
189 typedef Layer* (*Factory)();
200 BookEntry(Factory factory,
202 const String &local_name,
203 const String &category,
204 const String &cvs_id,
205 const String &version):
208 local_name(local_name),
214 //! Book of types of layers indexed by layer type name.
215 /*! While the sifz file is read, each time a new layer entry is found,
216 ** the factory constructor that the "factory" pointer member of the
217 ** "BookEntry" struct points to, is called, and a new layer of that type
219 ** \sa Layer::Factory
221 typedef std::map<String,BookEntry> Book;
223 static void register_in_book(const BookEntry &);
227 //! Inits the book of layers and inserts in it the basic layers that
228 //! doesn't depend on modules
229 /*! \todo motionblur should be in the mod_filter module
231 static bool subsys_init();
233 //! Stops the layer system by deleting the book of registered layers
234 static bool subsys_stop();
236 //! Map of Value Base parameters indexed by name
237 typedef std::map<String,ValueBase> ParamList;
239 typedef etl::handle<Layer> Handle;
241 typedef etl::loose_handle<Layer> LooseHandle;
243 typedef etl::handle<const Layer> ConstHandle;
245 //! Map of parameters that are animated Value Nodes indexed by the param name
246 typedef std::map<String,etl::rhandle<ValueNode> > DynamicParamList;
248 //! A list type which describes all the parameters that a layer has.
249 /*! \see get_param_vocab() */
250 typedef ParamVocab Vocab;
253 -- ** -- D A T A -------------------------------------------------------------
258 /*! \c true if the layer is visible, \c false if it is to be skipped
259 ** \see set_active(), enable(), disable, active()
263 //! Handle to the canvas to which this layer belongs
264 etl::loose_handle<Canvas> canvas_;
266 //! Map of parameter with animated value nodes
267 DynamicParamList dynamic_param_list_;
269 //! A description of what this layer does
272 //! The depth parameter of the layer in the layer stack
275 //! True if zdepth is not affected when in animation mode
279 mutable Time dirty_time_;
281 //! Contains the name of the group that this layer belongs to
284 //! Signal to connect to the signal_deleted canvas's member
285 //! Used to do let a layer with a canvas parent that doesn't exists
286 //! Instead of that it connects to a zero canvas
287 //! \see Layer::set_canvas()
288 sigc::connection parent_death_connect_;
291 -- ** -- S I G N A L S -------------------------------------------------------
297 sigc::signal<void> signal_status_changed_;
299 //! Parameter changed
300 sigc::signal<void,String> signal_param_changed_;
302 //! Description Changed
303 sigc::signal<void> signal_description_changed_;
306 sigc::signal<void, int, etl::handle<Canvas> > signal_moved_;
308 sigc::signal<void, String> signal_added_to_group_;
310 sigc::signal<void, String> signal_removed_from_group_;
313 -- ** -- S I G N A L I N T E R F A C E -------------------------------------
319 sigc::signal<void>& signal_status_changed() { return signal_status_changed_; }
321 //! Parameter changed
322 sigc::signal<void,String>& signal_param_changed() { return signal_param_changed_; }
324 //! Description Changed
325 sigc::signal<void>& signal_description_changed() { return signal_description_changed_;}
328 sigc::signal<void, int, etl::handle<Canvas> >& signal_moved() { return signal_moved_; }
330 sigc::signal<void, String>& signal_added_to_group() { return signal_added_to_group_; }
332 sigc::signal<void, String>& signal_removed_from_group() { return signal_removed_from_group_; }
335 -- ** -- C O N S T R U C T O R S ---------------------------------------------
346 -- ** -- M E M B E R F U N C T I O N S -------------------------------------
351 virtual void on_canvas_set();
353 //! Adds this layer to the given layer group
354 void add_to_group(const String&);
356 //! Removes this layer from the given layer group
357 void remove_from_group(const String&);
359 //! Removes this layer from all layer groups
360 void remove_from_all_groups();
362 //! Gets the name of the group that this layer belongs to
363 String get_group()const;
365 //! Retrieves the dynamic param list member
366 //! \see DynamicParamList
367 const DynamicParamList &dynamic_param_list()const { return dynamic_param_list_; }
369 //! Connects the parameter to another Value Node
370 bool connect_dynamic_param(const String& param, etl::loose_handle<ValueNode>);
372 //! Disconnects the parameter from any Value Node
373 bool disconnect_dynamic_param(const String& param);
375 //! Enables the layer for rendering (Making it \em active)
376 void enable() { set_active(true); }
378 //! Disables the layer for rendering. (Making it \em inactive)
379 /*! When a layer is disabled, it will be skipped when the
380 ** canvas is rendered. */
381 void disable() { set_active(false); }
383 //! Sets the 'active' flag for the Layer to the state described by \a x
384 /*! When a layer is disabled, it will be skipped when the
385 ** canvas is rendered. */
386 void set_active(bool x);
388 //! Returns that status of the 'active' flag
389 bool active()const { return active_; }
391 //! Returns the position of the layer in the canvas.
392 /*! Returns negative on error */
393 int get_depth()const;
395 //! Gets the non animated z depth of the layer
396 float get_z_depth()const { return z_depth_; }
398 //! Gets the z depth of the layer at a time t
399 float get_z_depth(const synfig::Time& t)const;
401 //! Sets the z depth of the layer (non animated)
402 void set_z_depth(float x) { z_depth_=x; }
404 //! Sets the Canvas that this Layer is a part of
405 void set_canvas(etl::loose_handle<Canvas> canvas);
407 //! Returns a handle to the Canvas to which this Layer belongs
408 etl::loose_handle<Canvas> get_canvas()const;
410 //! Returns the description of the layer
411 const String& get_description()const { return description_; }
413 //! Sets the description of the layer
414 void set_description(const String& x);
416 //! Returns the layer's description if it's not empty, else its local name
417 const String get_non_empty_description()const { return get_description().empty() ? get_local_name() : get_description(); }
419 //! Returns the localised version of the given layer parameter
420 const String get_param_local_name(const String ¶m_name)const;
423 -- ** -- V I R T U A L F U N C T I O N S -----------------------------------
427 //! Returns the rectangle that includes the layer
428 //! \see synfig::Rect
429 virtual Rect get_bounding_rect()const;
431 //!Returns the rectangle that includes the context of the layer
432 //!\see synfig::Rect synfig::Context
433 virtual Rect get_full_bounding_rect(Context context)const;
435 //! Returns a string containing the name of the Layer
436 virtual String get_name()const;
438 //! Returns a string containing the localized name of the Layer
439 virtual String get_local_name()const;
441 //! Gets the parameter vocabulary
442 virtual Vocab get_param_vocab()const;
444 //! Gets the version string for this layer
445 virtual String get_version()const;
447 //! Returns a handle to the Transform class of the layer
448 //! \see synfig::Transform
449 virtual etl::handle<Transform> get_transform()const;
451 //! Sets the virtual version to use for backwards-compatibility
453 ** \see reset_version() */
454 virtual bool set_version(const String &ver);
456 //! Resets the virtual version
458 ** \see set_version() */
459 virtual void reset_version();
461 //! Sets the parameter described by \a param to \a value.
462 /*! \param param The name of the parameter to set
463 ** \param value What the parameter is to be set to.
464 ** \return \c true on success, \c false upon rejection or failure.
465 ** If it returns \c false, then the Layer is assumed to remain unchanged.
467 ** \todo \a param should be of the type <tt>const String \¶m</tt>
469 virtual bool set_param(const String ¶m, const ValueBase &value);
471 virtual bool set_param_static(const String ¶m, const bool x);
472 virtual bool get_param_static(const String ¶m) const;
474 //! Sets a list of parameters
475 virtual bool set_param_list(const ParamList &);
477 //! Get the value of the specified parameter.
478 /*! \return The requested parameter value, or (upon failure) a NIL ValueBase.
480 ** \todo \a param should be of the type <tt>const String \&</tt>
482 virtual ValueBase get_param(const String ¶m)const;
484 //! Get a list of all of the parameters and their values
485 virtual ParamList get_param_list()const;
487 //! Sets the \a time for the Layer and those under it
488 /*! \param context Context iterator referring to next Layer.
489 ** \param time writeme
490 ** \see Context::set_time()
492 virtual void set_time(Context context, Time time)const;
494 //! Sets the \a time for the selected Layer and those under it for a specific \a point
495 /*! \param context Context iterator referring to next Layer.
496 ** \param time writeme
497 ** \param point writeme
498 ** \see Context::set_time()
499 ** \todo \a point should be of the type <tt>const Point \&</tt> */
500 virtual void set_time(Context context, Time time, const Point &point)const;
502 //! Gets the blend color of the Layer in the context at \a pos
503 /*! \param context Context iterator referring to next Layer.
504 ** \param pos Point which indicates where the Color should come from
505 ** \see Context::get_color()
507 virtual Color get_color(Context context, const Point &pos)const;
509 //! Renders the Canvas to the given Surface in an accelerated manner
510 /*! \param context Context iterator referring to next Layer.
511 ** \param surface Pointer to Surface to render to.
512 ** \param quality The requested quality-level to render at.
513 ** \param renddesc The associated RendDesc.
514 ** \param cb Pointer to callback object. May be NULL if there is no callback.
515 ** \return \c true on success, \c false on failure
516 ** \see Context::accelerated_render()
518 virtual bool accelerated_render(Context context,Surface *surface,int quality, const RendDesc &renddesc, ProgressCallback *cb)const;
520 //! Checks to see if a part of the layer is directly under \a point
521 /*! \param context Context iterator referring to next Layer.
522 ** \param point The point to check
523 ** \return The handle of the layer under \a point. If there is not
524 ** a layer under \a point, then returns an empty handle.
525 ** \see Context::hit_check
527 virtual Handle hit_check(Context context, const Point &point)const;
529 //! Duplicates the Layer
530 virtual Handle clone(const GUID& deriv_guid=GUID())const;
532 //! Returns true if the layer needs to be able to examine its context.
533 /*! context to render itself, other than for simple blending. For
534 ** example, the blur layer will return true - it can't do its job
535 ** if it can't see its context, and the circle layer will return
536 ** false - rendering a circle doesn't depend on the underlying
537 ** context until the final blend operation. */
538 virtual bool reads_context()const;
540 //! Duplicates the Layer without duplicating the value nodes
541 virtual Handle simple_clone()const;
545 //! This is called whenever a parameter is changed
546 virtual void on_changed();
548 //! Called to figure out the animation time information
549 virtual void get_times_vfunc(Node::time_set &set) const;
552 -- ** -- S T A T I C F U N C T I O N S --------------------------------------
557 //! Creates a Layer of type \a type
558 /*! If the Layer type is unknown, then a Mime layer is created in its place.
559 ** \param type A string describing the name of the layer to construct.
560 ** \return Always returns a handle to a new Layer.
563 static Layer::LooseHandle create(const String &type);
565 }; // END of class Layer
567 }; // END of namespace synfig
570 /* === E N D =============================================================== */