synfig::Canvas Class Reference

#include <canvas.h>

Inheritance diagram for synfig::Canvas:

List of all members.

Public Types
typedef etl::handle < Canvas >	Handle
typedef etl::loose_handle < Canvas >	LooseHandle
typedef etl::handle < const Canvas >	ConstHandle
typedef std::list < Handle >	Children
Public Member Functions
sigc::signal< void, String, etl::handle < synfig::Layer > > &	signal_group_pair_added ()
sigc::signal< void, String, etl::handle < synfig::Layer > > &	signal_group_pair_removed ()
sigc::signal< void, String > &	signal_group_added ()
	Group Added.
sigc::signal< void, String > &	signal_group_removed ()
	Group Removed.
sigc::signal< void, String > &	signal_group_changed ()
	Group Changed.
sigc::signal< void, int * > &	signal_layers_reordered ()
	Layers Reordered.
sigc::signal< void > &	signal_rend_desc_changed ()
	RendDesc Changed.
sigc::signal< void > &	signal_id_changed ()
	ID Changed.
sigc::signal< void > &	signal_file_name_changed ()
	File name Changed.
sigc::signal< void, String > &	signal_meta_data_changed ()
	Metadata Changed.
sigc::signal< void > &	signal_meta_data_changed (const String &key)
	Metadata Changed.
sigc::signal< void, etl::handle < ValueNode > > &	signal_value_node_changed ()
sigc::signal< void > &	signal_dirty ()
	Dirty.
sigc::signal< void, etl::handle < ValueNode >, etl::handle < ValueNode > > &	signal_value_node_child_added ()
sigc::signal< void, etl::handle < ValueNode >, etl::handle < ValueNode > > &	signal_value_node_child_removed ()
	~Canvas ()
std::set < etl::handle< Layer > >	get_layers_in_group (const String &group)
	Returns the set of layers in group.
std::set< String >	get_groups () const
	Gets all the groups.
int	get_group_count () const
	Gets the number of groups in this canvas.
void	rename_group (const String &old_name, const String &new_name)
	Renames the given group.
bool	is_inline () const
RendDesc &	rend_desc ()
	Returns a handle to the RendDesc for this Canvas.
const RendDesc &	rend_desc () const
	Returns a handle to the RendDesc for this Canvas.
const String &	get_name () const
	Gets the name of the canvas.
void	set_name (const String &x)
	Sets the name of the canvas.
const String &	get_author () const
	Gets the author of the canvas.
void	set_author (const String &x)
	Sets the author of the canvas.
const String &	get_description () const
	Gets the description of the canvas.
void	set_description (const String &x)
	Sets the name of the canvas.
const String &	get_id () const
	Gets the ID of the canvas.
void	set_id (const String &x)
	Sets the ID of the canvas.
String	get_meta_data (const String &key) const
	Returns the data string for the given meta data key.
std::list< String >	get_meta_data_keys () const
	Returns a list of meta data keys.
void	set_meta_data (const String &key, const String &data)
	Sets a meta data key to a specific string.
void	erase_meta_data (const String &key)
	Removes a meta data key.
String	get_relative_id (etl::loose_handle< const Canvas > x) const
String	_get_relative_id (etl::loose_handle< const Canvas > x) const
	For internal use only.
bool	is_root () const
	Returns true if the Canvas is a root Canvas. false otherwise.
LooseHandle	parent () const
	Returns a handle to the parent Canvas.
LooseHandle	get_root () const
std::list< Handle > &	children ()
	Returns a list of all child canvases in this canvas.
const std::list < Handle > &	children () const
	Returns a list of all child canvases in this canvas.
void	set_time (Time t) const
	Gets the color at the specified point.
Time	get_time () const
int	size () const
	Returns the number of layers in the canvas.
void	clear ()
	Removes all the layers from the canvas.
bool	empty () const
	Returns true if the canvas has no layers.
const ValueNodeList &	value_node_list () const
	Returns a reference to the ValueNodeList for this Canvas.
KeyframeList &	keyframe_list ()
	Returns a reference to the KeyframeList for this Canvas.
const KeyframeList &	keyframe_list () const
	Returns a reference to the KeyframeList for this Canvas.
ValueNode::Handle	find_value_node (const String &id)
	Finds the ValueNode in the Canvas with the given id.
ValueNode::Handle	surefind_value_node (const String &id)
	For internal use only.
ValueNode::ConstHandle	find_value_node (const String &id) const
	Finds the ValueNode in the Canvas with the given id.
void	add_value_node (ValueNode::Handle x, const String &id)
void	remove_value_node (ValueNode::Handle x)
	writeme
void	remove_value_node (const String &id)
Handle	surefind_canvas (const String &id)
	Finds a child Canvas in the Canvas with the given name.
Handle	find_canvas (const String &id)
	Finds a child Canvas in the Canvas with the given id.
ConstHandle	find_canvas (const String &id) const
	Finds a child Canvas in the Canvas with the given id.
String	get_file_path () const
	Sets the file path for the Canvas.
void	set_file_name (const String &)
	Sets the filename (with path).
String	get_file_name () const
	Gets the filename (with path).
Handle	new_child_canvas ()
	Creates a new child canvas, and returns its handle.
Handle	new_child_canvas (const String &id)
	Creates a new child canvas with an ID of id, and returns its handle.
Handle	add_child_canvas (Handle child_canvas, const String &id)
	Adds the given canvas as a child.
void	remove_child_canvas (Handle child_canvas)
etl::handle< Layer >	find_layer (const Point &pos)
int	get_depth (etl::handle< Layer >) const
Context	get_context () const
iterator	end ()
const_iterator	end () const
reverse_iterator	rbegin ()
const_reverse_iterator	rbegin () const
etl::handle< Layer > &	back ()
void	push_back (etl::handle< Layer > x)
void	push_front (etl::handle< Layer > x)
void	push_back_simple (etl::handle< Layer > x)
void	insert (iterator iter, etl::handle< Layer > x)
void	erase (iterator iter)
const etl::handle < Layer > &	back () const
void	set_inline (LooseHandle parent)
Handle	clone (const GUID &deriv_guid=GUID()) const
Static Public Member Functions
static Handle	create ()
static Handle	create_inline (Handle parent)
Protected Member Functions
	Canvas (const String &name)
virtual void	on_changed ()
virtual void	get_times_vfunc (Node::time_set &set) const
Friends
void	optimize_layers (Context, Canvas::Handle)

---

Detailed Description

Todo:

writeme

---

Member Typedef Documentation

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

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

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

typedef std::list<Handle> synfig::Canvas::Children

---

Constructor & Destructor Documentation

synfig::Canvas::Canvas

(

const String &

name

)

[protected]

Canvas::~Canvas

(

)

---

Member Function Documentation

sigc::signal<void,String,etl::handle<synfig::Layer> >& synfig::Canvas::signal_group_pair_added

(

)

[inline]

sigc::signal<void,String,etl::handle<synfig::Layer> >& synfig::Canvas::signal_group_pair_removed

(

)

[inline]

sigc::signal<void,String>& synfig::Canvas::signal_group_added

(

)

[inline]

Group Added.

sigc::signal<void,String>& synfig::Canvas::signal_group_removed

(

)

[inline]

Group Removed.

sigc::signal<void,String>& synfig::Canvas::signal_group_changed

(

)

[inline]

Group Changed.

sigc::signal<void,int*>& synfig::Canvas::signal_layers_reordered

(

)

[inline]

Layers Reordered.

sigc::signal<void>& synfig::Canvas::signal_rend_desc_changed

(

)

[inline]

RendDesc Changed.

sigc::signal<void>& synfig::Canvas::signal_id_changed

(

)

[inline]

ID Changed.

sigc::signal< void > & Canvas::signal_file_name_changed

(

)

File name Changed.

sigc::signal<void, String>& synfig::Canvas::signal_meta_data_changed

(

)

[inline]

Metadata Changed.

sigc::signal<void>& synfig::Canvas::signal_meta_data_changed

(

const String &

key

)

[inline]

Metadata Changed.

sigc::signal<void, etl::handle<ValueNode> >& synfig::Canvas::signal_value_node_changed

(

)

[inline]

sigc::signal<void>& synfig::Canvas::signal_dirty

(

)

[inline]

Dirty.

sigc::signal<void, etl::handle<ValueNode>, etl::handle<ValueNode> >& synfig::Canvas::signal_value_node_child_added

(

)

[inline]

Todo:

This needs to be documented further.

sigc::signal<void, etl::handle<ValueNode>, etl::handle<ValueNode> >& synfig::Canvas::signal_value_node_child_removed

(

)

[inline]

Todo:

This needs to be documented further.

std::set< etl::handle< Layer > > Canvas::get_layers_in_group

(

const String &

group

)

Returns the set of layers in group.

std::set< String > Canvas::get_groups

(

)

const

Gets all the groups.

int Canvas::get_group_count

(

)

const

Gets the number of groups in this canvas.

void Canvas::rename_group	(	const String &	old_name,
		const String &	new_name
	)

Renames the given group.

bool synfig::Canvas::is_inline

(

)

const [inline]

Todo:

This needs to be documented further.

RendDesc& synfig::Canvas::rend_desc

(

)

[inline]

Returns a handle to the RendDesc for this Canvas.

const RendDesc& synfig::Canvas::rend_desc

(

)

const [inline]

Returns a handle to the RendDesc for this Canvas.

const String& synfig::Canvas::get_name

(

)

const [inline]

Gets the name of the canvas.

void Canvas::set_name

(

const String &

x

)

Sets the name of the canvas.

const String& synfig::Canvas::get_author

(

)

const [inline]

Gets the author of the canvas.

void Canvas::set_author

(

const String &

x

)

Sets the author of the canvas.

const String& synfig::Canvas::get_description

(

)

const [inline]

Gets the description of the canvas.

void Canvas::set_description

(

const String &

x

)

Sets the name of the canvas.

const String& synfig::Canvas::get_id

(

)

const [inline]

Gets the ID of the canvas.

void Canvas::set_id

(

const String &

x

)

Sets the ID of the canvas.

String Canvas::get_meta_data

(

const String &

key

)

const

Returns the data string for the given meta data key.

std::list< String > Canvas::get_meta_data_keys

(

)

const

Returns a list of meta data keys.

void Canvas::set_meta_data	(	const String &	key,
		const String &	data
	)

Sets a meta data key to a specific string.

void Canvas::erase_meta_data

(

const String &

key

)

Removes a meta data key.

String Canvas::get_relative_id

(

etl::loose_handle< const Canvas >

x

)

const

Todo:

This needs to be documented further.

String Canvas::_get_relative_id

(

etl::loose_handle< const Canvas >

x

)

const

For internal use only.

Todo:

This needs to be documented further.

bool synfig::Canvas::is_root

(

)

const [inline]

Returns true if the Canvas is a root Canvas. false otherwise.

LooseHandle synfig::Canvas::parent

(

)

const [inline]

Returns a handle to the parent Canvas.

The returned handle will be empty if this is a root canvas

Canvas::LooseHandle Canvas::get_root

(

)

const

std::list<Handle>& synfig::Canvas::children

(

)

[inline]

Returns a list of all child canvases in this canvas.

const std::list<Handle>& synfig::Canvas::children

(

)

const [inline]

Returns a list of all child canvases in this canvas.

void Canvas::set_time

(

Time

t

)

const

Gets the color at the specified point.

Sets the time for all the layers in the canvas

Time synfig::Canvas::get_time

(

)

const [inline]

Todo:

This needs to be documented further.

int Canvas::size

(

)

const

Returns the number of layers in the canvas.

void Canvas::clear

(

)

Removes all the layers from the canvas.

bool Canvas::empty

(

)

const

Returns true if the canvas has no layers.

const ValueNodeList & Canvas::value_node_list

(

)

const

Returns a reference to the ValueNodeList for this Canvas.

Returns a reference to the ValueNodeList for this Canvas

KeyframeList & Canvas::keyframe_list

(

)

Returns a reference to the KeyframeList for this Canvas.

const KeyframeList & Canvas::keyframe_list

(

)

const

Returns a reference to the KeyframeList for this Canvas.

ValueNode::Handle Canvas::find_value_node

(

const String &

id

)

Finds the ValueNode in the Canvas with the given id.

Returns:

If found, returns a handle to the ValueNode. Otherwise, returns an empty handle.

ValueNode::Handle Canvas::surefind_value_node

(

const String &

id

)

For internal use only.

Todo:

This needs to be documented further.

ValueNode::ConstHandle Canvas::find_value_node

(

const String &

id

)

const

Finds the ValueNode in the Canvas with the given id.

Returns:

If found, returns a handle to the ValueNode. Otherwise, returns an empty handle.

void Canvas::add_value_node	(	ValueNode::Handle	x,
		const String &	id
	)

Todo:

This needs to be documented further.

void Canvas::remove_value_node

(

ValueNode::Handle

x

)

writeme

Todo:

This needs to be documented further.

void synfig::Canvas::remove_value_node

(

const String &

id

)

[inline]

Todo:

This needs to be documented further.

etl::handle< Canvas > Canvas::surefind_canvas

(

const String &

id

)

Finds a child Canvas in the Canvas with the given name.

Returns:

If found, returns a handle to the child Canvas. If not found, it creates a new Canvas and returns it If an error occurs, it returns an empty handle

Todo:

This needs a lot more optimization

Canvas::Handle Canvas::find_canvas

(

const String &

id

)

Finds a child Canvas in the Canvas with the given id.

Returns:

If found, returns a handle to the child Canvas. Otherwise, returns an empty handle.

Canvas::ConstHandle Canvas::find_canvas

(

const String &

id

)

const

Finds a child Canvas in the Canvas with the given id.

Returns:

If found, returns a handle to the child Canvas. Otherwise, returns an empty handle.

Todo:

This needs a lot more optimization

String Canvas::get_file_path

(

)

const

Sets the file path for the Canvas.

Returns the file path from the file name

void Canvas::set_file_name

(

const String &

file_name

)

Sets the filename (with path).

String Canvas::get_file_name

(

)

const

Gets the filename (with path).

Canvas::Handle Canvas::new_child_canvas

(

)

Creates a new child canvas, and returns its handle.

Canvas::Handle Canvas::new_child_canvas

(

const String &

id

)

Creates a new child canvas with an ID of id, and returns its handle.

Canvas::Handle Canvas::add_child_canvas	(	Canvas::Handle	child_canvas,
		const String &	id
	)

Adds the given canvas as a child.

void Canvas::remove_child_canvas

(

Canvas::Handle

child_canvas

)

etl::handle< Layer > Canvas::find_layer

(

const Point &

pos

)

int Canvas::get_depth

(

etl::handle< Layer >

layer

)

const

Context Canvas::get_context

(

)

const

Canvas::iterator Canvas::end

(

)

Canvas::const_iterator Canvas::end

(

)

const

Canvas::reverse_iterator Canvas::rbegin

(

)

Canvas::const_reverse_iterator Canvas::rbegin

(

)

const

Layer::Handle & Canvas::back

(

)

void Canvas::push_back

(

etl::handle< Layer >

x

)

void Canvas::push_front

(

etl::handle< Layer >

x

)

void Canvas::push_back_simple

(

etl::handle< Layer >

x

)

void Canvas::insert	(	iterator	iter,
		etl::handle< Layer >	x
	)

void synfig::Canvas::erase

(

iterator

iter

)

const Layer::Handle & Canvas::back

(

)

const

void Canvas::set_inline

(

LooseHandle

parent

)

Canvas::Handle Canvas::create

(

)

[static]

Canvas::Handle Canvas::create_inline

(

Handle

parent

)

[static]

Canvas::Handle Canvas::clone

(

const GUID &

deriv_guid = GUID()

)

const

void Canvas::on_changed

(

)

[protected, virtual]

Reimplemented from synfig::Node.

void Canvas::get_times_vfunc

(

Node::time_set &

set

)

const [protected, virtual]

Function to be overloaded that fills

Implements synfig::Node.

---

Friends And Related Function Documentation

void optimize_layers	(	Context	,
		Canvas::Handle
	)			[friend]

---

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

• canvas.h
• canvas.cpp

---