synfig::Layer_Duplicate Class Reference

#include <layer_duplicate.h>

Inheritance diagram for synfig::Layer_Duplicate:

synfig::Layer_Composite synfig::Layer synfig::Node

List of all members.

Public Member Functions

 Layer_Duplicate ()
virtual Layer::Handle clone (const GUID &deriv_guid=GUID()) const
 Duplicates the Layer.
virtual bool set_param (const String &param, const synfig::ValueBase &value)
 Sets the parameter described by param to value.
virtual ValueBase get_param (const String &param) const
 Get the value of the specified parameter.
virtual Color get_color (Context context, const Point &pos) const
 Gets the color of the Canvas at pos.
virtual void set_time (Context context, Time time) const
 Sets the time for the selected Layer and those under it.
virtual void set_time (Context context, Time time, const Point &point) const
 Sets the time for the selected Layer and those under it for a specific point.
virtual ValueNode_Duplicate::Handle get_duplicate_param () const
virtual bool accelerated_render (Context context, Surface *surface, int quality, const RendDesc &renddesc, ProgressCallback *cb) const
 Renders the Canvas to the given Surface in an accelerated manner.
virtual Vocab get_param_vocab () const
 Gets the parameter vocabulary.
virtual bool reads_context () const
 Returns true if the layer needs to be able to examine its context.


Constructor & Destructor Documentation

Layer_Duplicate::Layer_Duplicate (  ) 


Member Function Documentation

Layer::Handle Layer_Duplicate::clone ( const GUID deriv_guid = GUID()  )  const [virtual]

Duplicates the Layer.

Reimplemented from synfig::Layer.

References synfig::Layer::clone(), and synfig::Layer::dynamic_param_list().

bool Layer_Duplicate::set_param ( const String param,
const synfig::ValueBase value 
) [virtual]

Sets the parameter described by param to value.

Parameters:
param The name of the parameter to set
value What the parameter is to be set to.
Returns:
true on success, false upon rejection or failure. If it returns false, then the Layer is assumed to remain unchanged.
See also:
get_param()
Todo:
param should be of the type const String &param

Reimplemented from synfig::Layer_Composite.

References IMPORT, and synfig::Layer_Composite::set_param().

ValueBase Layer_Duplicate::get_param ( const String param  )  const [virtual]

Get the value of the specified parameter.

Returns:
The requested parameter value, or (upon failure) a NIL ValueBase.
See also:
set_param()
Todo:
param should be of the type const String &

Reimplemented from synfig::Layer_Composite.

References EXPORT, EXPORT_NAME, EXPORT_VERSION, and synfig::Layer_Composite::get_param().

Color Layer_Duplicate::get_color ( Context  context,
const Point pos 
) const [virtual]

Gets the color of the Canvas at pos.

Parameters:
context Context iterator referring to next Layer.
pos Point which indicates where the Color should come from
See also:
Handle::get_color()

Reimplemented from synfig::Layer.

References synfig::Color::blend(), synfig::Layer_Composite::get_amount(), synfig::Layer_Composite::get_blend_method(), synfig::Context::get_color(), get_duplicate_param(), and synfig::Context::set_time().

void Layer_Duplicate::set_time ( Context  context,
Time  time 
) const [virtual]

Sets the time for the selected Layer and those under it.

Parameters:
context Context iterator referring to next Layer.
time writeme
See also:
Handle::set_time()

Reimplemented from synfig::Layer.

References synfig::Context::set_time().

void Layer_Duplicate::set_time ( Context  context,
Time  time,
const Point point 
) const [virtual]

Sets the time for the selected Layer and those under it for a specific point.

Parameters:
context Context iterator referring to next Layer.
time writeme
point writeme
See also:
Handle::set_time()
Todo:
point should be of the type const Point &

Reimplemented from synfig::Layer.

References synfig::Context::set_time().

ValueNode_Duplicate::Handle Layer_Duplicate::get_duplicate_param (  )  const [virtual]

bool Layer_Duplicate::accelerated_render ( Context  context,
Surface surface,
int  quality,
const RendDesc renddesc,
ProgressCallback cb 
) const [virtual]

Renders the Canvas to the given Surface in an accelerated manner.

Parameters:
context Context iterator referring to next Layer.
surface Pointer to Surface to render to.
quality The requested quality-level to render at.
renddesc The associated RendDesc.
cb Pointer to callback object. May be NULL if there is no callback.
Returns:
true on success, false on failure
See also:
Handle::accelerated_render()

Reimplemented from synfig::Layer_Composite.

References synfig::Context::accelerated_render(), synfig::Color::BLEND_COMPOSITE, synfig::Surface::blit_to(), synfig::Surface::clear(), synfig::Layer_Composite::get_amount(), synfig::Layer_Composite::get_blend_method(), get_duplicate_param(), synfig::RendDesc::get_h(), synfig::RendDesc::get_w(), and synfig::Context::set_time().

Layer::Vocab Layer_Duplicate::get_param_vocab ( void   )  const [virtual]

Gets the parameter vocabulary.

Reimplemented from synfig::Layer_Composite.

References _, synfig::Layer_Composite::get_param_vocab(), and synfig::Layer::set_description().

virtual bool synfig::Layer_Duplicate::reads_context (  )  const [inline, virtual]

Returns true if the layer needs to be able to examine its context.

context to render itself, other than for simple blending. For example, the blur layer will return true - it can't do its job if it can't see its context, and the circle layer will return false - rendering a circle doesn't depend on the underlying context until the final blend operation.

Reimplemented from synfig::Layer.


The documentation for this class was generated from the following files:

Generated on Fri Jul 31 00:01:58 2009 for synfig-core by  doxygen 1.5.6