synfig::Layer_Mime Class Reference

#include <layer_mime.h>

Inheritance diagram for synfig::Layer_Mime:

synfig::Layer synfig::Node

List of all members.

Public Member Functions

 Layer_Mime (String name)
virtual String get_version () const
 Gets the version string for this layer.
virtual bool set_version (const String &ver)
 Sets the virtual version to use for backwards-compatibility.
virtual bool set_param (const String &param, const 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 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 String get_local_name () const
 Returns a string containing the localized name of the Layer.


Detailed Description

The mime layer is a layer that is used when an unknown layer type is requested. This allows people without all of the correct layers installed to still work with that composition.

Constructor & Destructor Documentation

Layer_Mime::Layer_Mime ( String  name  ) 


Member Function Documentation

String Layer_Mime::get_version (  )  const [virtual]

Gets the version string for this layer.

Reimplemented from synfig::Layer.

bool Layer_Mime::set_version ( const String ver  )  [virtual]

Sets the virtual version to use for backwards-compatibility.

See also:
reset_version()

Reimplemented from synfig::Layer.

bool Layer_Mime::set_param ( const String param,
const 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.

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

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

Gets the color of the Canvas at pos.

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

Reimplemented from synfig::Layer.

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

Layer::Vocab Layer_Mime::get_param_vocab (  )  const [virtual]

Gets the paramater vocabulary.

Reimplemented from synfig::Layer.

String Layer_Mime::get_local_name (  )  const [virtual]

Returns a string containing the localized name of the Layer.

Reimplemented from synfig::Layer.


The documentation for this class was generated from the following files:
Generated on Wed Dec 12 03:11:42 2007 for synfig by  doxygen 1.5.4