synfig::Layer_PasteCanvas Class Reference

#include <layer_pastecanvas.h>

Inheritance diagram for synfig::Layer_PasteCanvas:

synfig::Layer_Composite synfig::Layer_NoDeform synfig::Layer synfig::Node List of all members.

Public Member Functions

virtual void on_canvas_set ()
void set_do_not_muck_with_time (bool x=true)
etl::handle< synfig::Canvasget_sub_canvas () const
void set_sub_canvas (etl::handle< synfig::Canvas > x)
Real get_zoom () const
Time get_time_offset () const
Point get_origin () const
 Layer_PasteCanvas ()
virtual ~Layer_PasteCanvas ()
virtual String get_local_name () const
 Returns a string containing the localized name of 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 point.
virtual void set_time (Context context, Time time) const
 Sets the time for the selected Layer and those under it.
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 paramater vocabulary.
virtual synfig::Rect get_bounding_rect () const
virtual synfig::Layer::Handle hit_check (synfig::Context context, const synfig::Point &point) const
 Checks to see if a part of the layer is directly under point.

Protected Member Functions

virtual void get_times_vfunc (Node::time_set &set) const
 Called to figure out the animation time information.

Constructor & Destructor Documentation

Layer_PasteCanvas::Layer_PasteCanvas  ) 
 

Layer_PasteCanvas::~Layer_PasteCanvas  )  [virtual]
 


Member Function Documentation

void Layer_PasteCanvas::on_canvas_set  )  [virtual]
 

Reimplemented from synfig::Layer.

void synfig::Layer_PasteCanvas::set_do_not_muck_with_time bool  x = true  )  [inline]
 

etl::handle<synfig::Canvas> synfig::Layer_PasteCanvas::get_sub_canvas  )  const [inline]
 

void Layer_PasteCanvas::set_sub_canvas etl::handle< synfig::Canvas x  ) 
 

Real synfig::Layer_PasteCanvas::get_zoom  )  const [inline]
 

Time synfig::Layer_PasteCanvas::get_time_offset  )  const [inline]
 

Point synfig::Layer_PasteCanvas::get_origin  )  const [inline]
 

String Layer_PasteCanvas::get_local_name  )  const [virtual]
 

Returns a string containing the localized name of the Layer.

Reimplemented from synfig::Layer.

bool Layer_PasteCanvas::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.

ValueBase Layer_PasteCanvas::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.

Color Layer_PasteCanvas::get_color Context  context,
const Point pos
const [virtual]
 

Gets the color of the Canvas at point.

Parameters:
context Context iterator refering to next Layer.
point Point which indicates where the desired Color should come from
Todo:
point should be of the type const Point &
See also:
Handle::get_color()

Reimplemented from synfig::Layer.

void Layer_PasteCanvas::set_time Context  context,
Time  time
const [virtual]
 

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

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

Reimplemented from synfig::Layer.

bool Layer_PasteCanvas::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 refering to next Layer.
surface Pointer to Surface to render to.
quality The requested quality-level to render at.
rend_desc The associated RendDesc.
callback 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.

Layer::Vocab Layer_PasteCanvas::get_param_vocab  )  const [virtual]
 

Gets the paramater vocabulary.

Reimplemented from synfig::Layer_Composite.

Rect Layer_PasteCanvas::get_bounding_rect  )  const [virtual]
 

Reimplemented from synfig::Layer.

synfig::Layer::Handle Layer_PasteCanvas::hit_check synfig::Context  context,
const synfig::Point point
const [virtual]
 

Checks to see if a part of the layer is directly under point.

Parameters:
context Context iterator refering to next Layer.
point The point to check
Returns:
The handle of the layer under point. If there is not a layer under point, then returns an empty handle.

Reimplemented from synfig::Layer.

void Layer_PasteCanvas::get_times_vfunc Node::time_set set  )  const [protected, virtual]
 

Called to figure out the animation time information.

Reimplemented from synfig::Layer.


The documentation for this class was generated from the following files:
Generated on Fri Jun 23 15:20:51 2006 for synfig by  doxygen 1.4.6