synfig::Layer_Polygon Class Reference

writeme More...

#include <layer_polygon.h>

Inheritance diagram for synfig::Layer_Polygon:

List of all members.

Public Member Functions
	~Layer_Polygon ()
void	add_polygon (const std::vector< Point > &point_list)
	Adds a polygon to the layer.
void	clear ()
	Clears out any polygon data.
void	sync ()
	Updates EdgeTable so it will reflect the parameter data.
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 Vocab	get_param_vocab () const
	Gets the paramater vocabulary.
Protected Member Functions
	Layer_Polygon ()

---

Detailed Description

writeme

Todo:

This layer needs to support multiple polygons

---

Constructor & Destructor Documentation

Layer_Polygon::Layer_Polygon

(

)

[protected]

Layer_Polygon::~Layer_Polygon

(

)

---

Member Function Documentation

void synfig::Layer_Polygon::add_polygon

(

const std::vector< Point > &

point_list

)

Adds a polygon to the layer.

The edge data is automaticly added to the EdgeTable, so there is no need to call sync() after adding a polygon using this function.

Parameters:

point_list

A list containing the points that define the polygon's parameter.

void Layer_Polygon::clear

(

)

Clears out any polygon data.

Also clears out the EdgeTable, so there is no need to call sync() after using this function.

Reimplemented from synfig::Layer_Shape.

void Layer_Polygon::sync

(

)

Updates EdgeTable so it will reflect the parameter data.

bool Layer_Polygon::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_Shape.

ValueBase Layer_Polygon::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_Shape.

Layer::Vocab Layer_Polygon::get_param_vocab

(

)

const [virtual]

Gets the paramater vocabulary.

Reimplemented from synfig::Layer_Shape.

---

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

• layer_polygon.h
• layer_polygon.cpp

---