synfig::Layer Class Reference

#include <layer.h>

Inheritance diagram for synfig::Layer:

List of all members.

Public Types
typedef Layer *(*	Factory )()
	Type that represents a pointer to a layer's constructor.
typedef std::map< String, BookEntry >	Book
typedef std::map< String, ValueBase >	ParamList
typedef etl::handle< Layer >	Handle
typedef etl::loose_handle< Layer >	LooseHandle
typedef etl::handle< const Layer >	ConstHandle
typedef std::map< String, etl::rhandle< ValueNode > >	DynamicParamList
typedef ParamVocab	Vocab
	A list type which describes all the parameters that a layer has.
Public Member Functions
sigc::signal< void > &	signal_status_changed ()
	Status Changed.
sigc::signal< void, String > &	signal_param_changed ()
	Parameter changed.
sigc::signal< void > &	signal_description_changed ()
	Description Changed.
sigc::signal< void, int, etl::handle< Canvas > > &	signal_moved ()
	Moved.
sigc::signal< void, String > &	signal_added_to_group ()
sigc::signal< void, String > &	signal_removed_from_group ()
virtual	~Layer ()
virtual void	on_canvas_set ()
void	add_to_group (const String &)
	Adds this layer to the given layer group.
void	remove_from_group (const String &)
	Removes this layer from the given layer group.
void	remove_from_all_groups ()
	Removes this layer from all layer groups.
String	get_group () const
	Gets the name of the group that this layer belongs to.
const DynamicParamList &	dynamic_param_list () const
bool	connect_dynamic_param (const String &param, etl::loose_handle< ValueNode >)
bool	disconnect_dynamic_param (const String &param)
void	enable ()
	Enables the layer for rendering (Making it active).
void	disable ()
	Disables the layer for rendering. (Making it inactive).
void	set_active (bool x)
	Sets the 'active' flag for the Layer to the state described by x.
bool	active () const
	Returns that status of the 'active' flag.
int	get_depth () const
	Returns the position of the layer in the canvas.
float	get_z_depth () const
float	get_z_depth (const synfig::Time &t) const
void	set_z_depth (float x)
void	set_canvas (etl::loose_handle< Canvas > canvas)
	Sets the Canvas that this Layer is a part of.
etl::loose_handle< Canvas >	get_canvas () const
	Returns a handle to the Canvas to which this Layer belongs.
const String &	get_description () const
void	set_description (const String &x)
virtual Rect	get_bounding_rect () const
virtual Rect	get_full_bounding_rect (Context context) const
virtual String	get_name () const
	Returns a string containing the name of the Layer.
virtual String	get_local_name () const
	Returns a string containing the localized name of the Layer.
virtual Vocab	get_param_vocab () const
	Gets the paramater vocabulary.
virtual String	get_version () const
	Gets the version string for this layer.
virtual etl::handle< Transform >	get_transform () const
virtual bool	set_version (const String &ver)
	Sets the virtual version to use for backwards-compatibility.
virtual void	reset_version ()
	Resets the virtual version.
virtual bool	set_param (const String &param, const ValueBase &value)
	Sets the parameter described by param to value.
virtual bool	set_param_list (const ParamList &)
	Sets a list of parameters.
virtual ValueBase	get_param (const String &param) const
	Get the value of the specified parameter.
virtual ParamList	get_param_list () const
	Get a list of all of the parameters and their values.
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 Color	get_color (Context context, const Point &point) const
	Gets the color of the Canvas at point.
virtual bool	accelerated_render (Context context, Surface *surface, int quality, const RendDesc &rend_desc, ProgressCallback *callback) const
	Renders the Canvas to the given Surface in an accelerated manner.
virtual Handle	hit_check (Context context, const Point &point) const
	Checks to see if a part of the layer is directly under point.
virtual Handle	clone (const GUID &deriv_guid=GUID()) const
	Duplicates the Layer.
virtual Layer *	simple_clone () const
	Duplicates the Layer without duplicating the value nodes.
Static Public Member Functions
static void	register_in_book (const BookEntry &)
static Book &	book ()
static bool	subsys_init ()
static bool	subsys_stop ()
static Layer::LooseHandle	create (const String &type)
	Creates a Layer of type type.
Protected Member Functions
	Layer ()
virtual void	on_changed ()
	This is called whenever a parameter is changed.
virtual void	get_times_vfunc (Node::time_set &set) const
	Called to figure out the animation time information.
Friends
class	ValueNode
class	Context
Classes
struct	BookEntry

---

Detailed Description

Todo:

writeme

See also:

Canvas

---

Member Typedef Documentation

typedef Layer*(* synfig::Layer::Factory)()

Type that represents a pointer to a layer's constructor.

typedef std::map<String,BookEntry> synfig::Layer::Book

typedef std::map<String,ValueBase> synfig::Layer::ParamList

typedef etl::handle<Layer> synfig::Layer::Handle

Reimplemented in synfig::Layer_Bitmap.

typedef etl::loose_handle<Layer> synfig::Layer::LooseHandle

typedef etl::handle<const Layer> synfig::Layer::ConstHandle

typedef std::map<String,etl::rhandle<ValueNode> > synfig::Layer::DynamicParamList

typedef ParamVocab synfig::Layer::Vocab

A list type which describes all the parameters that a layer has. See also: get_param_vocab()

---

Constructor & Destructor Documentation

Layer::Layer (   )  [protected]

synfig::Layer::~Layer (   )  [virtual]

---

Member Function Documentation

void Layer::register_in_book (  const BookEntry &   )  [static]

Layer::Book & Layer::book (   )  [static]

bool Layer::subsys_init (   )  [static]

bool Layer::subsys_stop (   )  [static]

sigc::signal<void>& synfig::Layer::signal_status_changed (   )  [inline]

Status Changed.

sigc::signal<void,String>& synfig::Layer::signal_param_changed (   )  [inline]

Parameter changed.

sigc::signal<void>& synfig::Layer::signal_description_changed (   )  [inline]

Description Changed.

sigc::signal<void, int, etl::handle<Canvas> >& synfig::Layer::signal_moved (   )  [inline]

Moved.

sigc::signal<void, String>& synfig::Layer::signal_added_to_group (   )  [inline]

sigc::signal<void, String>& synfig::Layer::signal_removed_from_group (   )  [inline]

void synfig::Layer::on_canvas_set (   )  [virtual]

Reimplemented in synfig::Layer_PasteCanvas.

void Layer::add_to_group (  const String &   )

Adds this layer to the given layer group.

void Layer::remove_from_group (  const String &   )

Removes this layer from the given layer group.

void Layer::remove_from_all_groups (   )

Removes this layer from all layer groups.

String Layer::get_group (   )  const

Gets the name of the group that this layer belongs to.

const DynamicParamList& synfig::Layer::dynamic_param_list (   )  const [inline]

xrefitem todo 55

bool Layer::connect_dynamic_param (  const String &  param, etl::loose_handle< ValueNode >  )

bool Layer::disconnect_dynamic_param (  const String &  param  )

void synfig::Layer::enable (   )  [inline]

Enables the layer for rendering (Making it active).

void synfig::Layer::disable (   )  [inline]

Disables the layer for rendering. (Making it inactive). When a layer is disabled, it will be skipped when the canvas is rendered.

void Layer::set_active (  bool  x  )

Sets the 'active' flag for the Layer to the state described by x. When a layer is disabled, it will be skipped when the canvas is rendered.

bool synfig::Layer::active (   )  const [inline]

Returns that status of the 'active' flag.

int Layer::get_depth (   )  const

Returns the position of the layer in the canvas. Returns negative on error

float synfig::Layer::get_z_depth (   )  const [inline]

Todo: This needs to be documented further.

float Layer::get_z_depth (  const synfig::Time &  t  )  const

Todo: This needs to be documented further.

void synfig::Layer::set_z_depth (  float  x  )  [inline]

Todo: This needs to be documented further.

void synfig::Layer::set_canvas (  etl::loose_handle< Canvas >  canvas  )

Sets the Canvas that this Layer is a part of.

etl::loose_handle< synfig::Canvas > synfig::Layer::get_canvas (   )  const

Returns a handle to the Canvas to which this Layer belongs.

const String& synfig::Layer::get_description (   )  const [inline]

Todo: This needs to be documented further.

void Layer::set_description (  const String &  x  )

Todo: This needs to be documented further.

Rect Layer::get_bounding_rect (   )  const [virtual]

Reimplemented in synfig::Layer_Bitmap, synfig::Layer_PasteCanvas, and synfig::Layer_Shape.

Rect Layer::get_full_bounding_rect (  Context  context  )  const [virtual]

Reimplemented in synfig::Layer_Composite.

String Layer::get_name (   )  const [virtual]

Returns a string containing the name of the Layer.

String Layer::get_local_name (   )  const [virtual]

Returns a string containing the localized name of the Layer. Reimplemented in synfig::Layer_Mime, and synfig::Layer_PasteCanvas.

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

Gets the paramater vocabulary. Reimplemented in synfig::Layer_Bitmap, synfig::Layer_Composite, synfig::Layer_Mime, synfig::Layer_MotionBlur, synfig::Layer_PasteCanvas, synfig::Layer_Polygon, synfig::Layer_Shape, and synfig::Layer_SolidColor.

String Layer::get_version (   )  const [virtual]

Gets the version string for this layer. Reimplemented in synfig::Layer_Mime.

etl::handle< Transform > Layer::get_transform (   )  const [virtual]

Todo: This needs to be documented further.

bool Layer::set_version (  const String &  ver  )  [virtual]

Sets the virtual version to use for backwards-compatibility. See also: reset_version() Reimplemented in synfig::Layer_Mime.

void Layer::reset_version (   )  [virtual]

Resets the virtual version. See also: set_version()

bool Layer::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 in synfig::Layer_Composite, synfig::Layer_Mime, synfig::Layer_MotionBlur, synfig::Layer_PasteCanvas, synfig::Layer_Polygon, synfig::Layer_Shape, and synfig::Layer_SolidColor.

bool Layer::set_param_list (  const ParamList &   )  [virtual]

Sets a list of parameters.

ValueBase Layer::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 in synfig::Layer_Bitmap, synfig::Layer_Composite, synfig::Layer_Mime, synfig::Layer_MotionBlur, synfig::Layer_PasteCanvas, synfig::Layer_Polygon, synfig::Layer_Shape, and synfig::Layer_SolidColor.

Layer::ParamList Layer::get_param_list (   )  const [virtual]

Get a list of all of the parameters and their values.

void Layer::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 in synfig::Layer_MotionBlur, and synfig::Layer_PasteCanvas.

void Layer::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 refering to next Layer. time  writeme point  writeme See also: Handle::set_time() Todo: point should be of the type const Point & Reimplemented in synfig::Layer_MotionBlur.

Color Layer::get_color (  Context  context, const Point &  point )  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 in synfig::Layer_Bitmap, synfig::Layer_Mime, synfig::Layer_MotionBlur, synfig::Layer_PasteCanvas, synfig::Layer_Shape, and synfig::Layer_SolidColor.

bool Layer::accelerated_render (  Context  context, Surface *  surface, int  quality, const RendDesc &  rend_desc, ProgressCallback *  callback )  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 in synfig::Layer_Bitmap, synfig::Layer_Composite, synfig::Layer_Mime, synfig::Layer_MotionBlur, synfig::Layer_PasteCanvas, synfig::Layer_Shape, and synfig::Layer_SolidColor.

synfig::Layer::Handle Layer::hit_check (  Context  context, const 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 in synfig::Layer_Bitmap, synfig::Layer_PasteCanvas, synfig::Layer_Shape, and synfig::Layer_SolidColor.

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

Duplicates the Layer.

Layer * Layer::simple_clone (   )  const [virtual]

Duplicates the Layer without duplicating the value nodes.

void Layer::on_changed (   )  [protected, virtual]

This is called whenever a parameter is changed. Reimplemented from synfig::Node.

void Layer::get_times_vfunc (  Node::time_set &  set  )  const [protected, virtual]

Called to figure out the animation time information. Implements synfig::Node. Reimplemented in synfig::Layer_PasteCanvas.

Layer::LooseHandle synfig::Layer::create (  const String &  type  )  [static]

Creates a Layer of type type. If the Layer type is unknown, then a Mime layer is created in its place. Parameters: type  A string describing the name of the layer to construct. Returns: Always returns a handle to a new Layer. See also: Mime

---

Friends And Related Function Documentation

friend class ValueNode [friend]

friend class Context [friend]

---

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

• layer.h
• layer.cpp

---