Synfig Studio :: Documentation - User contributions [en]

Dev:GoogleSoC/Ideas

2012-03-07T10:12:52Z

Nikitakit:

== Cairo-based renderer ==
Synfig currently provides a custom software renderer, which is is not able to take advantage of advanced optimization and hardware acceleration techniques. Porting the renderer to the Cairo graphics library will allow for a faster, more versatile framework.
* {{L|Dev:Cairo_render_migration|Cairo migration plan}}
== Single-Window UI ==
Condense the Synfig user interface into a single window to provide a simpler, easier workflow for animators.
* [http://synfig.org/forums/viewtopic.php?f=14&t=3248 Single-window UI Brainstorm]
== Sound Support ==
Synfig currently lacks support for importing sound clips and synchronizing them with the animation. This project would consist of selecting an appropriate audio framework (e.g. gstreamer), integrating it into Synfig, and providing a suitable user interface to synchronize sound and animation.
* {{L|Dev:Sound_Layer|Sound Layer Proposal}}
== Bones GUI ==
Support for bones was added in a separate branch of Synfig, but it currently lacks a good user interface. This project would involve writing a GUI to edit bones and integrating it into the current development branch of Synfig.
* [http://synfig.org/forums/viewtopic.php?f=14&t=311 Bones GUI]

Dev:GoogleSoC/ApplicationForm

2012-03-07T09:43:55Z

Nikitakit: Logs on separate line

Questions from http://www.google-melange.com/gsoc/org/application/google/gsoc2012 (needs registration)

* '''Organization name:'''
** Synfig

* '''Organization description:'''
** We are a community of developers and animators focused on the development of Synfig Studio, a 2D vector animation program aiming to improve artistic workflow by focusing on tweening and interpolation. We work together to refine and add new features to the Synfig software, create tutorials, and run challenges to help and inspire our artists.

* '''Organization home page url:'''
** http://synfig.org/

* '''Main organization License:'''
** GNU GPL v2 or later.

* '''What is the URL for your Ideas page?'''
** http://wiki.synfig.org/wiki/Dev:GoogleSoC/Ideas

* '''What is the main IRC channel for your organization?'''
** #synfig on irc.freenode.net
** Logs are available at: http://dooglus.rincevent.net/synfig/logs

* '''What is the main development mailing list for your organization?'''
** http://lists.sourceforge.net/lists/listinfo/synfig-devl

* '''Why is your organization applying to participate in Google Summer of Code 2012? What do you hope to gain by participating?'''
** We hope to attract new and enthusiastic developers to the project.

* '''Did your organization participate in past Google Summer of Codes? If so, please summarize your involvement and the successes and challenges of your participation.'''
** Our organization has not participated in any past GSoCs.

* '''If your organization has not previously participated in Google Summer of Code, have you applied in the past? If so, for what year(s)?'''
** We applied to GSoC in 2008 and 2010.

* '''Does your organization have an application template you would like to see students use? If so, please provide it now.'''
** http://wiki.synfig.org/wiki/Dev:GoogleSoC/StudentApplicationTemplate

* '''What criteria did you use to select your mentors for this year's program? Please be as specific as possible.'''
** For our mentors, we have selected the most motivated and consistent contributors to the project who have extensive knowledge of specific areas of the Synfig Studio source code.
** Mentor: Carlos López González, Lead Developer

* '''What is your plan for dealing with disappearing students?'''
** We ask students to provide their email and phone number to the project administrator. Our mentors will maintain regular contact with students throughout the summer and let them know that we are always available to answer questions and provide guidance. If a student disappears without notice, the mentor will contact him/her via email to clarify the situation. If there is no reply within 3 days, the administrator will phone him/her personally. If the student cannot be reached, the administrator will contact Google and report the situation.

* '''What is your plan for dealing with disappearing mentors?'''
** Our backup mentor will be available throughout the summer to provide additional support for students, and will be able to fill in for the primary mentor if he is unavailable. In the case of an emergency, or if the mentor disappears and the project administrator fails contact him by phone, the backup mentor will fully take over his responsibilities.

* '''What steps will you take to encourage students to interact with your project's community before, during and after the program?'''
** We want to have students who are active with the project before the application process begins. We ask potential students to introduce themselves on the project mailing list and forums and to speak with some of our developers and animators. We will treat them as any new member of our community and help them learn how the project works, and we will answer any questions they may have.
** As part of our application process, we require that students are able to compile and run Synfig, and we ask them to submit several patches or pull requests and any artwork made in Synfig that they want to share. Those who show active involvement and eagerness to participate will be favored for acceptance into the program, and we believe that enthusiastic students will choose to stay after the summer is over.
** Once a student's code is reviewed and critiqued, we will strive to integrate it into a new release of Synfig. If students see the tangible impact of their work over the summer, they will be more motivated to remain a part of our community after GSoC is over.

* '''Are you a new organization who has a Googler or other organization to vouch for you? If so, please list their name(s) here.'''
** N.A.

* '''Are you an established or larger organization who would like to vouch for a new organization applying this year? If so, please list their name(s) here.'''
** N.A.

Dev:GoogleSoC/ApplicationForm

2012-03-07T09:41:18Z

Nikitakit: Proofread and small edits

Questions from http://www.google-melange.com/gsoc/org/application/google/gsoc2012 (needs registration)

* '''Organization name:'''
** Synfig

* '''Organization description:'''
** We are a community of developers and animators focused on the development of Synfig Studio, a 2D vector animation program aiming to improve artistic workflow by focusing on tweening and interpolation. We work together to refine and add new features to the Synfig software, create tutorials, and run challenges to help and inspire our artists.

* '''Organization home page url:'''
** http://synfig.org/

* '''Main organization License:'''
** GNU GPL v2 or later.

* '''What is the URL for your Ideas page?'''
** http://wiki.synfig.org/wiki/Dev:GoogleSoC/Ideas

* '''What is the main IRC channel for your organization?'''
** #synfig on irc.freenode.net Logs: http://dooglus.rincevent.net/synfig/logs

* '''What is the main development mailing list for your organization?'''
** http://lists.sourceforge.net/lists/listinfo/synfig-devl

* '''Why is your organization applying to participate in Google Summer of Code 2012? What do you hope to gain by participating?'''
** We hope to attract new and enthusiastic developers to the project.

* '''Did your organization participate in past Google Summer of Codes? If so, please summarize your involvement and the successes and challenges of your participation.'''
** Our organization has not participated in any past GSoCs.

* '''If your organization has not previously participated in Google Summer of Code, have you applied in the past? If so, for what year(s)?'''
** We applied to GSoC in 2008 and 2010.

* '''Does your organization have an application template you would like to see students use? If so, please provide it now.'''
** http://wiki.synfig.org/wiki/Dev:GoogleSoC/StudentApplicationTemplate

* '''What criteria did you use to select your mentors for this year's program? Please be as specific as possible.'''
** For our mentors, we have selected the most motivated and consistent contributors to the project who have extensive knowledge of specific areas of the Synfig Studio source code.
** Mentor: Carlos López González, Lead Developer

* '''What is your plan for dealing with disappearing students?'''
** We ask students to provide their email and phone number to the project administrator. Our mentors will maintain regular contact with students throughout the summer and let them know that we are always available to answer questions and provide guidance. If a student disappears without notice, the mentor will contact him/her via email to clarify the situation. If there is no reply within 3 days, the administrator will phone him/her personally. If the student cannot be reached, the administrator will contact Google and report the situation.

* '''What is your plan for dealing with disappearing mentors?'''
** Our backup mentor will be available throughout the summer to provide additional support for students, and will be able to fill in for the primary mentor if he is unavailable. In the case of an emergency, or if the mentor disappears and the project administrator fails contact him by phone, the backup mentor will fully take over his responsibilities.

* '''What steps will you take to encourage students to interact with your project's community before, during and after the program?'''
** We want to have students who are active with the project before the application process begins. We ask potential students to introduce themselves on the project mailing list and forums and to speak with some of our developers and animators. We will treat them as any new member of our community and help them learn how the project works, and we will answer any questions they may have.
** As part of our application process, we require that students are able to compile and run Synfig, and we ask them to submit several patches or pull requests and any artwork made in Synfig that they want to share. Those who show active involvement and eagerness to participate will be favored for acceptance into the program, and we believe that enthusiastic students will choose to stay after the summer is over.
** Once a student's code is reviewed and critiqued, we will strive to integrate it into a new release of Synfig. If students see the tangible impact of their work over the summer, they will be more motivated to remain a part of our community after GSoC is over.

* '''Are you a new organization who has a Googler or other organization to vouch for you? If so, please list their name(s) here.'''
** N.A.

* '''Are you an established or larger organization who would like to vouch for a new organization applying this year? If so, please list their name(s) here.'''
** N.A.

Dev:GoogleSoC/ApplicationForm

2012-03-07T09:19:52Z

Nikitakit: Change answer to question about dealing with disappearing students

Questions from http://www.google-melange.com/gsoc/org/application/google/gsoc2012 (needs registration)

* '''Organization name:'''
** Synfig

* '''Organization description:'''
** We are a community of developers and animators focused on development of Synfig Studio, a 2D vector animation program aiming to improve artistic workflow by focusing on tweening and interpolation. We work together to refine and add new features to the Synfig software, create tutorials, and run challenges to help and inspire our artists.

* '''Organization home page url:'''
** http://synfig.org/

* '''Main organization License:'''
** GNU GPL v2 or later.

* '''What is the URL for your Ideas page?'''
** http://wiki.synfig.org/wiki/Dev:GoogleSoC/Ideas

* '''What is the main IRC channel for your organization?'''
** #synfig on irc.freenode.net Logs: http://dooglus.rincevent.net/synfig/logs

* '''What is the main development mailing list for your organization?'''
** http://lists.sourceforge.net/lists/listinfo/synfig-devl

* '''Why is your organization applying to participate in Google Summer of Code 2012? What do you hope to gain by participating?'''
** We hope to attract new and enthusiastic developers to the project.

* '''Did your organization participate in past Google Summer of Codes? If so, please summarize your involvement and the successes and challenges of your participation.'''
** Our organization has not participated in any past GSoCs.

* '''If your organization has not previously participated in Google Summer of Code, have you applied in the past? If so, for what year(s)?'''
** We applied to GSoC in 2008 and 2010.

* '''Does your organization have an application template you would like to see students use? If so, please provide it now.'''
** http://wiki.synfig.org/wiki/Dev:GoogleSoC/StudentApplicationTemplate

* '''What criteria did you use to select your mentors for this year's program? Please be as specific as possible.'''
** For our mentors, we have selected the most motivated and consistent contributors to the project who have extensive knowledge of specific areas of the Synfig Studio source code. Mentor: Carlos López González, Lead Developer

* '''What is your plan for dealing with disappearing students?'''
** We ask students to provide their email and phone number to the project administrator. Our mentors will maintain regular contact with students throughout the summer and let them know that we are always available to answer questions and provide guidance. If a student disappears without notice, the mentor will contact him/her via email to clarify the situation. If there is no reply within 3 days, the administrator will phone him/her personally. If the student cannot be reached, the administrator will contact Google and report the situation.

* '''What is your plan for dealing with disappearing mentors?'''
** Our backup mentor will be available throughout the summer to provide additional support for students, and will be able to fill in for the primary mentor if he is unavailable. In the case of an emergency, or if the mentor disappears and the project administrator fails contact him by phone, the backup mentor will fully take over his responsibilities.

* '''What steps will you take to encourage students to interact with your project's community before, during and after the program?'''
** We want to have students who are active with the project before the application process begins. We ask potential students to introduce themselves on the project mailing list and forums and they would get to talk with some of our developers and animators. We will treat them as any new member of our community and help them learn how the project works, and we will answer any questions they may have.
As part of our application process, we require that students are able to compile and run Synfig, and we ask them to submit several patches or pull requests and any artwork made in Synfig that they want to share. Those that have shown active involvement and eagerness to participate will be favored for acceptance into the program, and we believe that the enthusiastic students will choose to stay after the summer is over.
Once a student's code is reviewed and critiqued, we will strive to integrate it into a new release of Synfig. If students see the tangible impact of their work over the summer, they will be more motivated to remain a part of our community after GSoC is over.

* '''Are you a new organization who has a Googler or other organization to vouch for you? If so, please list their name(s) here.'''
** No, we're not.

* '''Are you an established or larger organization who would like to vouch for a new organization applying this year? If so, please list their name(s) here.'''
** N.A.

Dev:GoogleSoC/StudentApplicationTemplate

2012-03-07T09:08:09Z

Nikitakit: capitalize Internet

== Name and Contact Information ==
*'''Full Name'''
*'''Email'''
*'''Phone number''' ''Please provide your phone number, with country code. We will only call you if we cannot reach you through other means (e.g. if, at some point, you are in an area without Internet access.)''
*'''IRC nick and forum username'''

== Project Idea ==
* What project idea do you propose to implement?
* What is your planned schedule for the project? Please list any tasks/milestones, and when you intend to complete them.

== Questions ==
* Have you used Synfig or other animation software? If so, for what kind of tasks?
* Have you been involved with Synfig or any other open source projects? If so, please describe your contributions.
* What past experience do you have with programming in C++?
* Please describe any plans you have over the summer in addition to GSoC (vacation, classes, summer job, etc.)

Dev:GoogleSoC/ApplicationForm

2012-03-06T11:33:36Z

Nikitakit: Proofread

Questions from http://www.google-melange.com/gsoc/org/application/google/gsoc2012 (needs registration)

* '''Organization name:'''
** Synfig

* '''Organization description:'''
** We are a community of developers and animators centered around Synfig Studio, a 2D vector animation program aiming to improve artistic workflow by focusing on tweening and interpolation. We work together to refine and add new features to the Synfig software, and create tutorials and run challenges to help and inspire our artists.

* '''Organization home page url:'''
** http://synfig.org/

* '''Main organization License:'''
** GNU GPL v2 or later.

* '''What is the URL for your Ideas page?'''
** http://wiki.synfig.org/wiki/Dev:GoogleSoC/Ideas

* '''What is the main IRC channel for your organization?'''
** #synfig on irc.freenode.net Logs: http://dooglus.rincevent.net/synfig/logs

* '''What is the main development mailing list for your organization?'''
** http://lists.sourceforge.net/lists/listinfo/synfig-devl

* '''Why is your organization applying to participate in Google Summer of Code 2012? What do you hope to gain by participating?'''
** We hope to attract new and enthusiastic developers to the project.

* '''Did your organization participate in past Google Summer of Codes? If so, please summarize your involvement and the successes and challenges of your participation.'''
** Our organization has not participated in any past GSoCs.

* '''If your organization has not previously participated in Google Summer of Code, have you applied in the past? If so, for what year(s)?'''
** We applied to GSoC in 2008 and 2010.

* '''Does your organization have an application template you would like to see students use? If so, please provide it now.'''
** http://wiki.synfig.org/wiki/Dev:GoogleSoC/StudentApplicationTemplate

* '''What criteria did you use to select your mentors for this year's program? Please be as specific as possible.'''
** For our mentors, we have selected the most motivated and consistent contributors to the project who extensive knowledge of specific areas of the Synfig Studio source code. Mentor: Carlos López González, Lead Developer

* '''What is your plan for dealing with disappearing students?'''
** We ask students to provide their email and phone number to the project administrator. If a student disappears without notice, the mentor will contact him/her via email to clarify the situation. If there is no reply within 3 days, the administrator will phone him/her personally. If the student cannot be reached, the administrator will contact Google and report the situation.

* '''What is your plan for dealing with disappearing mentors?'''
** Our backup mentor will be available throughout the summer to provide additional support for students, and will be able to fill in for the primary mentor if he is unavailable. In the case of an emeregency, or if the mentor is disappears and the project administrator fails contact him by phone, the backup mentor will fully take over his responsibilities.

* '''What steps will you take to encourage students to interact with your project's community before, during and after the program?'''
** We want students who are active with the project before the application process begins. We ask potential students to introduce themselves on the project mailing list and forums and get to talk with some of our developers and animators. We will treat them as any new member of our community and help them learn the project and answer any questions they may have.
As part of our application process, we require that students are able to compile and run Synfig and ask them to submit several patches or pull requests, and any artwork made in Synfig that they want to share. Those that have shown active envolvement and eagerness to participated will be favored for acceptance into the program, and we believe that the enthusiastic students will stay after the summer is over.
Once a student's code is reviewed and critiqued, we will strive to integrate it into a new release of Synfig. If students see the tangible impact of their work over the summer, they will be more motivated to remain a part of our community after GSoC is over.

* '''Are you a new organization who has a Googler or other organization to vouch for you? If so, please list their name(s) here.'''
** No, we're not.

* '''Are you an established or larger organization who would like to vouch for a new organization applying this year? If so, please list their name(s) here.'''
** N.A.

Dev:GoogleSoC/StudentApplicationTemplate

2012-03-06T11:31:28Z

Nikitakit: /* Tasks */

== Name and Contact Information ==
*'''Name'''
*'''Email'''
*'''Phone number''' ''Please provide your phone number, with country code. We will only call you if we cannot reach you through other means (e.g. if, at some point, you are in an area without internet access.)''
*'''IRC nick and forum username'''

== Project Idea ==
* What project idea do you propose to implement?
* What is your planned schedule for the project? Please list any tasks/milestones, and when you intend to complete them.

== Questions ==
* Have you used Synfig or other animation software? If so, for what kind of tasks?
* Have you been involved with Synfig or any other open source projects? If so, please describe your contributions.
* What past experience do you have with programming in C++?
* Please describe any plans you have over the summer in addition to GSoC (vacation, classes, summer job, etc.)

== Tasks ==
''Before you apply, we would like you to discuss your project ideas with us and make one or two small changes to the Synfig source code.''
* Clone the Synfig source code repository and compile it.
* Introduce yourself on our mailing list. ''If you have questions at any point, please ask us on the mailing list, IRC, or forums''
* Find and fix one or two bugs in the program, and submit a patch or pull request. Please make sure that we can connect it with your application.

Dev:GoogleSoC/ApplicationForm

2012-03-06T11:29:21Z

Nikitakit:

Questions from http://www.google-melange.com/gsoc/org/application/google/gsoc2012 (needs registration)

* '''Organization name:'''
** Synfig

* '''Organization description:'''
** We are a community of developers and animators centered around Synfig Studio, a 2D vector animation program aiming to improve artistic workflow by focusing on tweening and interpolation. We work together to refine and add new features to the Synfig software, and create tutorials and run challenges to help and inspire our artists.

* '''Organization home page url:'''
** http://synfig.org/

* '''Main organization License:'''
** GNU GPL v2 or later.

* '''What is the URL for your Ideas page?'''
** http://wiki.synfig.org/wiki/Dev:GoogleSoC/Ideas

* '''What is the main IRC channel for your organization?'''
** #synfig on irc.freenode.net Logs: http://dooglus.rincevent.net/synfig/logs

* '''What is the main development mailing list for your organization?'''
** http://lists.sourceforge.net/lists/listinfo/synfig-devl

* '''Why is your organization applying to participate in Google Summer of Code 2012? What do you hope to gain by participating?'''
** We hope to attract new and enthusiastic developers to the project.

* '''Did your organization participate in past Google Summer of Codes? If so, please summarize your involvement and the successes and challenges of your participation.'''
** Our organization have not participated in the past GSoCs.

* '''If your organization has not previously participated in Google Summer of Code, have you applied in the past? If so, for what year(s)?'''
** We applied to GSoC in 2008 and 2010.

* '''Does your organization have an application template you would like to see students use? If so, please provide it now.'''
** http://wiki.synfig.org/wiki/Dev:GoogleSoC/StudentApplicationTemplate

* '''What criteria did you use to select your mentors for this year's program? Please be as specific as possible.'''
** For our mentors, we have selected the most motivated and consistent contributors to the project who extensive knowledge of specific areas of the Synfig Studio source code. Mentor: Carlos López González, Lead Developer

* '''What is your plan for dealing with disappearing students?'''
** We ask students to provide their email and phone number to the project administrator. If a student disappears without notice, the mentor will contact him/her via email to clarify the situation. If there is no reply within 3 days, the administrator will phone him/her personally. If the student cannot be reached, the administrator will contact Google and report the situation.

* '''What is your plan for dealing with disappearing mentors?'''
** Our backup mentor will be available throughout the summer to provide additional support for students, and will be able to fill in for the primary mentor if he is unavailable. In the case of an emeregency, or if the mentor is disappears and the project administrator fails contact him by phone, the backup mentor will fully take over his responsibilities.

* '''What steps will you take to encourage students to interact with your project's community before, during and after the program?'''
** We want students who are active with the project before the application process begins. We ask potential students to introduce themselves on the project mailing list and forums and get to talk with some of our developers and animators. We will treat them as any new member of our community and help them learn the project and answer any questions they may have.
As part of our application process, we require that students are able to compile and run Synfig and ask them to submit several patches or pull requests, and any artwork made in Synfig that they want to share. Those that have shown active envolvement and eagerness to participated will be favored for acceptance into the program, and we believe that the enthusiastic students will stay after the summer is over.
Once a student's code is reviewed and critiqued, we will strive to integrate it into a new release of Synfig. If students see the tangible impact of their work over the summer, they will be more motivated to remain a part of our community after GSoC is over.

* '''Are you a new organization who has a Googler or other organization to vouch for you? If so, please list their name(s) here.'''
** No, we're not.

* '''Are you an established or larger organization who would like to vouch for a new organization applying this year? If so, please list their name(s) here.'''
** No, we're not.

Dev:GoogleSoC

2012-03-06T11:28:43Z

Nikitakit:

== Administrators and Mentors ==

Please read: [http://libregraphicsworld.org/blog/entry/some-insights-on-google-summer-of-code Some insights on Google Summer of Code]

* Administrator: {{l|User:Zelgadis|Konstantin Dmitriev aka Zelgadis}}, LinkID: zelgadis
* Mentor: {{l|User:Genete|Carlos López González aka Genete}}, LinkID: genete
* Backup Mentor: Nikita Kitaev aka Nikitakit
* Backup Administrator: David Rylander aka Rylleman, LinkID: d_rylander

== List of documents ==

* {{L|Dev:GoogleSoC/ApplicationForm|Application Form}}
* {{L|Dev:GoogleSoC/StudentApplicationTemplate|Student Application Template}}
* {{L|Dev:GoogleSoC/Ideas|Ideas}}

Dev:GoogleSoC/StudentApplicationTemplate

2012-03-06T11:23:54Z

Nikitakit: Created page with "== Name and Contact Information == *'''Name''' *'''Email''' *'''Phone number''' ''Please provide your phone number, with country code. We will only call you if we cannot reach yo..."

== Name and Contact Information ==
*'''Name'''
*'''Email'''
*'''Phone number''' ''Please provide your phone number, with country code. We will only call you if we cannot reach you through other means (e.g. if, at some point, you are in an area without internet access.)''
*'''IRC nick and forum username'''

== Project Idea ==
* What project idea do you propose to implement?
* What is your planned schedule for the project? Please list any tasks/milestones, and when you intend to complete them.

== Questions ==
* Have you used Synfig or other animation software? If so, for what kind of tasks?
* Have you been involved with Synfig or any other open source projects? If so, please describe your contributions.
* What past experience do you have with programming in C++?
* Please describe any plans you have over the summer in addition to GSoC (vacation, classes, summer job, etc.)

== Tasks ==
''Before you apply, we would like you to discuss your project ideas with us and make one or two small changes to the Synfig source code.''
* Clone the Synfig source code repository and compile it.
* Introduce yourself on our mailing list. ''If you have any questions at all, please ask us on the mailing list, IRC, or forums''
* Find and fix one or two bugs in the program, and submit a patch or pull request. Please make sure that we can connect it with your application.

Dev:Action System

2010-11-03T21:11:58Z

Nikitakit: Formatting

The action system provides a good entry-point into Synfig because it functions as a stand-alone component that only interacts with Synfig's core data structure. This page is intended to provide a quick overview of the structure of the action system.

==Data Structures==

The action system interacts with the underlying data structure of a Synfig document. An action is most likely to affect the parameters of a given layer or object, which are described by the following classes.

===Value (ValueBase)===
The ValueBase class can store values of any of the {{l|Dev:Types|13 Value Types}}, such as numbers, points, and colors. Before reading or setting any values, it is important to check the type of value being used (by calling value.get_type()). Getting the contents of the value as a C++ type also requires knowing what type is expected (e.g. value.get(Real())).

===ValueNode===
A {{l|ValueNode}} is a value can change with time. A "converted" or "animated" parameter is always a ValueNode.

Calling "value_node(time)" retrieves the value at that given time.

===ValueDesc===
Instances of this class describe a ''location'' where a ValueNode may be rather than that ValueNode itself. For example, they can refer to "the 'amount' parameter of layer x" or "the 5th point in the bline". That way, the ValueDesc continues to function even if the underlying value has been changed, exported, converted, etc.

Actions typically receive ValueDescs to operate on, only retrieving their values when they are necessary for computations.

==Properties of an Action==

The majority of actions are accessible by right-clicking on certain ducks, parameters, or layers. At that point, Synfig Studio automatically determines which actions can be called based on the data that is currently selected.

The first step is for the action to provide a "Parameter Vocabulary" object that describes what types of parameters it needs in order to function.

===get_param_vocab()===

Typical implementation:
* Get the param vocab from the parent action. In most cases, it will be "ParamVocab ret(Action::CanvasSpecific::get_param_vocab());"
* Create a parameter description for each of the parameters your action needs(see [http://download.tuxfamily.org/synfig/api/synfig-studio/classsynfigapp_1_1Action_1_1ParamDesc.html ParamDesc])
** ParamDesc("new_value",Param::TYPE_VALUE)
** Set the parameter options e.g. "ParamDesc(...).set_local_name(_("ValueBase"))"
** The set actions all return the object, so you should chain them: ParamDesc(...).set_local_name(...).set_supports_multiple(...)
* Once the parameters are set, add them to the Parameter Vocabulary e.g. "ret.push_back(ParamDesc("new_value",Param::TYPE_VALUE).set_local_name(_("ValueBase")));"

However, the parameter types alone are not always sufficient to determine whether the action should be called. As such, checking a given parameter set is done by the action:

===is_candidate(const ParamList &x)===

Typical implementation:
* The first step of any candidate check is to test whether the requirements of the ParamDesc are met. "if (!candidate_check(get_param_vocab(), x)) return false;"
* At this point, you know that all of your parameters are present and can begin testing for specific cases. (For example, the "activepointsetoff" action is only applicable when the activepoint is currently on)
* If there are no tests to perform, return "true".

Once the parameter list is checked, Synfig Studio will pass the actual parameters to the action. The action must then retrieve their values and store them internally. This internal storage allows for the action to be un-done and re-done multiple times.

===set_param(const synfig::String& name, const Action::Param &param)===

Typical implementation:
* Retrieve value of the parameter and store it in an internal variable

The action needs to be able to check whether all of its parameters are set. While the parameter list is checked when the action is called as a result of a right-click menu, any actions called from other places (e.g. by other actions) manually set parameters and must check that the proper parameters are present.

===is_ready()===

Typical implementation:
* Return false if your custom parameters are unset
* Check that the required parameters for CanvasSpecific actions are met "return Action::CanvasSpecific::is_ready();"

==Types of actions==

There are two major types of actions.

===Undoable actions===
The first are standard undoable actions
*These inherit from [http://download.tuxfamily.org/synfig/api/synfig-studio/classsynfigapp_1_1Action_1_1Undoable.html Undoable] and [http://download.tuxfamily.org/synfig/api/synfig-studio/classsynfigapp_1_1Action_1_1CanvasSpecific.html CanvasSpecific]
*It is necessary to implement perform() and undo()

===Super-actions===
The second are Super-actions which can only call other actions. Since undoing a Super-action is simply undoing all of its sub-actions, these do not require an undo method.
*Inherit from [http://download.tuxfamily.org/synfig/api/synfig-studio/classsynfigapp_1_1Action_1_1Super.html Super]
*perform() and undo() are inherited from Super and should not be overridden.
*Instead, one should implement the prepare() method, which creates sub-actions

To add sub-actions:

* First create the action of the needed type e.g. "Action::Handle action(Action::create("ValueDescSet"));" or "ValueDescConnect::create()" (TODO: Style review here)
* Set its parameters:
**The canvas, canvas interface, and current time of the current action are usually passed on to children
***action->set_param("canvas",get_canvas());
***action->set_param("canvas_interface",get_canvas_interface());
***action->set_param("time",time);
**Other parameters will vary from action to action. For ValueDescSet they might be:
***action->set_param("value_desc",reference_value_desc);
***action->set_param("new_value",value);
* Add it to the action stack
** "add_action(action)"

Dev:Action System

2010-10-11T18:39:04Z

Nikitakit: Make page more coherent

This page is a work-in-progress documentation of the action system.
At the moment there are only some brief notes.

==Data Structure==

The action system, for the most part, interacts only with document data structure. As such, it is important to understand what this structure is consists of.

Value (ValueBase): The ValueBase class can store values of any of the 13 {{l|Dev:Types|Types}}. As such, using Values requires one to check the type of the given object (by calling value.get_type()) and to know the value type before fetching its contents (e.g. value.get(Real())).

ValueNode: A {{l|ValueNode}} is a value that changes with time. Calling value_node(time) retrieves the value at that given time.

ValueDesc: Instances of this class describe a ''location'' where a ValueNode may be rather than that ValueNode itself. (For example "the 'amount' parameter of layer x" or "the 5th point in the bline"). That way, the ValueDesc consistently refers to the same location even if the underlying value has been changed, exported, converted, etc.

Actions typically receive ValueDescs to operate on and will only retrieve the actual value at that point if necessary

==Properties of an Action==

The majority of actions are accessible by right-clicking on certain ducks, parameters, or layers. At that point, Synfig Studio automatically determines which actions can be called based on the data that is currently selected. The first step is for the action to provide a "Parameter Vocabulary" object that describes what types of parameters it needs in order to function.

get_param_vocab()

Typical implementation:
* Get the param vocab from the parent action. In most cases, it will be "ParamVocab ret(Action::CanvasSpecific::get_param_vocab());"
* Create a parameter description for each of the parameters your action needs(see [http://download.tuxfamily.org/synfig/api/synfig-studio/classsynfigapp_1_1Action_1_1ParamDesc.html ParamDesc])
** ParamDesc("new_value",Param::TYPE_VALUE)
** Set the parameter options e.g. "ParamDesc(...).set_local_name(_("ValueBase"))"
** The set actions all return the object, so you should chain them: ParamDesc(...).set_local_name(...).set_supports_multiple(...)
* Once the parameters are set, add them to the Parameter Vocabulary e.g. "ret.push_back(ParamDesc("new_value",Param::TYPE_VALUE).set_local_name(_("ValueBase")));"

However, the parameter types alone are not always sufficient to determine whether the action should be called. As such, checking a given parameter set is done by the action:

is_candidate(const ParamList &x)

Typical implementation:
* The first step of any candidate check is to test whether the requirements of the ParamDesc are met. "if (!candidate_check(get_param_vocab(), x)) return false;"
* At this point, you know that all of your parameters are present and can begin testing for specific cases. (For example, the "activepointsetoff" action is only applicable when the activepoint is currently on)
* If there are no tests to perform, simply return true.

Once the parameter list is checked, Synfig Studio will pass the actual parameters to the action. The action must then retrieve their values and store them internally. This internal storage allows for the action to be un-done and re-done multiple times.\

set_param(const synfig::String& name, const Action::Param &param)

Typical implementation:
* Retrieve value of the parameter and store it in an internal variable

The action needs to be able to check whether all of its parameters are set. While the parameter list is checked when the action is called as a result of a right-click menu, any actions called from other places (e.g. by other actions) manually set parameters and must check that the proper parameters are present.

is_ready()

Typical implementation:
* Return false if your custom parameters are unset
* Check that the required parameters for CanvasSpecific actions are met "return Action::CanvasSpecific::is_ready();"

==Types of actions==

There are two major types of actions.

The first are standard undoable actions
*These inherit from [http://download.tuxfamily.org/synfig/api/synfig-studio/classsynfigapp_1_1Action_1_1Undoable.html Undoable] and [http://download.tuxfamily.org/synfig/api/synfig-studio/classsynfigapp_1_1Action_1_1CanvasSpecific.html CanvasSpecific]
*It is necessary to implement perform() and undo()

The second are Super-actions which can only call other actions. Since undoing a Super-action is simply undoing all of its sub-actions, these do not require an undo method.
*Inherit from [http://download.tuxfamily.org/synfig/api/synfig-studio/classsynfigapp_1_1Action_1_1Super.html Super]
*The prepare() method creates sub-actions and adds them to the stack by calling "add_action(action)"
*perform() and undo() are inherited from Super and should not be overridden.

Sub-actions are added by:

* First create the action of the needed type "Action::Handle action(Action::create("ValueDescSet"));" or "ValueDescConnect::create()" (TODO: Style review here)
* Set it's parameters:
**The canvas, canvas interface, and current time are usually simply passed on to children
***action->set_param("canvas",get_canvas());
***action->set_param("canvas_interface",get_canvas_interface());
***action->set_param("time",time);
**Other parameters will vary from action to action. For ValueDescSet they might be:
***action->set_param("value_desc",reference_value_desc);
***action->set_param("new_value",value);

Dev:Roadmap

2010-10-11T18:00:25Z

Nikitakit: Change roadmap to reflect current plans

= Synfig Roadmap =
* '''0.63.00 targets'''
** Smart Tangents Linking
** Initial Bones support
* '''0.64.00 targets'''
** ...
* '''1.0 targets'''
** Width ducks independent of BLine points
** OpenGL rendering
** Sound support
** Free drawing tools
** UI redesign

[http://www.mind42.com/pub/mindmap?mid=04afc25d-b337-483b-bba4-fdbe4de6327e Online Roadmap Of Synfig]. If you want to collaborate to edit this "roadmap mindmap" please let us know in the talk page of this one.

This It is not finished but would be a comprehensive list of things to be done/fix.
This mind map would help to create the real Road Map for the next release. The road map should be an ordered list of bugs and features that should be fixed/implemented in the next release.

= Web infrastructure reorganization =
* Hosting
** <s>Resolve memory issues</s>
** <s>Cleanup</s>
** <s>Manage all settings with git</s>
** Sophisticated backup system
* CMS
** Common skin
** Top banner
** Main page: Splash and "download now" button
** Development page
** Releases information with features overview (like on blender.org)
*** Put splash screen on each release page
** Integrated irc client
** Integrated IRC logs page
** Download -> Tools
** Reorder Gallery
* Documentation
** Common skin
** Solid manual/guide
** <s>PDF export</s>
*** <s>Basic implementation</s>
*** <s>Ignore navigation panel</s>
*** <s>Multilevel headings</s>
*** <s>Internal links</s>
** <s>Navigation Templates</s>
** Inline .po support
** Writer guide
** Translator guide
** Describe templates
* Forums
** Common skin
* Library
** Setup ccHost
** Common skin

=Old Road Map=
There is '''''no specific roadmap''''', we just work on whatever happens to catch our interest. So far, we've made releases once there are a reasonable number of new fixes and/or features. This usually occurs every 6 months or so. Please see the {{l|Release|release}} page for the process we go through when releasing. Please see the {{l|Wish list|wishlist}} page if you have some ideas. Please see {{l|Software roadmap}} for things we want to do with synfig at some point.

As an open source project, synfig is relatively young. As a result, it has lots of creases that need to be ironed out. The copyright is sorted, the code compiles fine, but there are warts when running the code and important features that are missing. To smooth out those warts, we need people to help out. We cannot do everything ourselves, WE NEED YOUR HELP!!

Dev:Action System

2010-09-08T21:32:37Z

Nikitakit: Some infor on value/valuenode/valuedesc

This page is a work-in-progress documentation of the action system.
At the moment there are only some brief notes.

Types of actions

*Inherit from [http://download.tuxfamily.org/synfig/api/synfig-studio/classsynfigapp_1_1Action_1_1Super.html Super]
**can only call other actions
**implement a prepare() method to create sub-actions

*Inherit from [http://download.tuxfamily.org/synfig/api/synfig-studio/classsynfigapp_1_1Action_1_1Undoable.html Undoable] and [http://download.tuxfamily.org/synfig/api/synfig-studio/classsynfigapp_1_1Action_1_1CanvasSpecific.html CanvasSpecific]
**implement perform() and undo()

get_param_vocab()

Each action must be able to supply a "Parameter Vocabulary" object. This object specifies what parameters the action requires and what type they need to be.

* Get the param vocab from the parent action. In most cases, it will be "ParamVocab ret(Action::CanvasSpecific::get_param_vocab());"
* Create a parameter description for each of the parameters(see [http://download.tuxfamily.org/synfig/api/synfig-studio/classsynfigapp_1_1Action_1_1ParamDesc.html ParamDesc])
** ParamDesc("new_value",Param::TYPE_VALUE)
** Set the parameter options e.g. "ParamDesc(...).set_local_name(_("ValueBase"))"
** The set actions all return the object, so you should chain them: ParamDesc(...).set_local_name(...).set_supports_multiple(...)
* Once the parameters are set, they should be added to the Parameter Vocabulary e.g. "ret.push_back(ParamDesc("new_value",Param::TYPE_VALUE).set_local_name(_("ValueBase")));"

is_candidate(const ParamList &x)

Any time the user selects some object (be it a duck, parameter, layer, etc) and right-clicks, she is offered a context menu containing all applicable actions. Synfig checks for candidates by passing them a list of parameters and asking if they are acceptable.

* The first step of any candidate check is to test whether the requirements of the ParamDesc are met. "if (!candidate_check(get_param_vocab(), x)) return false;"
* At this point, you know that all of your parameters are present and can begin testing for specific cases. (For example, the "activepointsetoff" action is only applicable when the activepoint is currently on)
* If there are no tests to perform, simply return true.

set_param(const synfig::String& name, const Action::Param &param)

When passed a parameter, the action must be able to determine if it is the right type and, if so, set an internal variable that stores the value of the parameter. All action parameters are stored in variables so that they can be accessed again if the action is undone or has been undone and now should be performed again.

is_ready()

This method should check that all internal variables needed have been properly initialized. This test is performed before any action is called to ensure that it has all of its variables set and can be executed safely.

prepare()

(Only applies to actions inheriting from Super). The prepare function should create sub-actions that need to be performed and call "add_action" or "add_action_front" on them. There is no need to manually implement perform() and undo(), as these will be done automatically by either performing all of the sub-actions or undoing them.

Actions are added by:

* First create the action of the needed type "Action::Handle action(Action::create("ValueDescSet"));" or "ValueDescConnect::create()" (TODO: Style review here)
* Set it's parameters:
**The canvas, canvas interface, and current time are usually simply passed on to children
***action->set_param("canvas",get_canvas());
***action->set_param("canvas_interface",get_canvas_interface());
***action->set_param("time",time);
**Other parameters will vary from action to action. For ValueDescSet they might be:
***action->set_param("value_desc",reference_value_desc);
***action->set_param("new_value",value);

Terminology:

Value (ValueBase): The ValueBase class can store values of any of the 13 {{l|Dev:Types|Types}}. Actions involved in setting a value typically require an object of this type for a parameter. Since a given instance of ValueBase may in fact store objects of different types, it is important to check the type (by calling value.get_type()) and then get the value in the proper type (e.g. value.get(Real()))

ValueNode: A {{l|ValueNode}} is a value that changes with time.

ValueDesc: Instances of this class describe a ''location'' where a ValueNode may be rather than that ValueNode itself. (For example "the 'amount' parameter of layer x" or "the 5th point in the bline"). That way, the ValueDesc consistently refers to the same location even if the underlying value has been changed, exported, converted, etc.

ValueNode

2010-09-08T21:22:17Z

Nikitakit: Update link

{{Category|Glossary}}
A ValueNode is a value that can change over time.

A ValueNode represents a description of a value and how it changes (or doesn't!) over time.

ValueNodes are the things we see as the value for every parameter of every layer. The waypoints visible in the timetrack dialog are also part of the ValueNode - waypoints are how Animated ValueNodes work out what value to be at each point in time.

Each ValueNode (and hence each {{l|Parameter}} in Synfig has one of 13 {{l|Dev:Types|Types}}.

There are three kinds of ValueNodes in Synfig. In the following examples the ValueNode's type is a [http://en.wikipedia.org/wiki/Real_number real number] in each case:

== Constant ValueNodes ==

These have a single value for all time, and no waypoints. An example of such a ValueNode would be:

"3.4, for ever"

== Animated ValueNodes ==

These have {{l|Waypoints}} that specify their value at particular points in time. For times which don't have a value specified, the value is calculated by interpolating between the waypoints. An example would be:

"3.4 at the beginning of the animation,
move smoothly up to 7.6 at time = 10 seconds,
then jump instantly to 2.0
and stay there until the end of time"

== Converted ValueNodes ==

These are ValueNodes which have been {{l|Convert|Converted}} into sub-parameters, each of which is itself a ValueNode. Right-clicking on a parameter and selecting a type from the 'convert' sub-menu allows you to convert a ValueNode. Converted ValueNodes don't have waypoints themselves, but their sub-parameters may do. An example would be:
"start at 3.4 and linearly increase by 1.2 per second"

Dev:Action System

2010-09-08T18:53:30Z

Nikitakit: More writing

This page is a work-in-progress documentation of the action system.
At the moment there are only some brief notes.

Types of actions

*Inherit from [http://download.tuxfamily.org/synfig/api/synfig-studio/classsynfigapp_1_1Action_1_1Super.html Super]
**can only call other actions
**implement a prepare() method to create sub-actions

*Inherit from [http://download.tuxfamily.org/synfig/api/synfig-studio/classsynfigapp_1_1Action_1_1Undoable.html Undoable] and [http://download.tuxfamily.org/synfig/api/synfig-studio/classsynfigapp_1_1Action_1_1CanvasSpecific.html CanvasSpecific]
**implement perform() and undo()

get_param_vocab()

Each action must be able to supply a "Parameter Vocabulary" object. This object specifies what parameters the action requires and what type they need to be.

* Get the param vocab from the parent action. In most cases, it will be "ParamVocab ret(Action::CanvasSpecific::get_param_vocab());"
* Create a parameter description for each of the parameters(see [http://download.tuxfamily.org/synfig/api/synfig-studio/classsynfigapp_1_1Action_1_1ParamDesc.html ParamDesc])
** ParamDesc("new_value",Param::TYPE_VALUE)
** Set the parameter options e.g. "ParamDesc(...).set_local_name(_("ValueBase"))"
** The set actions all return the object, so you should chain them: ParamDesc(...).set_local_name(...).set_supports_multiple(...)
* Once the parameters are set, they should be added to the Parameter Vocabulary e.g. "ret.push_back(ParamDesc("new_value",Param::TYPE_VALUE).set_local_name(_("ValueBase")));"

is_candidate(const ParamList &x)

Any time the user selects some object (be it a duck, parameter, layer, etc) and right-clicks, she is offered a context menu containing all applicable actions. Synfig checks for candidates by passing them a list of parameters and asking if they are acceptable.

* The first step of any candidate check is to test whether the requirements of the ParamDesc are met. "if (!candidate_check(get_param_vocab(), x)) return false;"
* At this point, you know that all of your parameters are present and can begin testing for specific cases. (For example, the "activepointsetoff" action is only applicable when the activepoint is currently on)
* If there are no tests to perform, simply return true.

set_param(const synfig::String& name, const Action::Param &param)

When passed a parameter, the action must be able to determine if it is the right type and, if so, set an internal variable that stores the value of the parameter. All action parameters are stored in variables so that they can be accessed again if the action is undone or has been undone and now should be performed again.

is_ready()

This method should check that all internal variables needed have been properly initialized. This test is performed before any action is called to ensure that it has all of its variables set and can be executed safely.

prepare()

(Only applies to actions inheriting from Super). The prepare function should create sub-actions that need to be performed and call "add_action" or "add_action_front" on them. There is no need to manually implement perform() and undo(), as these will be done automatically by either performing all of the sub-actions or undoing them.

Actions are added by:

* First create the action of the needed type "Action::Handle action(Action::create("ValueDescSet"));" or "ValueDescConnect::create()" (TODO: Style review here)
* Set it's parameters:
**The canvas, canvas interface, and current time are usually simply passed on to children
***action->set_param("canvas",get_canvas());
***action->set_param("canvas_interface",get_canvas_interface());
***action->set_param("time",time);
**Other parameters will vary from action to action. For ValueDescSet they might be:
***action->set_param("value_desc",reference_value_desc);
***action->set_param("new_value",value);

TODO: explain valuebase, valuenodes, valuedesc, and the differences between them

Dev:Action System

2010-09-08T01:52:24Z

Nikitakit: More documentation

Dev:Action System

2010-09-07T20:25:44Z

Nikitakit: Initial notes

This page is a work-in-progress documentation of the action system.
At the moment there are only some brief notes.

Types of actions

*Inherit from Super
**can only call other actions
**implement a prepare() method to create sub-actions

*Inherit from Undoable and CanvasSpecific
**implement perform() and undo()

*Get_Param_Vocab
** Get the parent param vocab "ParamVocab ret(Action::CanvasSpecific::get_param_vocab());"
** Then add parameters to it e.g. " ret.push_back(ParamDesc("new_value",Param::TYPE_VALUE).set_local_name(_("ValueBase")));"

Developer Documentation

2010-09-07T01:46:57Z

Nikitakit: Add some more information to the dev page

The Developer Documentation part of this wiki is primarily for the following groups of people:

*Current developers of the code
*Future and potential developers
*Those interested in bug filing and generating ideas

Index:

* {{l|Dev:Build Instructions|Build Instructions}}
* {{l|Dev:Source code|Source code}} description and workflow
* {{l|Dev:Roadmap|Roadmap}}
* {{l|Dev:Wish list|Wish List}}

Synfig is divided into three main components: etl, synfig-core and synfig-studio.
* ETL is the extended template library. One of its most important components is the shared object class, which is the base class for most other parts of the application. Using "handles" to shared objects instead of c++ pointers provides garbage collection via reference counting.
* The core/command-line renderer ("synfig") contains the document data structure for the application: valuenodes, layers, and canvases.
* Synfig Studio ("synfig-studio") provides the gui for the application.
* See also: {{l|Dev:How Synfig Works|How Synfig Works}}

Complete coding tutorials:
* {{l|Dev:Adding a Layer|Adding a Layer}}
* Adding a Panel, {{l|Dev:Adding a Panel - Part I|Part I}} and {{l|Dev:Adding a Panel - Part I|Part II}}. Note: these are slightly out of date: please note that the directory "gtkmm" has been renamed to "gui" and some files were moved into subfolders.

Other:

* [http://synfig.org/wiki/index.php?title=Special%3APrefixIndex&from=&namespace=102 All Dev namespace pages]
* {{l|Dev:Translation|Translate the application}}

Dev:Source Outline

2010-09-07T01:15:46Z

Nikitakit: Remove outdated source tree

{{Category|Code}}

{{Stub}}

A good reference to the ETL/synfig/synfigstudio source code is the [http://download.tuxfamily.org/synfig/api/index.html synfig doxygen documentation]. Please note that currently the API and ABI is subject to change and breakage. We do our best to keep the file format from breaking though.

NOTE: the code tree that used to be listed here became out of date after a restructuring of the source code. Please [http://synfig.git.sourceforge.net/git/gitweb.cgi?p=synfig/synfig;a=tree browse the tree using gitweb] instead.

Dev:Wish list

2010-06-14T01:27:25Z

Nikitakit: Remove already implemented features

{{TranslationBar|CONTENT={{Tr/en}} · {{Tr/fr}}}}

'''''Warning''''': We need more people working on the code if we are going to be able to achieve all the feature requests.

Got a great idea for a new feature? Just add it here, or on the [http://sourceforge.net/tracker/?group_id=144022&atid=757419 feature requests tracker]. Before you do, please check the [https://synfig.svn.sourceforge.net/svnroot/synfig/ETL/trunk/TODO etl], [https://synfig.svn.sourceforge.net/svnroot/synfig/synfig-core/trunk/TODO synfig] and [https://synfig.svn.sourceforge.net/svnroot/synfig/synfig-studio/trunk/TODO synfigstudio] TODO files for similar ideas. Please add a rating of how essential this feature is to your workflow according to the following scale:

#"Well, it might be nifty. To someone."
#"I probably would make use this"
#"It's not essential, but I'd really like to have this at my disposal."
#"Synfig would be soooo much better with this change"
#"I can't/won't use Synfig without it!"

== Misc ==

Please clean this section up as desired.

* A different color dialog for picking/changing colors easier.
** Swatch menu from gimp with .gpl files.
* Workflow improvements, like content help and ui-refinement.
** set the fine line between design and animation work.
** Greet the user at startup, give hints and help in the ui to better the usability and user-experience.
* test synfig cross-platform (Linux, Windows, Mac)
* Pluggable App (run from memory stick)
* make a short film about synfigs capabilitys in a starwars kind of spaceship setting as promo video about 3 minutes long.
* Sound layer
* full tablet support
* small set of vector contend for fast animation results
* Help is available as pdf-file and distributed with the program

'''Input:'''
* Import vectorgraphics (svg,fig)

'''Output:'''
* Render output to [http://animatedpng.com/ animated PNG]
* Export vectorgraphics (svg,fig)

== Interchangeable/customizing Splash screen ==
[3] GIMP has this feature of letting users [http://docs.gimp.org/2.2/en/using-customize-splashscreen.html|customize GIMP's splash screen]. GIMP looks for <code>'''samples'''</code> directory under <code>'''.gimp-2.x'''</code> then randomly picks a picture from it to become the spash image.

This will also help GNU/Linux distro, like Ubuntu, to adopt Synfig and put their logo on the splash screen.

Also, official Synfig distribution can pack sample arts created by other artists to be randomly displayed -- like the synfig.org's title's background image.

== Verbosity levels for error output ==

Synfigstudio needs verbosity levels for the error output. Levels are info, warning and error. Make sure, to spew out only errors when something nasty happens. If someone wants to know all what happens in synfigstudio, the user should activate a higher level of verbosity with the command line switch --verbose=all,info,warning

== Usage screen for new users ==

Synfig and Synfigstudio need a usage screen, which helps a new user to type in the right syntax on the command line. Any switch not known to the program should point to the usage screen. On the bottom of the usage screen could be a hint: " For more help use synfig --help"

== Keyboard shortcuts for panning ==

The navigation and canvas windows need shortcut keys that pan the canvas view horizontally and vertically. Probably just the arrow keys would work for this, as well as the home/end/pageup/pagedown keys. Ctrl and shift variants could make the panning more or less.
: You can pan with a middle mouse button. --{{l|User:Zelgadis|Zelgadis}} 00:59, 24 October 2008 (EDT)

== Linking Zoom layer to Paste Canvas ==

[3] It is impossible to link Center of Zoom layer to Origin of Paste Canvas without exporting a value. It often needed for pans & zooms. Suggestion: rename "Center" parameter of Zoom Layer to the "Origin". Will improve the workflow. --{{l|User:Zelgadis|Zelgadis}}

== Convert Strings ==
[4] It could be very good to have feature to represent Convert sequences as strings and vice versa - make convert sequences from strings. Example: To produce this convert sequence:

{{l|Image:WishList-ConvertStrings.png}}

I just right-click on "Origin" parameter and choosing "String Convert" menu item. In the appeared dialog I just entering: "=Composite(Scale(x, Switch(scalar, 1.0, 0)), y)".

Also if I clicking on the parameter already containing convert sequence and choosing "String Convert", it shows string representation of current convert sequence with an ability to edit.

This feature will make possible to easy copy convert sequences from one parameter to another. --{{l|User:Zelgadis|Zelgadis}} 03:46, 2 November 2008 (EST)

== Non scalable timeline ==
[3] It should be useful for me to have non scalable timeline. It's hard to set timing when the distance between frames is always different in different documents and in different situations. Suggestion: make a non-scalable mode for timeline, where 1 second interval is always the same. Will improve the workflow. --{{l|User:Zelgadis|Zelgadis}}

==Smart linking of tangents==
[4] As described in {{l|Sewing BLines}}, when linking red tangent to yellow they are placed opposite against each other. This is normal from the program's point of view, but not normal for new users. Even more, to avoid this effect user needs to made some complex steps (see {{l|Sewing BLines#Solution}}). It takes a lot of time if we vahe lot of verticles to sew their tangents.

Suggestion:
* When linking tangents with the same color, program should act as usual.
* When linking tangents with different color program should automaticaly add Convert->Scale (-1) to avoid their opposite placement.
To allow linking two tangents in opposite position, I suggest to add a new menu option for tangents "Link Opposite". When linking two tangents with this option:
* When linking tangents with the different color, program should act as it acts now - no additional converts added.
* When linking tangents with the same color program should automaticaly add Convert->Scale (-1) to plcae them opposite against each other.

--{{l|User:Zelgadis|Zelgadis}}

==Morph sets==
This feature is similar to some other suggestions below, just with another way to approach. In animations are many movements, which can be put in some kind of library, to make use of at a later time. For example, movements to animate the key moments of a mouth, sampling syllables. For vector graphics, it should be possible to define some key points, which move just a small amount of space, to form another syllable. These syllables in this example, should be stored in a drop down list, to be able to select them for the key time on the timeline.
A morph-set for walking-left-to-right is different from a morph-set for a mounth, which has as options a,e,i,o,u,bah-disgust,happy-smile. The morph-set has to be stored as vector coordinates in a relative way(offset), e.g. X1=+212,+34;X2=-56,-23;X3=+3,-88;

To make use of the morph-set for the mouth, you have to define first, which vector points in your drawn mouth, correspond to the key-points of your morph-set. X1, X2, X3, Xn

--{{l|User:SvH|SvH}} 06:53, 27 May 2008 (EDT)

==Render time approximation==
Synfigstudio should get a button in the render dialog, which calculates the total render time for the actual settings (frames per second, length of the film, resolution, output format) It should testrender 1 picture, when the amount of total frames is below 1000. Over 1000 frames, it should testrender 10 pictures for more precise calculation.

--{{l|User:SvH|SvH}} 12:49, 22 May 2008 (EDT)

==Smartrendering==
I have made 25,000 small png-pictures with my 800Mhz computer in about 45 minutes. Synfigstudio did calculate each single frame of it. Nothing changed in this picture, so it does only need to get written to disk for the amount of pictures, until the next change (animation) has an effect on the output picture. This should save time for bigger projects with thousands of pictures. With smartrendering it is also possible to predict the total amound of space in Megabytes (Mibibytes) of the final render of the movie. It should calculate how much it needs and see, if enough space is free on the harddisk before the rendering get started.

--{{l|User:SvH|SvH}} 12:49, 22 May 2008 (EDT)

:More specifically, only render frames that need to be changed since the last rendering as defined by something like a last edit (or write to filesystem) timestamp and a dependency tree. ...In the short-term, a tool like gmake might be useful for implementing this accross sessions if we add "last changed" timestamps to one or more sections of sifz files (rather than the almost useless case of a single sifz file timestamp if virtually all information for a project is kept within a single sifz file). We would use the last edit times in the filesystem if synfig recognizes the potentially generated files have names that already exist on disk. [There could be some tricky issues.] ...Within a given SynfigStudio (synfig?) session, we can use the timestamps from disk or just internalize that information without redoing the lookup. In addition, synfig internal dependencies based on what objects were changed since the last rendering can be used to implement a makefile whose make output would include a list of which frames need recalculation. Of course, the job of gmake could be internalized as well. [[User:Jose X|Jose X]] 21:18, 20 May 2010 (UTC)

== get_color method in text and radial blur ==

[5] Without get_color method distorion produces artifacts
[http://sourceforge.net/tracker/index.php?func=detail&aid=1831355&group_id=144022&atid=757416 bug 1831355]. So I would like to get this problem fixed before doing something else. --{{l|User:AkhIL|AkhIL}} 22:41, 1 May 2008 (EDT)

== Full functional of group dialog ==

[5] Group dialog is broken now [http://sourceforge.net/tracker/index.php?func=detail&aid=1796833&group_id=144022&atid=757416 bug 1796833]. So we should get old features work right before making new one. --{{l|User:AkhIL|AkhIL}} 22:41, 1 May 2008 (EDT)

== import/export .swf files ==

very important productivity feature

== import/export .svg frames sequence, and/or .svg animations ==

very important productivity feature

== a realtime .sif synchronized text window ==

just like the xml editor of Inkscape, or the html editor in Dreamweaver (this is hugelly useful for productivity)

I thinks scripting API can be implement in this way. For example you make XML DOM like implementation for python which alows to change DOM tree from python code and see chenges in canvas. By this way you can implement import/export scripts. Automation scripts. And a lot of different things. Even synchronization of animation between blender and synfig. --{{l|User:AkhIL|AkhIL}} 23:10, 26 April 2008 (EDT)

== choosing colour from gimp/inkscape palettes ==

very useful when you need some colour comformity of what you're doing

== Good high-level documentation of the source code ==

(2) It'd be nice if a newbie could quickly navigate around the source code. The best thing to do would be to add top-level comments in each file, explaining what that file does, a README.TXT in each directory, explaining what's in that directory. This would be pretty fast and easy to do, and make it much easier for new programmers to join.

Time permitting, it would also be good to document on a high level what the data structures are, but that's harder, since those tend to evolve, and it is often difficult to keep in sync. It would also be useful to document what individual functions do (just a one-liner high-level description), but that also takes more time.
: There is a page link in the wiki that connect to the [http://www.synfig.com/doc Synfig API Documentation]. I think this link should be highlighted to be more accessible for newbies contributors and mature developers (the link was found {{l|Releases/DeveloperPreview#Support | here}}). --{{l|User:Genete|Genete}} 10:02, 11 December 2007 (EST)

== Mathematical functions to animate ==
(2/4) If you want to make a waving flag, it would be handful a sine function, tuned with random correctors, for example.
: -This should generate waypoints each 1, 2, 4 frames or any other step at artist's wish.
: -When applying a function you can add it to current values, add it to 1st frame values or simply override old values. Perhaps other options (such multiplication) would be fine, too. Something like texture editor in [http://www.artofillusion.org Art of Illusion], perhaps.
Perhaps it would be useful reusing the [http://www.gnu.org/software/octave/ Octave] source code to parse mathematical expressions.
I have rated this wish with a '2' because undoubtly many users will not be familiar to mathematical concepts, but for those who will be, I'd rate it with a 4. It would be possible to make a ball describing a parabolic moving in no time.
{{l|User:ajotatxe|ajotatxe}} 20 November 2007
: dooglus can probably chime in better than I here (see his example of balls on mathematical paths at http://uk.youtube.com/watch?v=YTpSfUthuVE ), but I believe that this is already possible. Synfig does support a variety of mathematical transforms for parameters, although the way you do this is by no means intuitive. (You might also want to check out the preambletaffy.sifz example for an easier approach to a waving flag. I know you were just using that as an example, but for the record...) {{l|User:Pxegeek|Pxegeek}} 00:58, 21 November 2007 (EST)

: I'd also rate it with a (4) (and updated the rating accordingly), not for this special case, but to make many workarounds much easier. Simulating [Parabolic Shot|free fall], for example, would be a lot easier with real formulas. I don't know, though how easy it will be to implement, maybe waiting for a scripting interface to be implemented is better than hacking this feature in an ad-hoc manner. --{{l|User:Rubikcube|Rubikcube}} 16:38, 29 February 2008 (EST)

:One thing to keep in mind is that 2D animations will not frequently look realistic if you implement the exact mathematics without some sort of 3d perspective transformation. And then there is the complex physics also involved in defining precise trajectories. ..This aside, what is needed is simply a function value generator as a function of n variables where at least one variable can be the frame you are on (I don't have much experience with synfig, but I presume there is a way to explicitly get the value of the frame/time you are on) and where this output value can be linked to any other parameter (of a compatible type); you can hook these function block outputs to inputs of other instances of the generator; and the outputs are defined once on every frame. To do a movement like a parabola you configure the generator to output parabola values (one per frame or even allow skipping frames) and then link these values to the vertices of a translation layer. [In other words, the stuff underneath within scope would likely move relative to other stuff underneath but at an outer scope.] We note that linking this way will create many potentials for conflict between these values and existing waypoint values. We can specify which takes precedence and how to smooth between these. Eg, if waypoints take precedence in some particular case, we can specify how to smooth against the function generator values before and after the waypoint. How do we define the functions? The functions can come from a preselect set of parameterized functions (user enters fills in the parameters with constant values or else links). Two examples of functions with three param values would be: Asin(x)+B and mx+b. Also, very usefully, allow a sequence of values to be copy/pasted to define the function outputs at each step (so the mapping defining the function is a stream interpreted as the output value at each discrete frame value). The generator can be time shifted of course. This function definition approach allows other applications (or things like motion sensors) to generate the function values. Another method that can be useful for defining a function would be to accept a curve (eg, bline) and the function output values would come from the curve based on some method specified (eg, as a function of the length from some starting point along the curve and where the speed of travel is defined by a function L(t) where L is length from start so far and t is time/frame count (eg, L(t)=t means we move at constant speed along the curve, that is, at a value of 5 frames we would be 5 units along the length of the curve)). ..Anyway, the point is to have a function generator to hook up arbitrarily with inputs and which can co-exist with waypoints that would otherwise conflict. This would allow arbitrary automation of anything (based on precomputed or dynamic algorithmic values) without having to manually define/record a single waypoint. Conceptually, this doesn't seem that complex to integrate into the existing synfig and would be very useful (to allow arbitrary automation). An initial prototype version might integrate with only a few things, only have a limited set of simple predefined functions (plus sequence definition capabilities), have the output value be tossed out whenever a waypoint already existed, and exist only from a single menu entry. I really would like this feature. It would make it easier to speed up animation generation in many new custom ways without having to hack into synfig or into the sif file with some other tool. If I get comfortable with the code base, I might be able to chip in. [Any pointers would be appreciated.] [[User:Jose X|Jose X]] 07:03, 20 May 2010 (UTC)

== Warning about editing bizarre things in animate editing mode ==
(3.5) It seems to have little sense animate certain things like Blend Method or Type of Feather. It would be very nice that the program asked comfirmation if you change these attributes in animate editing mode. If you do want to, you would have three options: "Yes, never ask", "Yes, never ask for this attribute", "No". I guess that internally, this attributes has integer type (or something like that) and the attributes that you normally want to animate, float type, so I think that this feature is relatively easy to implement. My English is not very good, so please feel free to fix this post.
{{l|User:ajotatxe|ajotatxe}} 20 November 2007

== Bones with FK & IK + grouping of objects into folders ==

(5) Bones cane move specific vector assigned to them or the bones can have envelopes that move the vectors within their field of influence, much Like Anime Studio/Moho does. It's quite a time saving process of animating. Objects created can be saved into separate groups or folders using the same system as Anime Studio/Moho -Shadowphoenix 27/8/2007

== Animated sketch ==

(5) it would be great, if the tool Sketch was animatable (for example, in a form of a special sketch-layer). --Zelgadis 2007-06-14

: For now as a workaround we could use animation program called Pencil. See {{l|Related Projects}} page. --{{l|User:Zelgadis|Zelgadis}}

: So, currently it could be achieved by using other software, but integration with synfig is poor, cause it requires importing a movie through a sequence of images. This is not intuitive and not obvious for new users. It will be good if synfig will have it implemented like [url=http://www.blender.org/development/release-logs/blender-248/grease-pencil/]blender's Grease Pencil[/url]. This feature will improve workflow, make synfig usable for frame-by frame animation (it is intuitive way of learning animation and powerful tool for producing preproduction work like animatic). --{{l|User:Zelgadis|Zelgadis}}

: It would be nice to also implement the onion peel feature, where you can see the frame before or after, and/or selectable keyframes if this is included. An example can be seen in the program Pencil--{{l|User:richardwad1|richardwad1}}

== Duck for Amount value in Zoom layer ==

(2) It would be nice if Amount value in Zoom layer was controlled by additional duck. --{{l|User:Zelgadis|Zelgadis}} 02:49, 29 December 2007 (EST)
: I found that I can better use Warp layer instead of Zoom to change size. But it'd be nice to have Amount duck for Zoom layer anyway...
:: The Amount parameter works exponentially; each time you add 1 to the Amount, the image is zoomed by a further factor of e (= 2.71828 or so). Would a duck be any use if it just controlled the value of Amount in a linear way?
:: Workarounds include: export Amount, select it in the children dialog. Whatever's selected in the children dialog shows a duck. You can adjust it using that duck.
:: Also, if you use a Stretch layer, convert the Amount to Composite, export the X-Axis and connect it to the Y-Axis, then you have a duck-controllable fixed-aspect zoom. -- {{l|User:Dooglus|dooglus}} 15:32, 15 January 2008 (EST)
::: Yeah I found this workaround, but it's to much actions - i prefer better use Warp or Stretch layers. Why not the link Amount duck and Amount value with logarithmic function? ;) --{{l|User:Zelgadis|Zelgadis}} 10:33, 17 January 2008 (EST)
::::{{l|Convert#Logarithm|Logarithm}} convert type for real parameters exists since svn 2034. {{l|User:Genete|Genete}} 10:17, 30 August 2008 (EDT)

== Automatic colour palette optimisation ==

(0) it would be nice to use libcontrast [http://david.navi.cx/blog/?p=132] [http://david.navi.cx/blog/?p=94] [http://david.navi.cx/blog/?p=99] [http://svn.gnome.org/svn/xchat-gnome/trunk/src/libcontrast/] to automatically adjust selected or all the palette items for best visual contrast. It would also be interesting to have a layer that uses this code to filter the image.

== Arbitrary Color Channels ==

— The ability for the user to create any number of custom channels for various purposes.

== Autorecover History ==

— It would be great if autorecover could also recover the associated history of a file in the event of a crash.

== Layer Convert ==

<strike>(4)</strike> (2) — The original intent of this feature request has been solved and documented - {{l|How_do_I#Fill_an_outline.3F|How do I....Fill an Outline?}} - but it would still be nice to have a way to convert one sort of path layer to another. ''(Downgraded to level 2) {{l|User:SnapSilverlight|Snap}} 12:32, 17 Jan 2006 (PST)''

== Vector fill bucket ==

(3) — Like the traditional bitmap fill, but this fills the area clicked out to the nearest boundary paths with a region of that area, set to the foreground color (it actually would create a new {{l|Region Layer|region layer}}). <p>Alternatively, a single-duck layer object, that performs a simple bitmap fill from its (animatable) location, with its stored color value. (This second approach is similar to the behavior of one of Softimage's TOONZ[http://www.google.com/search?q=softimage+TOONZ]'s tools)</p><p>If this is implemented, it will probably be necessary to change the existing "fill" tool's name and icon to a "color injector" (hypodermic needle / turkey injector icon) tool, as that's closer to describing what it does.

*Inkscape has a very innvative version of this tool. Maybe you can just grab the code from there and integrate it in synfig? --{{l|User:SvH|SvH}} 01:37, 14 May 2008 (EDT)

== {{l|Dev:Redraw tool}} ==

(4-5) — Intutive reshaping of path-based layers. See link.

== [http://developer.gnome.org/projects/gup/hig/ Gnome HIG Compliance] ==

— This should solve all complaints about the layout, without requiring Synfig to be "just like program (x)". See {{l|Dev:UI Reloaded}} for progress on this.

== Feedback for {{l|Smooth Move Tool}} ==

(3) — This tool does what a lot of folks are looking for, warping selected ducks in a "soft" fashion. But it's not very obvious what sort of effect it will have, from the tool's interface. It needs some sort of momentary center-of-action and radius indicator at the very least. Perhaps an "influence gradient" overlaid on the canvas once Synfig's core is sped up?

== Networkability ==

(2) — Like Inkscape's "inkboard" feature (using Jabber), or Blender's Verse server [http://www.blender.org/modules/verse/index.php], or OpenCanvas's Networking option. This should probably farm off all the networking stuff to the telepathy framework so that synfig doesn't have to deal with all the account/etc issues.

== Intuitive tangent modification ==

(3) — (BBQ Pulled Duck) Inkscape has this for still handles - basically, grab a section of the spline between handles, and pull it around, the program automatically alters the tangent handles to match. What would be really neat is if you could do the same for temporal handles - be able to grab the spline between keyframes, and yank it around, and have Synfig automatically adjust the key interpolation to match. Not sure exactly what the workflow in the UI would be for this, however.

-Agreed; blender does this with its IPO curves, and it's a really efficient way to work.

== Plugin API ==

(1) — Would be nice to enable additional functionality to be added to the program without it necessarily needing to be in the Synfig source tree. ''According to the Synfig 0.61.01 roadmap on [http://deepdarc.com/ deepdarc.com], there is a plugin API already implemented. So instead, this may be a {{l|Wiki Wish List|Wiki Wish}} for documentation, depending on how much has already been completed. {{l|User:SnapSilverlight|Snap}} 19:57, 13 Jan 2006 (PST)

== Python support ==

(1) of some sort will no doubt be demanded by the userbase eventually, for studio-specific automation of tasks, noncompiled plugins, etc. I ({{l|User:Snap|SnapSilverlight}}) don't have any particular use for it at the moment, tho'.

I suppose to join this request with {{l|Dev:Wish_list#a_realtime_.sif_synchronized_text_window}}. We can implement python access to XML DOM and write XML Editor in python. --{{l|User:AkhIL|AkhIL}} 06:54, 30 April 2008 (EDT)

== mod_synfig ==

(1) — For Apache. Render .sif to some format like png/mng on access.

== synfig nsplugin ==

(1) — Let Mozilla and Mozilla-based view synfig files in-browser.

== Align function ==

(3) — Align objects at a common border (as in Inkscape)

== Improved SVG import ==

SVG import support is currently limited to paths - it does not support text or effects. [[User:Nikitakit|nikitakit]] 01:27, 14 June 2010 (UTC)

Useful would be the possibility of importing SVG sequences, just like Macromedia/Adobe Flash does with .ai sequences

== Gradient Paint Tool ==

How about a tool that can 'paint' a gradient object. For example the options would be width and gradient type, one would make a stroke with the tool and the gradient would be automatically applied inside of the outline (set by width). This would save the trouble of having to the all the encapsulation stuff. (Actually any tool that makes creating gradient one step would be good).--{{l|User:Triclops|Triclops}} 09:52, 9 Aug 2006 (PDT)

(4) Agree. 4 for usability/readability of layers reasons --[[User:Ohoservices|Ohoservices]] 11:33, 27 April 2010 (UTC)

== Bone Animation Tools ==

Bone system with inverse kinematics, very important for quick animation. You put bones on a drawed man and you can animate him like a puppet. I'm using that in Moho (lost marble product).--{{l|User:Ziolive|ziolive}} 23 Aug 2006
*I would find this very useful too. I think it is called '''rigging'''(4/5) --{{l|User:SvH|SvH}} 01:33, 14 May 2008 (EDT)
*I think this effect can be simulated by adding the correct rotation layers + encapsulation to every object that is to be restrained by joints and then linking vertices. A rotation layer center would be at the corresponding joint. We would then link the vertices of the "limbs" that shared a joint. See {{l|Doc:Cut-out Animation}} ...Perhaps this process could be made more direct through an interface that behinds the scenes creates the proper layers and reorganization all at once as the user decides to link objects to joints. ...Implementing this will involve seeing if already restrained motions allow creating joints. Also, adding a joint may clash with already existing waypoints, so waypoint conflict resolution options and rules will have to be developed. [See also an above remark in the section "Mathematical functions to animate" about linked function generator values conflicting with waypoints.] [[User:Jose X|Jose X]] 20:17, 20 May 2010 (UTC)

== AVI Backgrounds ==
Is there any way I can add an avi as a background so I could add facial expressions to a stop-motion animated figure. [zotz here, I was thinking DV background or extra timeline. I would like to mix animations with live footage. rating (3/4)]
: Already implemented for ffmpeg pipeline of ppm in svn r2161 {{l|User:Genete|Genete}} 05:36, 9 November 2008 (EST)

== Character tool on Tool Options Dialog ==

I want to use the as a character generator for a TV show. By using chroma key hide the background. Even better interface to a video overlay card with Alpha blending.

== Collect for Publication ==

(3/4) - (zotz) Menu item, functionality that would collect alll files referenced in a sif and place them all in a tgz for sending elsewhere or publishing animations in source form.

== Object Library ==

(3/4) - (zotz) Haven't thought this all through yet, but synfig could come with a library of categotrised "objects" with a copyleft license (GPL? CC BY-SA?) An animation clip art type deal.
:I'd suggest this should be public domain and distributed by openclipart.org -- --{{l|User:PaulWise|pabs}}

== Flash Export ==

(3/4) Well, might just be me but if there was a posiblity to export in .swf or .fla, I think the project might become a lot more popular.{{l|User:Conceit|Conceit}}

(4/5) I wholeheartedly agree. I would definitely use synfig more if this feature were added and it would most definitely increase popularity. {{l|User:cdj05a|cdj05a}}

(4[me]/5[others]) Definitely would love flash export. There is no well maintained Flash animation studio that is Open Source. To have Synfig become that along with all that it already is would be absolutely wonderful. You'd also possibly add to your user base all the flash animators out there that don't want to pay Adobe. Some people would only want it for the flash animation hence the 5 for others. {{l|User:jblandrum|jblandrum}}

This can be simply done from a python plugin could use SwfTools for converting temporary exported data into .swf file - not very hard thing to do - the information used from SwfTools is very simple to be created, such as simple .swf files are.

== Single window ==

Depending on individual desktop setups, single window is sometimes preferable to many windows. Can we have a single-window option?

Also, even with many windows, Windows-users especially might find it better if all the windows only appeared as a single one on the taskbar.

== Export Wizard ==

(2/4) Conversion and export to other file formats (mpg, avi, flash formats, others, and the synfig format) with a step by step wizard for choosing format and place of saving. Similar to Gimp's saving of .png files but for movie/video type files. --
{{l|User:Hiddenghost|hiddenghost}}

== Using Synfig as a portable app ==

(3) This isn't really a feature request (though it could be) but I was wondering if synfig could be used as a portable application (as in www.portableapps.com). Does the windows install require registry access? i really want to use Synfig at work, but I'm reluctant to install it just in case it leave footprints in the regisitry or something, and it would be sweet to use it on my travels as well. Only thing is, I can't test it out at home because I am using Linux.
See also: http://portableapps.com/node/5761
{{l|User:Zenoscope|zenoscope}}

This isn't currently possible without modifying the source code. That has been on my TODO list for ages {{l|User:PaulWise|pabs}} 01:17, 26 October 2007 (EDT)

== Allow organize child valuenodes in an hierarchy ==
(3-2) And allow maintain the organization once the file is saved. At the moment they are reordered in alphabetical order which is useless and annoying.

== Triangle sliders to be always visible ==
(3) I would like that the triangle sliders from {{l|Colors Dialog}} and {{l|Gradient Editor Dialog}} were visible whatever color or channel you're editing. Some times when the color or channel is to bright or light the slider is difficult to distinguish. --{{l|User:Genete|Genete}} 14:30, 29 October 2007 (EDT)

This is important for usability, should be solved soon.
--[[User:Ohoservices|Ohoservices]] 10:49, 27 April 2010 (UTC)

== XICC support ==

It would be cool if synfigstudio had support for [http://burtonini.com/blog/computers/xicc XICC].

== Area to Edit ==

An option like blender - select area to update would be nice, so the only part of the image that updates when you add or change something is in the selected area

ie. when working on a complex composition, studio doesn't know, when I tweak a tiny part of the composition, that only that part needs redrawing, so it redraws the whole thing. It would be good if there was some way of telling it which part to focus on. -- {{l|User:Dooglus|dooglus}} 04:02, 3 February 2008 (EST)

== Histograms ==

01:23 * AkhIL wish to have histograms and luma/color scope like [http://mac.softpedia.com/progScreenshots/Avid-Xpress-DV-Screenshot-14207.html] in synfig

I've looked at those pictures but don't know what they're showing. Can you describe what those scopes are doing, and what the histograms display? ie. what are the X and Y axes of the histograms? -- {{l|User:Dooglus|dooglus}} 04:07, 3 February 2008 (EST)

First look this description in blender wiki [http://wiki.blender.org/index.php/Manual/VSE_Modes]

Ok There is four things.
* Upper left is Lumascope (Luma Waveform in blender). X-Axis represents image's X-Axys. Y-Axis is average luminescence of column of pixels.
* Upper right is Chromascope (Chroma Vectorscope in blender). Just look description on blender wiki.
* Lower left is like Lumascope but for each channel
* Lower right is histograms. X is luminescence and Y is count of pixels with such luminiscence.

== Sound Layer ==

(4) It would be a very good improvement if the sound system were implemented into synfig in {{l|Dev:Sound Layer | this}} way. --{{l|User:Genete|Genete}} 07:46, 8 February 2008 (EST)

== Rearrange the view of waypoints for Canvas param ==
As reported in [http://sourceforge.net/tracker/index.php?func=detail&aid=1888858&group_id=144022&atid=757416 Bug #1888858] waypoints are not displayed for canvas switch events.
I suggest to rearrange waypoints display according to {{l|Media:Canvas_prop.png|this scheme}}.

== Width weigths ==
Is it possible to add "weigths" for widths? ^_^ I.e. width changes not all the way along the segment. Maybe something like a duck on bline which indicates the region where the width of current vertex isn't changed.
{{l|Media:width-proposal.png|Illustration here.}}

More ideas around this concept in [http://dooglus.rincevent.net/synfig/logs/2008/%23synfig-2008-04-16.log this conversation]. Although the log of that day is very interesting the lines related to this idea are from 22:38 to 23:43. {{l|User:Genete|Genete}} 17:51, 16 April 2008 (EDT)

== Improved Colour Dialog ==
How easy is it to stick in a colour square/wheel? Messing with sliders is somewhat obstructive.

== Insert Waypoints ==
A button to create a waypoint for every selected duck, in its current position. Moving each duck up a bit and down again quickly gets tedious.
:If the duck in question has already a waypoint then you don't need to move it to create a new waypoint. Just select the corresponding parameter in your child list panel and select 'Add Waypoint' from the right click context menu over the parameter. No need to have the duck selected. If you want to freeze the entire bline just do that over the Bline Point List. {{l|User:Genete|Genete}} 07:48, 29 April 2008 (EDT)
::Yes, but it would be nice to have opportunity to add waypoint to parameer which not have any ducks yet (i.e. non-animated parameter). --{{l|User:Zelgadis|Zelgadis}} 08:33, 29 April 2008 (EDT)

== Automatically split tangeants ==

Holding shift while moving tangeant ducks should automatically split them. They can be rejoined if necessary through the context menu as they are now.

== A way to link params without exporting ==
I need a way to link params with different names without exporting. It is possible to achive by manualy editing of sif file. But inposible by gui. I will be nice to have linking by drag-n-drop. Or just by selecting reference param, pushing copy button, selecting another param and bushing link button. ---{{l|User:AkhIL|AkhIL}} 21:47, 30 May 2008 (EDT)

== Allow select the origin of rotation when using the Rotate Tool ==

It can be initially set to the geometrical center of the selected ducks or the gravity center depending of the selected checkboxes in the tool options panel. Later the user could move it before perform the rotation operation. It is a waste of time to rotate and translate the ducks every time a rotation manipulation is done. ---{{l|User:Genete|Genete}} 12:16, 4 June 2008 (EDT)

:I was adding this request at the same time than you Genete :-). Here is an example of how this issue is solved in Inkscape:

:{{l|Image:rotate-tool-inkscape.png|center}}

:---{{l|User:Yaco|Yaco}}

== Non-symetrical but "smooth" tangents on ducks ==
Add another mode for duck tangent, where the tangent can have different radius, but keep the same angle. (a "split tangents (radius only)" mode).

== Dockable windows ==
The current GUI is a pain in the rear by not complete covering the desktop and it's showing 5 tabs instead of usual one tab so it's frustrating to switch windows if you running more than one software. (windows version)

:--{{l|User:super animator|super animator}}

== A Particle Tool/Particle Object Editor ==
I thought it might be interesting to add a Particle tool that is intuitive. Genete's script is amazing and I am sure I will do a lot of things with it once I have a chance to sit down and figure it out, but if there were a way to make it into tool with all the settings on sliders, it would be much easier. His script adds endless possibilities of nice effects to make animations look better. I personally rate this rather high. 3.5/5

:--{{l|User:richardwad1|richardwad1}}

== A programation language as code behind like python, ruby or any ==
Code behind should be important to program the animation or events associated, programers and designers could work in a colaborative workspace and make applications with richfull content on desktop applicactions or web applications like expression blend or macromedia flash CS.

:--{{l|User:nickholai|nickholai}}

== Embedding animation on web applications ==
Like Macromedia Flash, it seems to require a plug in for internet explorer or firefox diferent as silverlight or flash, open source and "software libre" projects are working on animation but using the flash plug in, this wish needs a free plug in.

:--{{l|User:nickholai|nickholai}}

This seems a bit confusing; why do you want a plug in for synfig? When we add the import and export swf. file feature, it will use the flash plug in. Besides the flash player program is free, so you don't have to pay anything. I find that this feature is useless until you explain to us better why you think this software needs a plug-in.

Create a thread in the synfig forum if you want to continue to talk about this. We're listening.
:--{{l|User:super animator|super animator}}

:Support for svg export would solve the problem (I think), to the extent svg plugins work well (and svg is a more open format than is swf). Would sifz -> svg -> sifz possibly result in data loss/ambiguity (eg, with names)? I don't think sifz has interactivity, right (eg, mouse events that control the visual)? [[User:Jose X|Jose X]] 04:20, 20 May 2010 (UTC)

== Split Tangent indicator ==

Its hard to tell if a tangent is split or not without clicking on it (either to use the context menu, or move a duck). All of the ducks should change to another shape (eg a square) for a quick visual indication of a ducks state.

:---{{l|User:zenoscope|zenoscope}}

== Guide lines ==

Guide lines that can be dragged from the side (like in the Gimp) would be very
useful.
:---{{l|User:zenoscope|zenoscope}}

== Progress indicators ==

Eg % complete in opening file, pop-up window which indicates how many frames are rendered of a render, eg "rendering 10 of 999" that can be closed/ignored if needed.
:---{{l|User:zenoscope|zenoscope}}

== Improve the Timeline ==

I know, this is one hell of a wish, but, as in all, i think that is best if you think in the ideals conditions and then you downgrade into what is possible to achieve in a reasonable period of time.

:D greetings!!

[4] Normal mode // [4] Layer mode // [4] Secuence mode

.I think that this modes are three diferent windows layout, therefore the hability to create new and save different windows layout, should be the first to do in order to achieve this three modes.

{{l|Image:Timeline-normal-mode-explained.jpg|200px}} {{l|Image:Timeline-layer-mode-explained.jpg|200px}} {{l|Image:Timeline-secuence-mode-explained.jpg|200px}}

(click to enlarge)

02/01/2009 {{l|User:Belifilmaker|Belifilmaker}}

== Lockable Layers ==
I would use them all of the time.
{{l|User:Zenoscope|Zenoscope}}

== Vector Objects ==
Represent objects (ie. circles, rectangles, regions, outlines, etc) as a new type of element. These objects exist as childs of some layer. The layer then takes care of rendering these objects to a raster. Currently layers do both things, represent objects and render them.

Having objects as a seperate entity would allow defining operations between them. For example:
* Take two region objects and find the union of their regions. This would produce a vector representation of the resulting region (ie. Bline) which in turn can be used for other operations (ie. link vertex to Bline).
* Apply transformation to a vector object producing a vector object as a result which can be further processed.
* Trace a {{l|Media:Smooth_silhoutte.png|smooth silhoutte}} around a set of vector objects.
* Slice an animated vector object into pieces and be able to move the pieces around (while preserving the original animation). Would be useful for reflection on a broken glass effect.

:---{{l|User:Yoyobuae|Yoyobuae}}

== Free drawing ==

I wish the synfig have ability to do paintings like with brush and eraser. Imagine: you painting over Paste canvas, and synfig automatically creates shapes inside this Paste canvas layer, doing necessary boolean operations and linking between them. So they don't overlap. This would allow flash-like workflow, which is very suitable for newbies. {{l|Dev:Free Drawing|Discussion.}} --{{l|User:Zelgadis|Zelgadis}} 15:27, 9 April 2009 (EDT)

:Even a simpler manifestation of this wish, an eraser feature for the sketch tool, would come in very handy. [[User:Jose X|Jose X]] 19:53, 20 May 2010 (UTC)

== Projection Layer ==

The projection layer (a new type of transformation layer) would have two angle parameters that define how the lower layers get transformed: as if projected from a canvas angled in 3D space unto a 2D final image. By combining different encapsulations that use the projection layer, we can facilitate some 3D animation realism from simple 2D manipulations.
[[User:Jose X|Jose X]] 22:14, 20 May 2010 (UTC)

== New Gradient Tool icon ==
[3] The Rectangle Tool and Gradient Tool have almost identical icons. One of them should be changed.
Arbitrary suggestion: Make the Rectangle's icon a rectangle instead of a square, with a solid fill, and make the Gradient's icon a coloured gradient instead of grey.

== Arrowheads ==
[4] I use Synfig for animations that go in instructional videos. I currently use the Polygon tool for making arrows, but it would be a lot faster if Bline layers had a property for putting shapes like arrowheads at the ends of the path.[[User:Envergure|Envergure]] 18:17, 21 May 2010 (UTC)

:In addition:

:*The ability to stroke bline paths so as to have the outline be made up of a series one or more arbitrary shapes (ie, besides lines) would also be useful since this would facilitate the animation of discrete objects that relate to each other in space and across frames.

:*Having a shapes repository would be very useful [and with an improved synfig import mechanism that allows exported variables from imported canvases to be seen and be accessible automatically under the imported canvas' namespace -- this would facilitate the use of these .sif libraries/plugins]. And a community of people can collaborate on writing programs to help find shapes that meet certain specs: for example, just like we can write a program to find the optimal way to set up N blines to minimize squared error(?) estimation of a circle, we can write other programs to find how N blines might represent hemi-sphere and many other shapes as faithfully as possible. [Contrast with having users create standard shapes out of blines but using subjective criteria.]

:*A special raster and vector library and set of tutorials can be created to help with the creation of tutorials for synfig documentation. Eg, include png files for "every" view of synfig (eg, every menu entry, panel view, button, etc); have arrows, boxes, bubbles, and other synfig "widgets" that are likely to be used in videos; and include good tutorials and set of instructions for using this art/animation library to build videos or simulated screenshots, etc.
:::Side effects of this doc project would include helping more people get involved with synfig, motivating more people be able to build such documentation/instructions for projects beyond synfig (though perhaps using synfig to create the scenes), and helping to create a standard set of pictures and best practices for synfig so that the synfig docs will tend towards uniformity (to the degree this is desirable).

Releases

2009-11-01T05:02:21Z

Nikitakit:

Announcements for all the releases of synfig that have been made:

The pages below have been moved to the website:
* {{l|Releases/0.61.09|0.61.09}} - October 21st 2008
* {{l|Releases/0.61.08|0.61.08}} - March 3rd 2008
* {{l|Releases/0.61.07|0.61.07}} - October 9th 2007
* {{l|Releases/0.61.07-rc1|0.61.07-rc1}} - October 6th 2007
* {{l|Releases/0.61.06|0.61.06}} - June 24th 2007
* {{l|Releases/0.61.05|0.61.05}} - February 27th 2006
* {{l|Releases/0.61.03|0.61.03}} - December 8th 2005
* {{l|Releases/0.61.02|0.61.02}} - November 26th 2005
* {{l|Releases/0.61.01|0.61.01}} - November 6th 2005 '''passed'''
* {{l|Releases/DeveloperPreview|Developer Preview}} - November 1, 2005 (first release with source code) '''passed'''
* {{l|Releases/Splash_Archive|Splash Archive}}

File:Logo-1.png

2009-11-01T04:34:31Z

Nikitakit: uploaded a new version of "File:Logo-1.png": Resize to 50%

Cut the Circle logo

Releases

2009-10-12T22:50:50Z

Nikitakit: Move pages to Website

Doc:Slideshow Tutorial

2009-09-12T05:19:45Z

Nikitakit: Add to tutorials category

{{l|Category:Tutorials}}

In Synfig, there are many ways to create a slideshow from a series of images. Probably the simplest is using the {{l|ListImporter|List Importer}} to import a series of images. However, the method only works on raster images and is incapable of generating transitions. The technique described here is only slightly more complex, but it allows creating a presentation from a series of Synfig layers, regardless of type of size. The method can only produce cross-fade transitions; anything more complex would require a more advanced technique.

==Technical Description==

Synfig animates with a series of layers, each of which exists throughout the entire timeline. Hence, our goal is to make only one of the layers visible at any given time. Though there are many ways to achieve this goal, this tutorial will assure that only one layer is seen by using the {{l|Blend_Method_Parameter|Blend}} and {{l|Amount_Parameter|Amount}} parameters of each layer.

All graphical layers in Synfig have these two essential properties. The {{l|Blend_Method_Parameter|Blend Mode}} defines how the image should be layered on everything below it, and the Amount dictates to what extent the blending is done. In the default blend mode, {{l|Blend_Method_Parameter#Composite|Composite}}, objects are simply placed on top of everything below them. In this case, the Amount value determines the overall transparency of the layer: at a value of 1.0, the layer is fully visible; at 0.0, it is entirely transparent. In-between values constitute partial transparency, which will form the transitions. These properties can be used to display a series of pictures. Each is its own layer and at any given point in time, one layer's amount is set to 1.0 while all others equal 0. However, there is a more efficient way of accomplishing the task. This method requires switching all images to the {{l|Blend_Method_Parameter#Straight|Straight}} blend mode.

This blend mode has an advantage: all layers below the current one are hidden. Therefore it is no longer necessary for layers below the current one to have a an Amount of 0. Using the Amount for crossfade still works, but it now needs to be changed only once: all layers start with a value of 1, and then be made transparent from the highest to the lowest.

The effect could be animated with two waypoints per layer. However, Synfig offers an even simpler method that does not require using the animation mode. Instead, linking functionality can be used. The data type for Amount is currently set to be a real number. Instead, let's replace that with a special function by converting the layer to {{l|Convert#Timed_Swap|Timed Swap}}.

{{l|Image:Slideshow_amount4.png}}

Now we examine the parameters of this new data type. The first is the initial value (1.0), the second is the final value (0.0), and the third is the time when the values will switch. If we want the image to display for two seconds, we can set the Swap Time to "2s". (Note: this assumes we are starting at 0s). Then the amount will be 1.0 for three seconds (image visible) and 0 for the remainder of the timeline (image hidden). The last value will be the duration of the crossfade transition. Note that the transition takes away from the time for which the image will be displayed. For example, a value of "1s" means that the image will be fully opaque for one second, fade in one second, and then remain faded for the remainder of the animation.

Applying successive times to layers from the top down will fade them one by one, creating the desired slideshow effect.

==Step-by-Step Instructions==
Here are step-by-step instructions for applying this principle to an animation.

===Setting Up===
Open a Synfig document and import any images, canvases, etc. Images can be imported using >File>Import (The first ">" signifies the {{l|Canvas_Menu_Caret|Caret Menu}}). Note that importing ''links'' to the image using a ''relative'' path. Take care to maintain the relative positions of the files when moving them. If multiple layers represent a single image, encapsulate them into an {{l|Inline Canvas}}.
Then arrange the images in the order they will be displayed, first image on top.

===Blend Method===
Select all layers in the layer panel. Then go to the parameters panel and set the Blend Method to Straight.
{{l|Image:Slideshow_blend1.png}}{{l|Image:Slideshow_blend2.png}}

===Timed Swap===
Unlike Blend Mode, converting to {{l|Convert#Timed_Swap|Timed Swap}} must be done individually for each layer.
Set "Before" to 1.0 and "After" to 0.
Suppose you want the images to swap every 4 seconds, using 1 second transitions. Then set the "Duration" to "1s". Afterwards, set Time for the first layer to 4+1=5. Then increase the time for each successive layer (5,10,15,20,...). The Swap Time is the point where the image fully disappears. Configure these values to fit your needs.

{{l|Image:Slideshow_amount1.png}} {{l|Image:Slideshow_amount2.png}}
{{l|Image:Slideshow_amount3.png}} {{l|Image:Slideshow_amount4.png}}

===Animation Length===
Now that times have been configured, your file must be configured to render the full animation length. Go to >Edit>Properties and switch to the "Time" tab. Set the end time to equal the last of your time values. You can add a few seconds if you want a blank/black screen at the end, after the images have faded.

===Extra: Background===
You may have noticed that the Straight Blend Mode removes any backgrounds from the image. Here are two methods to add a background:

a) Encapsulate all image layers. Now the Straight blend mode only works within the inline canvas. Once this is done, add any backgrounds below the canvas, and any foreground above the canvas.

b) Add a background layer/canvas to the ''top'' of the layer list. Since it is above all other layers, the Straight layering mode doesn't affect it. However, it would normally shroud all the images. To make it appear below everything else, set the Blend Mode to {{l|Blend_Method_Parameter#Behind|Behind}}.

==Endnotes==

Congratulations! You have now finished reading the slideshow tutorial. Please leave me (nikitakit) a comment about your thoughts concerning this page.

GNU/Linux users may also be interested in [http://akhilman.googlepages.com/images2sif.sh AkhIL's imag2sif shell script]. It imports images into Synfig and creates a rotate and translate layer for each.

The explanation of the "Straight" blend mode in this tutorial lacks a screenshot. Feel free to add one.

Convert

2009-05-03T16:05:40Z

Nikitakit: Edit Bool; add "Power" /* Which Value Types can use which Convert Types? */

Right-clicking on a value in the Parameters dialog brings up a context menu which has a sub-menu called "Convert". The "Convert" menu allows you to specify that the parameter should be controlled automatically in various ways. Depending on the type of the parameter the Convert menu will contain different options.

To convert the value back to its original type, select "Disconnect" from its context menu.

== Convert Types ==

=== Add ===

Converting a parameter to "Add" adds three sub-parameters, the first two of which are the same type as the parameter itself:
* <param> "LHS"
* <param> "RHS"
* real "Scalar"

The "Add" conversion can be used with parameters of type [[Convert#Angle|angle]], [[Convert#Color|color]], [[Convert#Gradient|gradient]], [[Convert#Integer|integer]], [[Convert#Real|real]], [[Convert#Time|time]], and [[Convert#Vector|vector]].

The resulting value is:
(LHS + RHS) * Scalar

=== And ===

Converting a [[Convert#Bool|bool]] parameter to "AND" adds two sub-parameters:
* bool "Link1"
* bool "Link2"

The resulting value is true only if both Link1 and Link2 are true.

=== Angle String ===

Converting an [[Convert#String|string]]-valued parameter to "Angle String" adds four sub-parameters:
* angle "Angle"
* integer "Width"
* integer "Precision"
* bool "Zero Padded"

The resulting value a string containing the value of "Angle" (in degrees) formatted as a string with a minimum width "Width", with "Precision" decimal places. If "Zero Padded" is true, it will be left-padded with "0" characters.

=== aTan2 ===

Converting an [[Convert#Angle|angle]]-valued parameter to "aTan2" adds two sub-parameters:
* real "X"
* real "Y".

The resulting value is:
atan2(y,x)

ie. atan(y/x) but without an error when x is 0. The value is the angle between the x axis and the vector (x,y).

=== BLine ===

Converting a [[Convert#List|list]] parameter to "BLine" doesn't seem to change anything. Perhaps that's the default type for lists of vertices, such as are found in outlines and regions?

=== BLine Tangent ===

Converting a [[Convert#Angle|angle]], [[Convert#Real|real]] (since SVN r1862), or [[Convert#Vector|vector]] parameter to "BLine Tangent" adds six sub-parameters:
* bline "BLine"
* bool "Loop"
* real "Amount"
* angle "Offset" (since SVN r1863)
* real "Scale" (since SVN r1863)
* bool "Fixed Length" (since SVN r1863)

Amount is a number between 0 and 1, defining the distance along the given bline. The resulting value for the whole parameter is the tangent to the bline, at the given point along the bline, optionally rotated and scaled according to the "Offset", "Scale", and "Fixed Length" parameters.

"Offset" is an angle used to give the tangent an extra rotation before returning it. If "Fixed Length" is true, the tangent is then scaled to have a length equal to "Scale". Otherwise the tangent is multiplied by "Scale".

If a vector was converted the result is the tangent itself. If an angle was converted, the result is the angle of the tangent to the horizontal, and if a real was converted, the result is the length of the tangent.

This [[Following a BLine|tutorial]] gives an example of the use of this convert type.

=== BLine Vertex ===

Converting a [[Convert#Vector|vector]] parameter to "BLine Vertex" adds three sub-parameters:
* bline "BLine"
* bool "Loop"
* real "Amount"

Amount is a number between 0 and 1, defining the distance along the given bline. The resulting value for the whole parameter is a vector giving the position of the given point along the bline.

This [[Following a BLine|tutorial]] gives an example of the use of this convert type.

=== BLine Width ===

Converting a [[Convert#Real|real]] parameter to "BLine Width" adds three sub-parameters:
* bline "BLine"
* bool "Loop"
* real "Amount"
* real "Scale" (since SVN r1872)

Amount is a number between 0 and 1, defining the distance along the given bline. The resulting value for the whole parameter is the width of the bline at the given point along it, multiplied by the "Scale" parameter.

=== Compare ===

Converting a [[Convert#Bool|bool]] parameter to "OR" adds five sub-parameters:
* real "LHS"
* real "RHS"
* bool "Greater than"
* bool "Equal to"
* bool "Less than"

The valuenode compares LHS and RHS. The three boolean values determine which comparison returns true. For example, if LHS>RHS and "greater than" is checked, the valuenode will evaluate to "true".

=== Composite ===

Converting a [[Convert#BLinePoint|blinepoint]] parameter to "Composite" adds six sub-parameters:
* vector "Vertex"
* real "Width"
* real "Origin"
* bool "Split Tangents"
* vector "Tangent 1"
* vector "Tangent 2"

Converting a [[Convert#Color|color]] parameter to "Composite" adds four real-valued sub-parameters:
* real "Red"
* real "Green"
* real "Blue"
* real "Alpha"

Converting a [[Convert#Segment|segment]] parameter to "Composite" adds four vertex sub-parameters:
* vertex "Vertex 1"
* vertex "Tangent 1"
* vertex "Vertex 2"
* vertex "Tangent 2"

Converting a [[Convert#Vector|vector]] parameter to "Composite" adds two real-valued sub-parameters:
* real "X-Axis"
* real "Y-Axis"

The resulting value is a blinepoint, color, segment, or vector made by combining the component parts.

=== Cos ===

Converting a [[Convert#Real|real]]-valued parameter to "Cos" adds two sub-parameters:
* angle "Angle"
* real "Amplitude".

The resulting value is:
Amplitude * cos(Angle)

=== Dot Product ===

Converting a [[Convert#Real|real]] or [[Convert#Angle|angle]] parameter to a "Dot Product" adds two sub-parameters:
* vector "LHS"
* vector "RHS"

If the converted value is an angle, the return value is the angle between the two vectors:

return = acos((LHS · RHS) / (|LHS| * |RHS|))

If the converted value is a real, the result value is the dot product of the two vectors:

return = LHS · RHS = |LHS| * |RHS| * cos(alpha)

(where alpha is the angle between LHS and RHS).

=== Duplicate ===

This ValueNode type is only used by the [[Duplicate Layer]]. It never appears in the Convert menu. It is used to control the range of the Index in the Duplicate Layer (q.v.).

The "Duplicate" ValueNode type has 3 real-valued sub-parameters:

* real "From"
* real "To"
* real "Step"

The value of the ValueNode varies from the value of "From" to the value of "To" in steps of size "Step". The sign of "Step" is ignored. If From<To the steps are positive, else they're negative.

=== Dynamic List ===

Converting a [[Convert#List|list]] parameter to "Dynamic List" seems to replace each of the "Vertex NNN" sub-parameters with "Item NNN" parameters which can't be expanded, but can be exported.

=== Exponential ===

Converting a [[Convert#Real|real]] parameter to "Exponential" adds two sub-parameters:

* real "Exponent"
* real "Scale"

The resulting value is the result raising the [http://en.wikipedia.org/wiki/E_%28mathematical_constant%29 mathematical constant 'e'] to the power of Exponent, and scaling the result by Scale. That is, it returns:
Scale * e^Exponent

This is useful for tracking layers which have been zoomed, since the Zoom layer scales by e^(zoom factor).

See [http://youtube.com/watch?v=GAWtndOHkUw this video] for an example of the use of this convert type.

=== From Integer ===

This is currently disabled. It converts an integer to one of several types.

=== Gradient Color ===

Converting a [[Convert#Color|color]] parameter to "Gradient Color" adds two sub-parameters:

* gradient "Gradient"
* real "Index"

The resulting value is a color taken from the gradient at the given index position. Index 0 corresponds to the left of the gradient; index 1 corresponds to the right of the gradient.

=== Gradient Rotate ===

Converting a [[Convert#Gradient|gradient]] parameter to "Gradient Rotate" adds two sub-parameters:

* gradient "Gradient"
* real "Offset"

The resulting value is a gradient based on the "Gradient" parameter, but shifted left (for negative values) or right, according to the value of the "Offset" parameter. An offset of 1.0 will shift the gradient by its entire visible width. Values shifted off the left or right edge aren't lost - they aren't visible in the gradient as it's displayed in the parameters dialog, but they will still be used when rendering (depending on parameters such as 'Loop' and 'Zigzag', which can cause gradients to be looped between their their left and right edges, rather than using the non-displayed parts).

=== Int String ===

Converting an [[Convert#String|string]]-valued parameter to "Int String" adds three sub-parameters:
* integer "Int"
* integer "Width"
* bool "Zero Padded"

The resulting value a string containing "Int" formatted as a string with a minimum width "Width". If "Zero Padded" is true, it will be left-padded with "0" characters.

=== Joined List ===

Converting a [[Convert#String|string]] parameter to be 'Joined List' adds four sub-parameters:
* list "Strings"
* string "Before"
* string "Separator"
* string "After"

The result is a string containing the value of "Before", followed by all the strings in the "Strings" list, with the value of "Separator" between each pair, followed by the value of "After".

=== Linear ===

Converting an [[Convert#Angle|angle]] parameter to be 'Linear' adds two angle sub-parameters:
* angle "Rate"
* angle "Offset"

Converting a [[Convert#Color|color]] parameter to be 'Linear' adds two angle sub-parameters (since svn r617):
* color "Rate"
* color "Offset"

Converting an [[Convert#Integer|integer]] parameter to be 'Linear' adds two angle sub-parameters (since svn r617):
* integer "Rate"
* integer "Offset"

Converting a [[Convert#Real|real]] parameter to be 'Linear' adds two real-valued sub-parameters:
* real "Rate"
* real "Offset"

Converting a [[Convert#Time|time]] parameter to be 'Linear' adds two time sub-parameters:
* time "Rate"
* time "Offset"

Converting a [[Convert#Vector|vector]] parameter to be 'Linear' adds two vector sub-parameters:
* vector "Slope"
* vector "Offset"

The parameter's value will change linearly over time, starting with the value specified by "Offset" at time zero, and increasing by the value specified by "Rate" (or "Slope", in the case of vector parameters) every second.

The resulting value for vector parameters is:
Offset + Slope*time

and for the other 5 types of parameter it is:
Offset + Rate*time

=== Logarithm ===

Converting a [[Convert#Real|real]]-valued parameter to "Logarithm" adds three sub-parameters:

* real "Link"
* real "Epsilon".
* real "Infinite".

The resulting value is:

Log(Link) (if Link >= Epsilon)
-Infinite (if Link < Epsilon)

The epsilon and infinite parameters are only needed to prevent logarithm of negative or zero numbers. For regular operation the resulting value is simply the natural logarithm of Link. In fact a logarithm of a negative number cannot be calculated in the space of Real numbers. This convert type returns -Infinite for simplicity.

=== Not ===

Converting a [[Convert#Bool|bool]] parameter to "NOT" adds one sub-parameter:
* bool "Link"

The resulting value is the opposite of Link.

=== Or ===

Converting a [[Convert#Bool|bool]] parameter to "OR" adds two sub-parameters:
* bool "Link1"
* bool "Link2"

The resulting value is true if either link1, link2, or both are true.

=== Power ===

Converting a [[Convert#Real|real]]-valued parameter to "Power" adds three sub-parameters:
* real "Base"
* real "Power"
* real "Epsilon".
* real "Infinite".

The resulting value is Base^Power if the operation is defined.
The undefined cases will also return a value (to avoid errors):
0^0 = 1
0^-x = +/- infinite
If a negative base is raised to a noninteger power, the power is rounded (typecast) to an integer

The epsilon and infinite parameters are only needed to prevent division by zero.

=== Radial Composite ===

Converting a [[Convert#Color|color]] to "Radial Composite" adds four sub-parameters:
* real "Luma"
* real "Saturation"
* angle "Hue"
* real "Alpha"

Converting a [[Convert#Vector|vector]] to "Radial Composite" adds two sub-parameters:
* real "Radius"
* angle "Theta"

For color parameters, the resulting value is the color with the given lima, saturation, hue, and alpha amounts.

For vector parameters, the resulting value is the point reached by traveling a distance "Radius" from the origin, in the distance given by the angle "Theta".

=== Random ===

Converting a parameter to "Random" adds five sub-parameters, the first of which is the same type as the converted parameter:

* <param> "Link"
* real "Radius"
* integer "Seed"
* real "Animation Speed"
* integer "Interpolation"
* real "Loop Time" (since SVN r2315)

"Random" can be used on [[Convert#Angle|angles]], [[Convert#Color|colors]], [[Convert#Integer|integers]], [[Convert#Real|reals]], [[Convert#Time|times]], and [[Convert#Vector|vectors]].

It is used to cause a parameter's value to vary randomly over time, around a central value:

* "Link" provides the central value.
* "Radius" defines the maximum random difference.
* "Seed" seeds the random number generator
* "Animation Speed" defines how often a new random value is chosen (in choices per second)
* "Interpolation" determines how the value is interpolated from one random choice to the next. Possible values are:
** 0 - no interpolation; the value jumps from one value to the next
** 1 - linear interpolation
** 2 - cosine
** 3 - spline
** 4 - cubic (the default); uses [http://www.gamedev.net/reference/articles/article1497.asp Catmull-Rom] spline interpolation
* "Loop Time" (added in SVN r2315) makes the random value repeat after the given time. The value ends up the same at the given time as at time=0 so it's possible to make random looping animations without a nasty jump when the time wraps back to zero.

The "Interpolation" sub-parameter should really be a drop-down menu, rather than an integer field, but that isn't yet implemented.

=== Range ===

Converting a parameter to "Range" adds three sub-parameters, all the same type as the parameter itself:
* <param> "Min"
* <param> "Max"
* <param> "Link"

"Range" can be used on [[Convert#Angle|angles]], [[Convert#Integer|integers]], [[Convert#Real|reals]], and [[Convert#Time|times]].

It is used to limit the value of the linked parameter to be between Min and Max.

The resulting value is:
Min (if Link < Min)
Max (if Link > Max)
Link (otherwise)

=== Real String ===

Converting a [[Convert#String|string]] parameter to "Real String" adds four sub-parameters:

* real "Real"
* int "Width"
* int "Precision"
* bool "Zero Padded"

The result is a string formatted to contain the given value "Real". "Width" specifies the minimum field width, "Precision" specifies the number of decimal places and "Zero Padded" specifies whether to pad with zeros on the left hand side.

For example, with Real=3.1415, Width=6, Precision=2, and ZeroPadded=true, we get:
"003.14"
(6 characters long, 2 decimal places, and padded with zeros on the left).

=== Reciprocal ===

Converting a [[Convert#Real|real]]-valued parameter to "Reciprocal" adds three sub-parameters:
* real "Link"
* real "Epsilon".
* real "Infinite".

The resulting value is:
1/Link (Link <= -epsilon or epsilon <= Link)
Infinite (if 0 <= Link < epsilon)
-Infinite (if -epsilon < Link < 0)

The epsilon and infinite parameters are only needed to prevent division by zero. For regular operation the resulting value is simply the reciprocal of Link.

=== Reference ===

Converting a parameter to "Reference" adds a single sub-parameter called "Link". The "Link" parameter is the same type as the parameter being converted.

It doesn't seem to do anything at all, other than adding an extra parameter. Whatever value is put into "Link" becomes the value of the parameter being converted.

The only use for this conversion type I can think of is the following:

* you know that point A should follow point B, so you export point B and connect point A to it
* you're not yet sure exactly how point B should move, so you experiment with different conversion types for point B
* changing the conversion type for point B breaks the connection you made in the first step
* converting point B to be a reference, and then experimenting with different conversions in its "Link" parameter allows point A to connect to point B and for the connection to remain in place while you experiment in the "Link" parameter

The resulting value is:
Link

=== Repeat Gradient ===

Converting a [[Convert#Gradient|gradient]] parameter to "Repeat Gradient" adds seven sub-parameters:
* gradient "Gradient"
* integer "Count"
* real "Width"
* bool "Specify Start"
* bool "Specify End"
* color "Start Color"
* color "End Color"

The resulting value is a gradient containing "Count" equally spaced, equally wide copies of gradient "Gradient". Each copy has "Gradient" going forwards and then backwards. "Width" specifies relative width of the forward copy, with a width of 0 or less meaning only the backward copy is used, and a width of 1 or more meaning only the forward copy is used. A value of 0.5 will result in the forward and reverse copies of "Gradient" being the same width.

If "Specify Start" is checked then "Start Color" will be inserted at the beginning of the new gradient, otherwise the beginning of "Gradient" will be used as the beginning of the new gradient.

If "Specify End" is checked then "End Color" will be appended to the end of the new gradient, otherwise the end of "Gradient" will be used as the end of the new gradient.

Here's an example of a repeated gradient - the radiating green/yellow lines are a repeated gradient, applied to a perpendicular curve gradient. This gradient was repeated with a width of 0.5, meaning it is used backwards and forwards the same amount:

[[Image:Repeat-gradient-valuenode-gradient.png]]

and here's the resulting image, along with the .sif file:

[[Image:Repeat-gradient-valuenode.png]]
[[Image:Repeat-gradient-valuenode.sif]]

=== Reverse Tangent ===

Converting a blinepoint parameter to "Reverse Tangent" adds two sub-parameters: one called "Reference" of type BLinePoint, and a boolean parameter called "Reverse".
* BLinePoint "Reference"
* bool "Reverse"

"Reverse Tangent" can only be used on [[Convert#BLinePoint|blinepoints]].

The resulting value is the same as the reference BLinePoint, but with its tangents switched over. This is useful when attempting to link the verticies of a region to the vertices of an outline when the region and the outline were drawn in opposite directions, and so tangent1 of an outline vertex needs to be linked to tangent2 of the region vertex, and vice versa.

=== Scale ===

Converting a parameter to "Scale" adds two sub-parameters: one called "Link", of the same type as the parameter itself, and a real-valued parameter called "Scalar".
* <param> "Link"
* real "Scalar"

"Scale" can be used on [[Convert#Angle|angles]], [[Convert#Color|colors]], [[Convert#Integer|integers]], [[Convert#Real|reals]], [[Convert#Time|times]], and [[Convert#Vector|vectors]].

The resulting value is:
Link * Scalar

=== Segment Tangent ===

Converting a [[Convert#Vector|vector]] parameter to "Segment Tangent" adds two sub-parameters:
* segment "Segment"
* real "Amount"

Amount is a number between 0 and 1, defining the distance along the given segment. The resulting value for the whole parameter is the tangent to the segment, at the given point along the segment.

=== Segment Vertex ===

Converting a [[Convert#Vector|vector]] parameter to "Segment Vertex" adds two sub-parameters:
* segment "Segment"
* real "Amount"

Amount is a number between 0 and 1, defining the distance along the given segment. The resulting value is the vertex at the given point along the segment.

=== Sine ===

Converting a [[Convert#Real|real]]-valued parameter to "Sine" adds two sub-parameters:
* angle "Angle"
* real "Amplitude".

The resulting value is:
Amplitude * sin(Angle)

=== Step ===

Converting an [[Convert#Angle|angle]], [[Convert#Color|color]], [[Convert#Integer|integer]], [[Convert#Real|real]], [[Convert#Time|time]], or [[Convert#Vector|vector]] parameter to be 'Step' adds four sub-parameters:
* <param> "Link"
* time "Duration"
* time "Start Time"
* real "Intersection"

The parameter's value will change in steps. Each step is "Duration" seconds long. The steps start at times "Start Time", "Start Time"+"Duration", etc. The value of the valuenode is the value of "Link" at some time. "Intersection" determines which time is used. An "Intersection" of 0.0 means that the value of "Link" at the start of the step should be used. An "Intersection" of 0.5 (the default) means to use the value of "Link" at the middle of the step, etc.

The resulting value at time <math>T</math> is:
<math>Link \Bigg ( \Bigg ( Duration \cdot \left ( \left \lfloor \frac{T - Start\ Time}{Duration} \right \rfloor + Intersection \right ) \Bigg ) + Start \ Time \Bigg )</math>

==== Example ====

"Link" is a sine wave. "Duration" is 10f (the frame rate is 24 fps). "Start Time" is 1s.

So one step starts at 1s, and others start at 0s 14f, 0s 4f, 1s 10f, etc.

This is the sine wave:

[[Image:Smooth-sine.png]]

And this is the effect of the Step valuenode on it, with an "Intersection" of 0.0. Notice that at time 0s, the step has a negative value -- that step runs from -6f to 4f, and so its value is the value of Link at time -6f. ''These images were created in [http://www.gimp.org/ The Gimp] - it's not currently possible to view two curves at the same time in Synfig Studio.''

[[Image:Stepped-sine-0.0.png]]

Here it is with an "Intersection" of 0.5:

[[Image:Stepped-sine-0.5.png]]

and here, with an "Intersection" of 1.0:

[[Image:Stepped-sine-1.0.png]]

=== Stripes ===

Converting a [[Convert#Gradient|gradient]] parameter to "Stripes" adds four sub-parameters:
* color "Color 1"
* color "Color 2"
* integer "Stripe Count"
* real "Width"

The resulting value is a gradient containing "Stripe Count" equally spaced, equally wide stripes of color "Color 2" with a background of "Color 1". "Width" specifies the width of the stripes, with a width of 0 or less meaning they are invisible, and a width of 1 or more meaning the whole gradient is of "Color 2".

=== Subtract ===

Converting a parameter to "Subtract" adds three sub-parameters, the first two of which are the same type as the parameter itself:
* <param> "LHS"
* <param> "RHS"
* real "Scalar"

The "Subtract" conversion can be used with parameters of type [[Convert#Angle|angle]], [[Convert#Color|color]], [[Convert#Gradient|gradient]], [[Convert#Integer|integer]], [[Convert#Real|real]], [[Convert#Time|time]], and [[Convert#Vector|vector]].

The resulting value is:
(LHS - RHS) * Scalar

=== Switch ===

Converting a parameter to "Switch" adds three sub-parameters:
* <param> "Link Off"
* <param> "Link On"
* bool "Switch"

"Link Off" and "Link On" are the same type as the parameter being converted.

The resulting value is the value of "Link Off" when "Switch" is off, and "Link On" when "Switch" is on.

This conversion can be used on all value types.

=== Time Loop ===

Converting a parameter to "Time Loop" adds four sub-parameters: one called "Link", of the same type as the parameter itself, and three time parameters:

* <param> "Link"
* time "Link Time"
* time "Local Time"
* time "Duration"

It works similarly to the [[Time Loop Layer]] but affects only a single parameter.

For any integer value n, from "Local Time + abs(Duration)*n" to "Local Time + abs(Duration)*(n+1)", the resulting value of the parameter is the same as that of the "Link" parameter from "Link Time" to "Link Time + Duration".

In other words, "Duration" seconds of values of the parameter "Link" starting from time "Link Time" onwards are looped over and over, with the value of the "Link"ed parameter at time "Link Time" corresponding to the resulting value at time "Local Time".

As an example, suppose the "Link" parameter has a value of time the current time. At 0s the value is 0, at 10s the value is 20.

If we set:
* Link Time = 5s
* Local Time = 2s
* Duration = 4s
then from 2s to 6s and from 6s to 10s, etc., the resulting value is the value of "Link" from 5s to 9s, as follows:

Then the resulting values will be:
* 0s -> "Link" value at 7s = 14
* 1s -> "Link" value at 8s = 16
* 2s -> "Link" value at 5s = 10 (at "Link Time" = 2s, result is the value of "Link" at "Link Time" = 5s = 10)
* 3s -> "Link" value at 6s = 12
* 4s -> "Link" value at 7s = 14
* 5s -> "Link" value at 8s = 16
* 6s -> "Link" value at 5s = 10 ("Duration" = 4s later, the value is the same as at 2s)
* 7s -> "Link" value at 6s = 12

If "Duration" is zero, the resulting value is whatever the value of the "Link" parameter is at time "Link Time".

If "Duration" is negative, the resulting value at "Local Time" still matches the value of "Link" at "Link Time", but the animation goes in the opposite direction. For example:

If we set:
* Link Time = 5s
* Local Time = 2s
* Duration = -4s
then from 2s to 6s and from 6s to 10s, etc., the resulting value is the value of "Link" from 5s to 1s, as follows:

Then the resulting values will be:
* 0s -> "Link" value at 3s = 6
* 1s -> "Link" value at 2s = 4
* 2s -> "Link" value at 5s = 10 (at "Link Time" = 2s, result is the value of "Link" at "Link Time" = 5s = 10)
* 3s -> "Link" value at 4s = 8
* 4s -> "Link" value at 3s = 6
* 5s -> "Link" value at 2s = 4
* 6s -> "Link" value at 5s = 10 (4s later, the value is the same as at "Link Time" = 2s)
* 7s -> "Link" value at 4s = 8

This conversion can be used on all value types.

=== Time String ===

Converting a [[Convert#String|string]] parameter to "Time String" adds one sub-parameter called "Time", of type time:

* time "Time"

The result is a string containing the given time.

=== Timed Swap ===

This convert type was disabled in Synfig 0.61.06 and earlier because it didn't work.

Converting a parameter to "Timed Swap" adds four sub-parameters:
* <param> "Before"
* <param> "After"
* time "Swap Time"
* time "Swap Duration"

"Before" and "After" are the same type as the parameter being converted.

This conversion type linearly switches from "Before" to "After", taking "Swap Duration" seconds to do so, and completing the swap at "Swap Time".

Note that this doesn't give us anything that we can't achieve using the "[[Convert#Linear|Linear]]" conversion type and a few waypoints.

"Timed Swap" can be used on [[Convert#Angle|angles]], [[Convert#Color|colors]], [[Convert#Integer|integers]], [[Convert#Real|reals]], [[Convert#Time|times]], and [[Convert#Vector|vectors]].

The resulting value is:
if time > "Swap Time" then "After"
else if time < ("Swap Time" - "Swap Duration") then "Before"
else interpolate between "Before" and "After"

=== Two-Tone ===

Converting a [[Convert#Gradient|gradient]] to "Two-Tone" adds two color-valued sub-parameters:
* color "Color1"
* color "Color2"

The resulting gradient has two CPoints, one at each end, starting with "Color1" and ending with "Color2".

These color parameters can be animated, giving us the ability to have the gradient change color over time. This can be used as a workaround for [http://sourceforge.net/tracker/index.php?func=detail&aid=1568818&group_id=144022&atid=757416 this bug].

=== Vector Angle ===

Converting an [[Convert#Angle|angle]] to "Vector Angle" adds a vector sub-parameter:
* vector "Vector"

The resulting value is the angle between the vector and the X axis.

=== Vector Length ===

Converting a [[Convert#Real|real]] to "Vector Length" adds a vector sub-parameter:
* vector "Vector"

The resulting value is the length of the vector.

=== Vector X ===

Converting a [[Convert#Real|real]] to "Vector X" adds a vector sub-parameter:
* vector "Vector"

The resulting value is the X component of the vector.

=== Vector Y ===

Converting a [[Convert#Real|real]] to "Vector Y" adds a vector sub-parameter:
* vector "Vector"

The resulting value is the Y component of the vector.

== Which Value Types can use which Convert Types? ==

There are 13 different types of value in Synfig. Each of these types has a different set of convert types available to it, as follows:

=== Angle ===

[[Image:angle_icon.png|32px]]

* Angle parameters can be converted to [[Convert#Add|Add]], [[Convert#aTan2|aTan2]], [[Convert#BLine Tangent|BLine Tangent]], [[Convert#Dot Product|Dot Product]], [[Convert#Linear|Linear]], [[Convert#Random|Random]], [[Convert#Range|Range]], [[Convert#Scale|Scale]], [[Convert#Step|Step]], [[Convert#Subtract|Subtract]], [[Convert#Switch|Switch]], [[Convert#Time Loop|Time Loop]], [[Convert#Timed Swap|Timed Swap]], [[Convert#Vector Angle|Vector Angle]], and [[Convert#Reference|Reference]] types.

=== BLinePoint ===
[[Image:blinepoint_icon.png|32px]]

* BLinePoint parameters can be converted to [[Convert#Composite|Composite]], [[Convert#Reverse Tangent|Reverse Tangent]], [[Convert#Switch|Switch]], [[Convert#Time Loop|Time Loop]], and [[Convert#Reference|Reference]] types.

=== Bool ===
[[Image:bool_icon.png|32px]]

* Bool parameters can only be converted to the [[Convert#And|AND]], [[Convert#Greyed|Greyed]], [[Convert#Or|OR]], [[Convert#Not|NOT]], [[Convert#Compare|Compare]] [[Convert#Random|Random]], [[Convert#Switch|Switch]], [[Convert#Time Loop|Time Loop]],and [[Convert#Reference|Reference]] types.

=== Canvas ===
[[Image:canvas_pointer_icon.png|32px]]

* Canvas parameters can be converted to the [[Convert#Switch|Switch]], [[Convert#Time Loop|Time Loop]], and [[Convert#Reference|Reference]] type.

=== Color ===
[[Image:color_icon.png|32px]]
* Color parameters can be converted to [[Convert#Add|Add]], [[Convert#Composite|Composite]], [[Convert#Gradient Color|Gradient Color]], [[Convert#Linear|Linear]], [[Convert#Radial Composite|Radial Composite]], [[Convert#Random|Random]], [[Convert#Scale|Scale]], [[Convert#Step|Step]], [[Convert#Subtract|Subtract]], [[Convert#Switch|Switch]], [[Convert#Time Loop|Time Loop]], [[Convert#Timed Swap|Timed Swap]], and [[Convert#Reference|Reference]] types.

=== Gradient ===
[[Image:gradient_icon.png|32px]]

* Gradient parameters can be converted to [[Convert#Add|Add]], [[Convert#Gradient Rotate|Gradient Rotate]], [[Convert#Repeat Gradient|Repeat Gradient]], [[Convert#Stripes|Stripes]], [[Convert#Subtract|Subtract]], [[Convert#Switch|Switch]], [[Convert#Time Loop|Time Loop]], [[Convert#Two-Tone|Two-Tone]], and [[Convert#Reference|Reference]] types.

=== Integer ===
[[Image:Integer_icon.png|32px]]
* Integer parameters can be converted to [[Convert#Add|Add]], [[Convert#Linear|Linear]], [[Convert#Random|Random]], [[Convert#Range|Range]], [[Convert#Scale|Scale]], [[Convert#Step|Step]], [[Convert#Subtract|Subtract]], [[Convert#Switch|Switch]], [[Convert#Time Loop|Time Loop]], [[Convert#Timed Swap|Timed Swap]], and [[Convert#Reference|Reference]] types.

=== List ===
[[Image:list_icon.png|32px]]
* List parameters can be converted to [[Convert#BLine|BLine]], [[Convert#Dynamic List|Dynamic List]], [[Convert#Switch|Switch]], [[Convert#Time Loop|Time Loop]], and [[Convert#Reference|Reference]] types.

=== Real ===
[[Image:real_icon.png|32px]]
* Real parameters can be converted to [[Convert#Add|Add]], [[Convert#BLine Width|BLine Width]], [[Convert#Cos|Cos]], [[Convert#Dot Product|Dot Product]], [[Convert#Exponential|Exponential]], [[Convert#Linear|Linear]], [[Convert#Logarithm|Logarithm]], [[Convert#Power|Power]], [[Convert#Random|Random]], [[Convert#Range|Range]], [[Convert#Reciprocal|Reciprocal]], [[Convert#Scale|Scale]], [[Convert#Sine|Sine]], [[Convert#Step|Step]], [[Convert#Subtract|Subtract]], [[Convert#Switch|Switch]], [[Convert#Time Loop|Time Loop]], [[Convert#Timed Swap|Timed Swap]], [[Convert#Vector Length|Vector Length]], [[Convert#Vector X|Vector X]], [[Convert#Vector Y|Vector Y]], and [[Convert#Reference|Reference]] types.

=== Segment ===
[[Image:segment_icon.png|32px]]
* Segment parameters can be converted to the [[Convert#Composite|Composite]], [[Convert#Switch|Switch]], [[Convert#Time Loop|Time Loop]], and [[Convert#Reference|Reference]] types.

=== String ===
[[Image:string_icon.png|32px]]
* String parameters can be converted to the [[Convert#Angle String|Angle String]], [[Convert#Int String|Int String]], [[Convert#Joined List|Joined List]], [[Convert#Real String|Real String]], [[Convert#Switch|Switch]], [[Convert#Time Loop|Time Loop]], [[Convert#Time String|Time String]], and [[Convert#Reference|Reference]] types.

=== Time ===
[[Image:time_icon.png|32px]]
* Time parameters can be converted to the [[Convert#Add|Add]], [[Convert#Linear|Linear]], [[Convert#Random|Random]], [[Convert#Range|Range]], [[Convert#Scale|Scale]], [[Convert#Step|Step]], [[Convert#Subtract|Subtract]], [[Convert#Switch|Switch]], [[Convert#Time Loop|Time Loop]], [[Convert#Timed Swap|Timed Swap]], and [[Convert#Reference|Reference]] types.

=== Vector ===
[[Image:vector_icon.png|32px]]
* Vector parameters can be converted to [[Convert#Add|Add]], [[Convert#BLine Tangent|BLine Tangent]], [[Convert#BLine Vertex|BLine Vertex]], [[Convert#Composite|Composite]], [[Convert#Linear|Linear]], [[Convert#Radial Composite|Radial Composite]], [[Convert#Random|Random]], [[Convert#Scale|Scale]], [[Convert#Segment Tangent|Segment Tangent]], [[Convert#Segment Vertex|Segment Vertex]], [[Convert#Step|Step]], [[Convert#Subtract|Subtract]], [[Convert#Switch|Switch]], [[Convert#Time Loop|Time Loop]], [[Convert#Timed Swap|Timed Swap]], and [[Convert#Reference|Reference]] types.

== Compatibility ==

When a new ValueNode type is added to Synfig, the .sif file format is extended to include a way of writing the new type. This extension won't be able to be read by any older version of Synfig. Here's a list of the ValueNode types that have been added, along with the subversion revision number in which they first appeared:

<blockquote>
{| style="width:55%"
| '''Version''' || '''Revision''' || '''Convert'''
|-
| <hr> || <hr> || <hr>
|-
| '''(0.61.09)''' || not yet released ||  
|-
|   || 2034 || [[#Logarithm|Logarithm]]
|-
|   || 2010 || [[#Int String|Int String]]
|-
|   || 2010 || [[#Angle String|Angle String]]
|-
|   || 2007 || [[#Joined List|Joined List]]
|-
|   || 2003 || [[#Real String|Real String]]
|-
|   || 2000 || [[#Time String|Time String]]
|-
|   || 1891 || [[#Dot Product|Dot Product]]
|-
|   || 1885 || [[#Gradient Color|Gradient Color]]
|-
|   || 1882 || [[#Vector X|Vector X]]
|-
|   || 1882 || [[#Vector Y|Vector Y]]
|-
|   || 1881 || [[#Vector Length|Vector Length]]
|-
|   || 1880 || [[#Vector Angle|Vector Angle]]
|-
| <hr> || <hr> || <hr>
|-
| '''(0.61.08)''' || 1839 ||  
|-
|   || 1694 || [[#BLine Width|BLine Width]]
|-
|   || 1690 || [[#Random|Random]] (for bools)
|-
|   || 1691 || [[#Step|Step]]
|-
|   || 1354 || [[#Subtract|Subtract]] (for gradients)
|-
|   || 1354 || [[#Add|Add]] (for gradients)
|-
|   || 1267 || [[#From Integer|From Integer]]
|-
|   || 1267 || [[#Duplicate|Duplicate]]
|-
|   || 1238 || [[#Reciprocal|Reciprocal]]
|-
|   || 1226 || [[#Time Loop|Time Loop]]
|-
|   || 1162 || [[#Reverse Tangent|Reverse Tangent]]
|-
|   || 1132 || [[#aTan2|aTan2]]
|-
|   || 1111 || [[#Cos|Cos]]
|-
|   || 923 || [[#Switch|Switch]]
|-
|   || 907 || [[#Random|Random]]
|-
| <hr> || <hr> || <hr>
|-
| '''(0.61.07)''' || 878 ||  
|-
|   || 776 || [[#Range|Range]]
|-
|   || 744 || [[#BLine Vertex|BLine Vertex]]
|-
|   || 744 || [[#BLine Tangent|BLine Tangent]]
|-
|   || 742 || [[#Add|Add]]
|-
|   || 739 || [[#Exponential|Exponential]]
|-
|   || 666 || [[#Repeat Gradient|Repeat Gradient]]
|-
|   || 610 || [[#Timed Swap|Timed Swap]]
|-
| <hr> || <hr> || <hr>
|-
| '''(0.61.06)''' || 536 ||  
|-|}
</blockquote>

Convert

2009-05-03T15:58:41Z

Nikitakit: Add boolean and power convertion types.

Right-clicking on a value in the Parameters dialog brings up a context menu which has a sub-menu called "Convert". The "Convert" menu allows you to specify that the parameter should be controlled automatically in various ways. Depending on the type of the parameter the Convert menu will contain different options.

To convert the value back to its original type, select "Disconnect" from its context menu.

== Convert Types ==

=== Add ===

Converting a parameter to "Add" adds three sub-parameters, the first two of which are the same type as the parameter itself:
* <param> "LHS"
* <param> "RHS"
* real "Scalar"

The "Add" conversion can be used with parameters of type [[Convert#Angle|angle]], [[Convert#Color|color]], [[Convert#Gradient|gradient]], [[Convert#Integer|integer]], [[Convert#Real|real]], [[Convert#Time|time]], and [[Convert#Vector|vector]].

The resulting value is:
(LHS + RHS) * Scalar

=== And ===

Converting a [[Convert#Bool|bool]] parameter to "AND" adds two sub-parameters:
* bool "Link1"
* bool "Link2"

The resulting value is true only if both Link1 and Link2 are true.

=== Angle String ===

Converting an [[Convert#String|string]]-valued parameter to "Angle String" adds four sub-parameters:
* angle "Angle"
* integer "Width"
* integer "Precision"
* bool "Zero Padded"

The resulting value a string containing the value of "Angle" (in degrees) formatted as a string with a minimum width "Width", with "Precision" decimal places. If "Zero Padded" is true, it will be left-padded with "0" characters.

=== aTan2 ===

Converting an [[Convert#Angle|angle]]-valued parameter to "aTan2" adds two sub-parameters:
* real "X"
* real "Y".

The resulting value is:
atan2(y,x)

ie. atan(y/x) but without an error when x is 0. The value is the angle between the x axis and the vector (x,y).

=== BLine ===

Converting a [[Convert#List|list]] parameter to "BLine" doesn't seem to change anything. Perhaps that's the default type for lists of vertices, such as are found in outlines and regions?

=== BLine Tangent ===

Converting a [[Convert#Angle|angle]], [[Convert#Real|real]] (since SVN r1862), or [[Convert#Vector|vector]] parameter to "BLine Tangent" adds six sub-parameters:
* bline "BLine"
* bool "Loop"
* real "Amount"
* angle "Offset" (since SVN r1863)
* real "Scale" (since SVN r1863)
* bool "Fixed Length" (since SVN r1863)

Amount is a number between 0 and 1, defining the distance along the given bline. The resulting value for the whole parameter is the tangent to the bline, at the given point along the bline, optionally rotated and scaled according to the "Offset", "Scale", and "Fixed Length" parameters.

"Offset" is an angle used to give the tangent an extra rotation before returning it. If "Fixed Length" is true, the tangent is then scaled to have a length equal to "Scale". Otherwise the tangent is multiplied by "Scale".

If a vector was converted the result is the tangent itself. If an angle was converted, the result is the angle of the tangent to the horizontal, and if a real was converted, the result is the length of the tangent.

This [[Following a BLine|tutorial]] gives an example of the use of this convert type.

=== BLine Vertex ===

Converting a [[Convert#Vector|vector]] parameter to "BLine Vertex" adds three sub-parameters:
* bline "BLine"
* bool "Loop"
* real "Amount"

Amount is a number between 0 and 1, defining the distance along the given bline. The resulting value for the whole parameter is a vector giving the position of the given point along the bline.

This [[Following a BLine|tutorial]] gives an example of the use of this convert type.

=== BLine Width ===

Converting a [[Convert#Real|real]] parameter to "BLine Width" adds three sub-parameters:
* bline "BLine"
* bool "Loop"
* real "Amount"
* real "Scale" (since SVN r1872)

Amount is a number between 0 and 1, defining the distance along the given bline. The resulting value for the whole parameter is the width of the bline at the given point along it, multiplied by the "Scale" parameter.

=== Compare ===

Converting a [[Convert#Bool|bool]] parameter to "OR" adds five sub-parameters:
* real "LHS"
* real "RHS"
* bool "Greater than"
* bool "Equal to"
* bool "Less than"

The valuenode compares LHS and RHS. The three boolean values determine which comparison returns true. For example, if LHS>RHS and "greater than" is checked, the valuenode will evaluate to "true".

=== Composite ===

Converting a [[Convert#BLinePoint|blinepoint]] parameter to "Composite" adds six sub-parameters:
* vector "Vertex"
* real "Width"
* real "Origin"
* bool "Split Tangents"
* vector "Tangent 1"
* vector "Tangent 2"

Converting a [[Convert#Color|color]] parameter to "Composite" adds four real-valued sub-parameters:
* real "Red"
* real "Green"
* real "Blue"
* real "Alpha"

Converting a [[Convert#Segment|segment]] parameter to "Composite" adds four vertex sub-parameters:
* vertex "Vertex 1"
* vertex "Tangent 1"
* vertex "Vertex 2"
* vertex "Tangent 2"

Converting a [[Convert#Vector|vector]] parameter to "Composite" adds two real-valued sub-parameters:
* real "X-Axis"
* real "Y-Axis"

The resulting value is a blinepoint, color, segment, or vector made by combining the component parts.

=== Cos ===

Converting a [[Convert#Real|real]]-valued parameter to "Cos" adds two sub-parameters:
* angle "Angle"
* real "Amplitude".

The resulting value is:
Amplitude * cos(Angle)

=== Dot Product ===

Converting a [[Convert#Real|real]] or [[Convert#Angle|angle]] parameter to a "Dot Product" adds two sub-parameters:
* vector "LHS"
* vector "RHS"

If the converted value is an angle, the return value is the angle between the two vectors:

return = acos((LHS · RHS) / (|LHS| * |RHS|))

If the converted value is a real, the result value is the dot product of the two vectors:

return = LHS · RHS = |LHS| * |RHS| * cos(alpha)

(where alpha is the angle between LHS and RHS).

=== Duplicate ===

This ValueNode type is only used by the [[Duplicate Layer]]. It never appears in the Convert menu. It is used to control the range of the Index in the Duplicate Layer (q.v.).

The "Duplicate" ValueNode type has 3 real-valued sub-parameters:

* real "From"
* real "To"
* real "Step"

The value of the ValueNode varies from the value of "From" to the value of "To" in steps of size "Step". The sign of "Step" is ignored. If From<To the steps are positive, else they're negative.

=== Dynamic List ===

Converting a [[Convert#List|list]] parameter to "Dynamic List" seems to replace each of the "Vertex NNN" sub-parameters with "Item NNN" parameters which can't be expanded, but can be exported.

=== Exponential ===

Converting a [[Convert#Real|real]] parameter to "Exponential" adds two sub-parameters:

* real "Exponent"
* real "Scale"

The resulting value is the result raising the [http://en.wikipedia.org/wiki/E_%28mathematical_constant%29 mathematical constant 'e'] to the power of Exponent, and scaling the result by Scale. That is, it returns:
Scale * e^Exponent

This is useful for tracking layers which have been zoomed, since the Zoom layer scales by e^(zoom factor).

See [http://youtube.com/watch?v=GAWtndOHkUw this video] for an example of the use of this convert type.

=== From Integer ===

This is currently disabled. It converts an integer to one of several types.

=== Gradient Color ===

Converting a [[Convert#Color|color]] parameter to "Gradient Color" adds two sub-parameters:

* gradient "Gradient"
* real "Index"

The resulting value is a color taken from the gradient at the given index position. Index 0 corresponds to the left of the gradient; index 1 corresponds to the right of the gradient.

=== Gradient Rotate ===

Converting a [[Convert#Gradient|gradient]] parameter to "Gradient Rotate" adds two sub-parameters:

* gradient "Gradient"
* real "Offset"

The resulting value is a gradient based on the "Gradient" parameter, but shifted left (for negative values) or right, according to the value of the "Offset" parameter. An offset of 1.0 will shift the gradient by its entire visible width. Values shifted off the left or right edge aren't lost - they aren't visible in the gradient as it's displayed in the parameters dialog, but they will still be used when rendering (depending on parameters such as 'Loop' and 'Zigzag', which can cause gradients to be looped between their their left and right edges, rather than using the non-displayed parts).

=== Int String ===

Converting an [[Convert#String|string]]-valued parameter to "Int String" adds three sub-parameters:
* integer "Int"
* integer "Width"
* bool "Zero Padded"

The resulting value a string containing "Int" formatted as a string with a minimum width "Width". If "Zero Padded" is true, it will be left-padded with "0" characters.

=== Joined List ===

Converting a [[Convert#String|string]] parameter to be 'Joined List' adds four sub-parameters:
* list "Strings"
* string "Before"
* string "Separator"
* string "After"

The result is a string containing the value of "Before", followed by all the strings in the "Strings" list, with the value of "Separator" between each pair, followed by the value of "After".

=== Linear ===

Converting an [[Convert#Angle|angle]] parameter to be 'Linear' adds two angle sub-parameters:
* angle "Rate"
* angle "Offset"

Converting a [[Convert#Color|color]] parameter to be 'Linear' adds two angle sub-parameters (since svn r617):
* color "Rate"
* color "Offset"

Converting an [[Convert#Integer|integer]] parameter to be 'Linear' adds two angle sub-parameters (since svn r617):
* integer "Rate"
* integer "Offset"

Converting a [[Convert#Real|real]] parameter to be 'Linear' adds two real-valued sub-parameters:
* real "Rate"
* real "Offset"

Converting a [[Convert#Time|time]] parameter to be 'Linear' adds two time sub-parameters:
* time "Rate"
* time "Offset"

Converting a [[Convert#Vector|vector]] parameter to be 'Linear' adds two vector sub-parameters:
* vector "Slope"
* vector "Offset"

The parameter's value will change linearly over time, starting with the value specified by "Offset" at time zero, and increasing by the value specified by "Rate" (or "Slope", in the case of vector parameters) every second.

The resulting value for vector parameters is:
Offset + Slope*time

and for the other 5 types of parameter it is:
Offset + Rate*time

=== Logarithm ===

Converting a [[Convert#Real|real]]-valued parameter to "Logarithm" adds three sub-parameters:

* real "Link"
* real "Epsilon".
* real "Infinite".

The resulting value is:

Log(Link) (if Link >= Epsilon)
-Infinite (if Link < Epsilon)

The epsilon and infinite parameters are only needed to prevent logarithm of negative or zero numbers. For regular operation the resulting value is simply the natural logarithm of Link. In fact a logarithm of a negative number cannot be calculated in the space of Real numbers. This convert type returns -Infinite for simplicity.

=== Not ===

Converting a [[Convert#Bool|bool]] parameter to "NOT" adds one sub-parameter:
* bool "Link"

The resulting value is the opposite of Link.

=== Or ===

Converting a [[Convert#Bool|bool]] parameter to "OR" adds two sub-parameters:
* bool "Link1"
* bool "Link2"

The resulting value is true if either link1, link2, or both are true.

=== Power ===

Converting a [[Convert#Real|real]]-valued parameter to "Power" adds three sub-parameters:
* real "Base"
* real "Power"
* real "Epsilon".
* real "Infinite".

The resulting value is Base^Power if the operation is defined.
The undefined cases will also return a value (to avoid errors):
0^0 = 1
0^-x = +/- infinite
If a negative base is raised to a noninteger power, the power is rounded (typecast) to an integer

The epsilon and infinite parameters are only needed to prevent division by zero.

=== Radial Composite ===

Converting a [[Convert#Color|color]] to "Radial Composite" adds four sub-parameters:
* real "Luma"
* real "Saturation"
* angle "Hue"
* real "Alpha"

Converting a [[Convert#Vector|vector]] to "Radial Composite" adds two sub-parameters:
* real "Radius"
* angle "Theta"

For color parameters, the resulting value is the color with the given lima, saturation, hue, and alpha amounts.

For vector parameters, the resulting value is the point reached by traveling a distance "Radius" from the origin, in the distance given by the angle "Theta".

=== Random ===

Converting a parameter to "Random" adds five sub-parameters, the first of which is the same type as the converted parameter:

* <param> "Link"
* real "Radius"
* integer "Seed"
* real "Animation Speed"
* integer "Interpolation"
* real "Loop Time" (since SVN r2315)

"Random" can be used on [[Convert#Angle|angles]], [[Convert#Color|colors]], [[Convert#Integer|integers]], [[Convert#Real|reals]], [[Convert#Time|times]], and [[Convert#Vector|vectors]].

It is used to cause a parameter's value to vary randomly over time, around a central value:

* "Link" provides the central value.
* "Radius" defines the maximum random difference.
* "Seed" seeds the random number generator
* "Animation Speed" defines how often a new random value is chosen (in choices per second)
* "Interpolation" determines how the value is interpolated from one random choice to the next. Possible values are:
** 0 - no interpolation; the value jumps from one value to the next
** 1 - linear interpolation
** 2 - cosine
** 3 - spline
** 4 - cubic (the default); uses [http://www.gamedev.net/reference/articles/article1497.asp Catmull-Rom] spline interpolation
* "Loop Time" (added in SVN r2315) makes the random value repeat after the given time. The value ends up the same at the given time as at time=0 so it's possible to make random looping animations without a nasty jump when the time wraps back to zero.

The "Interpolation" sub-parameter should really be a drop-down menu, rather than an integer field, but that isn't yet implemented.

=== Range ===

Converting a parameter to "Range" adds three sub-parameters, all the same type as the parameter itself:
* <param> "Min"
* <param> "Max"
* <param> "Link"

"Range" can be used on [[Convert#Angle|angles]], [[Convert#Integer|integers]], [[Convert#Real|reals]], and [[Convert#Time|times]].

It is used to limit the value of the linked parameter to be between Min and Max.

The resulting value is:
Min (if Link < Min)
Max (if Link > Max)
Link (otherwise)

=== Real String ===

Converting a [[Convert#String|string]] parameter to "Real String" adds four sub-parameters:

* real "Real"
* int "Width"
* int "Precision"
* bool "Zero Padded"

The result is a string formatted to contain the given value "Real". "Width" specifies the minimum field width, "Precision" specifies the number of decimal places and "Zero Padded" specifies whether to pad with zeros on the left hand side.

For example, with Real=3.1415, Width=6, Precision=2, and ZeroPadded=true, we get:
"003.14"
(6 characters long, 2 decimal places, and padded with zeros on the left).

=== Reciprocal ===

Converting a [[Convert#Real|real]]-valued parameter to "Reciprocal" adds three sub-parameters:
* real "Link"
* real "Epsilon".
* real "Infinite".

The resulting value is:
1/Link (Link <= -epsilon or epsilon <= Link)
Infinite (if 0 <= Link < epsilon)
-Infinite (if -epsilon < Link < 0)

The epsilon and infinite parameters are only needed to prevent division by zero. For regular operation the resulting value is simply the reciprocal of Link.

=== Reference ===

Converting a parameter to "Reference" adds a single sub-parameter called "Link". The "Link" parameter is the same type as the parameter being converted.

It doesn't seem to do anything at all, other than adding an extra parameter. Whatever value is put into "Link" becomes the value of the parameter being converted.

The only use for this conversion type I can think of is the following:

* you know that point A should follow point B, so you export point B and connect point A to it
* you're not yet sure exactly how point B should move, so you experiment with different conversion types for point B
* changing the conversion type for point B breaks the connection you made in the first step
* converting point B to be a reference, and then experimenting with different conversions in its "Link" parameter allows point A to connect to point B and for the connection to remain in place while you experiment in the "Link" parameter

The resulting value is:
Link

=== Repeat Gradient ===

Converting a [[Convert#Gradient|gradient]] parameter to "Repeat Gradient" adds seven sub-parameters:
* gradient "Gradient"
* integer "Count"
* real "Width"
* bool "Specify Start"
* bool "Specify End"
* color "Start Color"
* color "End Color"

The resulting value is a gradient containing "Count" equally spaced, equally wide copies of gradient "Gradient". Each copy has "Gradient" going forwards and then backwards. "Width" specifies relative width of the forward copy, with a width of 0 or less meaning only the backward copy is used, and a width of 1 or more meaning only the forward copy is used. A value of 0.5 will result in the forward and reverse copies of "Gradient" being the same width.

If "Specify Start" is checked then "Start Color" will be inserted at the beginning of the new gradient, otherwise the beginning of "Gradient" will be used as the beginning of the new gradient.

If "Specify End" is checked then "End Color" will be appended to the end of the new gradient, otherwise the end of "Gradient" will be used as the end of the new gradient.

Here's an example of a repeated gradient - the radiating green/yellow lines are a repeated gradient, applied to a perpendicular curve gradient. This gradient was repeated with a width of 0.5, meaning it is used backwards and forwards the same amount:

[[Image:Repeat-gradient-valuenode-gradient.png]]

and here's the resulting image, along with the .sif file:

[[Image:Repeat-gradient-valuenode.png]]
[[Image:Repeat-gradient-valuenode.sif]]

=== Reverse Tangent ===

Converting a blinepoint parameter to "Reverse Tangent" adds two sub-parameters: one called "Reference" of type BLinePoint, and a boolean parameter called "Reverse".
* BLinePoint "Reference"
* bool "Reverse"

"Reverse Tangent" can only be used on [[Convert#BLinePoint|blinepoints]].

The resulting value is the same as the reference BLinePoint, but with its tangents switched over. This is useful when attempting to link the verticies of a region to the vertices of an outline when the region and the outline were drawn in opposite directions, and so tangent1 of an outline vertex needs to be linked to tangent2 of the region vertex, and vice versa.

=== Scale ===

Converting a parameter to "Scale" adds two sub-parameters: one called "Link", of the same type as the parameter itself, and a real-valued parameter called "Scalar".
* <param> "Link"
* real "Scalar"

"Scale" can be used on [[Convert#Angle|angles]], [[Convert#Color|colors]], [[Convert#Integer|integers]], [[Convert#Real|reals]], [[Convert#Time|times]], and [[Convert#Vector|vectors]].

The resulting value is:
Link * Scalar

=== Segment Tangent ===

Converting a [[Convert#Vector|vector]] parameter to "Segment Tangent" adds two sub-parameters:
* segment "Segment"
* real "Amount"

Amount is a number between 0 and 1, defining the distance along the given segment. The resulting value for the whole parameter is the tangent to the segment, at the given point along the segment.

=== Segment Vertex ===

Converting a [[Convert#Vector|vector]] parameter to "Segment Vertex" adds two sub-parameters:
* segment "Segment"
* real "Amount"

Amount is a number between 0 and 1, defining the distance along the given segment. The resulting value is the vertex at the given point along the segment.

=== Sine ===

Converting a [[Convert#Real|real]]-valued parameter to "Sine" adds two sub-parameters:
* angle "Angle"
* real "Amplitude".

The resulting value is:
Amplitude * sin(Angle)

=== Step ===

Converting an [[Convert#Angle|angle]], [[Convert#Color|color]], [[Convert#Integer|integer]], [[Convert#Real|real]], [[Convert#Time|time]], or [[Convert#Vector|vector]] parameter to be 'Step' adds four sub-parameters:
* <param> "Link"
* time "Duration"
* time "Start Time"
* real "Intersection"

The parameter's value will change in steps. Each step is "Duration" seconds long. The steps start at times "Start Time", "Start Time"+"Duration", etc. The value of the valuenode is the value of "Link" at some time. "Intersection" determines which time is used. An "Intersection" of 0.0 means that the value of "Link" at the start of the step should be used. An "Intersection" of 0.5 (the default) means to use the value of "Link" at the middle of the step, etc.

The resulting value at time <math>T</math> is:
<math>Link \Bigg ( \Bigg ( Duration \cdot \left ( \left \lfloor \frac{T - Start\ Time}{Duration} \right \rfloor + Intersection \right ) \Bigg ) + Start \ Time \Bigg )</math>

==== Example ====

"Link" is a sine wave. "Duration" is 10f (the frame rate is 24 fps). "Start Time" is 1s.

So one step starts at 1s, and others start at 0s 14f, 0s 4f, 1s 10f, etc.

This is the sine wave:

[[Image:Smooth-sine.png]]

And this is the effect of the Step valuenode on it, with an "Intersection" of 0.0. Notice that at time 0s, the step has a negative value -- that step runs from -6f to 4f, and so its value is the value of Link at time -6f. ''These images were created in [http://www.gimp.org/ The Gimp] - it's not currently possible to view two curves at the same time in Synfig Studio.''

[[Image:Stepped-sine-0.0.png]]

Here it is with an "Intersection" of 0.5:

[[Image:Stepped-sine-0.5.png]]

and here, with an "Intersection" of 1.0:

[[Image:Stepped-sine-1.0.png]]

=== Stripes ===

Converting a [[Convert#Gradient|gradient]] parameter to "Stripes" adds four sub-parameters:
* color "Color 1"
* color "Color 2"
* integer "Stripe Count"
* real "Width"

The resulting value is a gradient containing "Stripe Count" equally spaced, equally wide stripes of color "Color 2" with a background of "Color 1". "Width" specifies the width of the stripes, with a width of 0 or less meaning they are invisible, and a width of 1 or more meaning the whole gradient is of "Color 2".

=== Subtract ===

Converting a parameter to "Subtract" adds three sub-parameters, the first two of which are the same type as the parameter itself:
* <param> "LHS"
* <param> "RHS"
* real "Scalar"

The "Subtract" conversion can be used with parameters of type [[Convert#Angle|angle]], [[Convert#Color|color]], [[Convert#Gradient|gradient]], [[Convert#Integer|integer]], [[Convert#Real|real]], [[Convert#Time|time]], and [[Convert#Vector|vector]].

The resulting value is:
(LHS - RHS) * Scalar

=== Switch ===

Converting a parameter to "Switch" adds three sub-parameters:
* <param> "Link Off"
* <param> "Link On"
* bool "Switch"

"Link Off" and "Link On" are the same type as the parameter being converted.

The resulting value is the value of "Link Off" when "Switch" is off, and "Link On" when "Switch" is on.

This conversion can be used on all value types.

=== Time Loop ===

Converting a parameter to "Time Loop" adds four sub-parameters: one called "Link", of the same type as the parameter itself, and three time parameters:

* <param> "Link"
* time "Link Time"
* time "Local Time"
* time "Duration"

It works similarly to the [[Time Loop Layer]] but affects only a single parameter.

For any integer value n, from "Local Time + abs(Duration)*n" to "Local Time + abs(Duration)*(n+1)", the resulting value of the parameter is the same as that of the "Link" parameter from "Link Time" to "Link Time + Duration".

In other words, "Duration" seconds of values of the parameter "Link" starting from time "Link Time" onwards are looped over and over, with the value of the "Link"ed parameter at time "Link Time" corresponding to the resulting value at time "Local Time".

As an example, suppose the "Link" parameter has a value of time the current time. At 0s the value is 0, at 10s the value is 20.

If we set:
* Link Time = 5s
* Local Time = 2s
* Duration = 4s
then from 2s to 6s and from 6s to 10s, etc., the resulting value is the value of "Link" from 5s to 9s, as follows:

Then the resulting values will be:
* 0s -> "Link" value at 7s = 14
* 1s -> "Link" value at 8s = 16
* 2s -> "Link" value at 5s = 10 (at "Link Time" = 2s, result is the value of "Link" at "Link Time" = 5s = 10)
* 3s -> "Link" value at 6s = 12
* 4s -> "Link" value at 7s = 14
* 5s -> "Link" value at 8s = 16
* 6s -> "Link" value at 5s = 10 ("Duration" = 4s later, the value is the same as at 2s)
* 7s -> "Link" value at 6s = 12

If "Duration" is zero, the resulting value is whatever the value of the "Link" parameter is at time "Link Time".

If "Duration" is negative, the resulting value at "Local Time" still matches the value of "Link" at "Link Time", but the animation goes in the opposite direction. For example:

If we set:
* Link Time = 5s
* Local Time = 2s
* Duration = -4s
then from 2s to 6s and from 6s to 10s, etc., the resulting value is the value of "Link" from 5s to 1s, as follows:

Then the resulting values will be:
* 0s -> "Link" value at 3s = 6
* 1s -> "Link" value at 2s = 4
* 2s -> "Link" value at 5s = 10 (at "Link Time" = 2s, result is the value of "Link" at "Link Time" = 5s = 10)
* 3s -> "Link" value at 4s = 8
* 4s -> "Link" value at 3s = 6
* 5s -> "Link" value at 2s = 4
* 6s -> "Link" value at 5s = 10 (4s later, the value is the same as at "Link Time" = 2s)
* 7s -> "Link" value at 4s = 8

This conversion can be used on all value types.

=== Time String ===

Converting a [[Convert#String|string]] parameter to "Time String" adds one sub-parameter called "Time", of type time:

* time "Time"

The result is a string containing the given time.

=== Timed Swap ===

This convert type was disabled in Synfig 0.61.06 and earlier because it didn't work.

Converting a parameter to "Timed Swap" adds four sub-parameters:
* <param> "Before"
* <param> "After"
* time "Swap Time"
* time "Swap Duration"

"Before" and "After" are the same type as the parameter being converted.

This conversion type linearly switches from "Before" to "After", taking "Swap Duration" seconds to do so, and completing the swap at "Swap Time".

Note that this doesn't give us anything that we can't achieve using the "[[Convert#Linear|Linear]]" conversion type and a few waypoints.

"Timed Swap" can be used on [[Convert#Angle|angles]], [[Convert#Color|colors]], [[Convert#Integer|integers]], [[Convert#Real|reals]], [[Convert#Time|times]], and [[Convert#Vector|vectors]].

The resulting value is:
if time > "Swap Time" then "After"
else if time < ("Swap Time" - "Swap Duration") then "Before"
else interpolate between "Before" and "After"

=== Two-Tone ===

Converting a [[Convert#Gradient|gradient]] to "Two-Tone" adds two color-valued sub-parameters:
* color "Color1"
* color "Color2"

The resulting gradient has two CPoints, one at each end, starting with "Color1" and ending with "Color2".

These color parameters can be animated, giving us the ability to have the gradient change color over time. This can be used as a workaround for [http://sourceforge.net/tracker/index.php?func=detail&aid=1568818&group_id=144022&atid=757416 this bug].

=== Vector Angle ===

Converting an [[Convert#Angle|angle]] to "Vector Angle" adds a vector sub-parameter:
* vector "Vector"

The resulting value is the angle between the vector and the X axis.

=== Vector Length ===

Converting a [[Convert#Real|real]] to "Vector Length" adds a vector sub-parameter:
* vector "Vector"

The resulting value is the length of the vector.

=== Vector X ===

Converting a [[Convert#Real|real]] to "Vector X" adds a vector sub-parameter:
* vector "Vector"

The resulting value is the X component of the vector.

=== Vector Y ===

Converting a [[Convert#Real|real]] to "Vector Y" adds a vector sub-parameter:
* vector "Vector"

The resulting value is the Y component of the vector.

== Which Value Types can use which Convert Types? ==

There are 13 different types of value in Synfig. Each of these types has a different set of convert types available to it, as follows:

=== Angle ===

[[Image:angle_icon.png|32px]]

* Angle parameters can be converted to [[Convert#Add|Add]], [[Convert#aTan2|aTan2]], [[Convert#BLine Tangent|BLine Tangent]], [[Convert#Dot Product|Dot Product]], [[Convert#Linear|Linear]], [[Convert#Random|Random]], [[Convert#Range|Range]], [[Convert#Scale|Scale]], [[Convert#Step|Step]], [[Convert#Subtract|Subtract]], [[Convert#Switch|Switch]], [[Convert#Time Loop|Time Loop]], [[Convert#Timed Swap|Timed Swap]], [[Convert#Vector Angle|Vector Angle]], and [[Convert#Reference|Reference]] types.

=== BLinePoint ===
[[Image:blinepoint_icon.png|32px]]

* BLinePoint parameters can be converted to [[Convert#Composite|Composite]], [[Convert#Reverse Tangent|Reverse Tangent]], [[Convert#Switch|Switch]], [[Convert#Time Loop|Time Loop]], and [[Convert#Reference|Reference]] types.

=== Bool ===
[[Image:bool_icon.png|32px]]

* Bool parameters can only be converted to the [[Convert#Switch|Switch]], [[Convert#Time Loop|Time Loop]], and [[Convert#Reference|Reference]] types.

=== Canvas ===
[[Image:canvas_pointer_icon.png|32px]]

* Canvas parameters can be converted to the [[Convert#Switch|Switch]], [[Convert#Time Loop|Time Loop]], and [[Convert#Reference|Reference]] type.

=== Color ===
[[Image:color_icon.png|32px]]
* Color parameters can be converted to [[Convert#Add|Add]], [[Convert#Composite|Composite]], [[Convert#Gradient Color|Gradient Color]], [[Convert#Linear|Linear]], [[Convert#Radial Composite|Radial Composite]], [[Convert#Random|Random]], [[Convert#Scale|Scale]], [[Convert#Step|Step]], [[Convert#Subtract|Subtract]], [[Convert#Switch|Switch]], [[Convert#Time Loop|Time Loop]], [[Convert#Timed Swap|Timed Swap]], and [[Convert#Reference|Reference]] types.

=== Gradient ===
[[Image:gradient_icon.png|32px]]

* Gradient parameters can be converted to [[Convert#Add|Add]], [[Convert#Gradient Rotate|Gradient Rotate]], [[Convert#Repeat Gradient|Repeat Gradient]], [[Convert#Stripes|Stripes]], [[Convert#Subtract|Subtract]], [[Convert#Switch|Switch]], [[Convert#Time Loop|Time Loop]], [[Convert#Two-Tone|Two-Tone]], and [[Convert#Reference|Reference]] types.

=== Integer ===
[[Image:Integer_icon.png|32px]]
* Integer parameters can be converted to [[Convert#Add|Add]], [[Convert#Linear|Linear]], [[Convert#Random|Random]], [[Convert#Range|Range]], [[Convert#Scale|Scale]], [[Convert#Step|Step]], [[Convert#Subtract|Subtract]], [[Convert#Switch|Switch]], [[Convert#Time Loop|Time Loop]], [[Convert#Timed Swap|Timed Swap]], and [[Convert#Reference|Reference]] types.

=== List ===
[[Image:list_icon.png|32px]]
* List parameters can be converted to [[Convert#BLine|BLine]], [[Convert#Dynamic List|Dynamic List]], [[Convert#Switch|Switch]], [[Convert#Time Loop|Time Loop]], and [[Convert#Reference|Reference]] types.

=== Real ===
[[Image:real_icon.png|32px]]
* Real parameters can be converted to [[Convert#Add|Add]], [[Convert#BLine Width|BLine Width]], [[Convert#Cos|Cos]], [[Convert#Dot Product|Dot Product]], [[Convert#Exponential|Exponential]], [[Convert#Linear|Linear]], [[Convert#Logarithm|Logarithm]], [[Convert#Random|Random]], [[Convert#Range|Range]], [[Convert#Reciprocal|Reciprocal]], [[Convert#Scale|Scale]], [[Convert#Sine|Sine]], [[Convert#Step|Step]], [[Convert#Subtract|Subtract]], [[Convert#Switch|Switch]], [[Convert#Time Loop|Time Loop]], [[Convert#Timed Swap|Timed Swap]], [[Convert#Vector Length|Vector Length]], [[Convert#Vector X|Vector X]], [[Convert#Vector Y|Vector Y]], and [[Convert#Reference|Reference]] types.

=== Segment ===
[[Image:segment_icon.png|32px]]
* Segment parameters can be converted to the [[Convert#Composite|Composite]], [[Convert#Switch|Switch]], [[Convert#Time Loop|Time Loop]], and [[Convert#Reference|Reference]] types.

=== String ===
[[Image:string_icon.png|32px]]
* String parameters can be converted to the [[Convert#Angle String|Angle String]], [[Convert#Int String|Int String]], [[Convert#Joined List|Joined List]], [[Convert#Real String|Real String]], [[Convert#Switch|Switch]], [[Convert#Time Loop|Time Loop]], [[Convert#Time String|Time String]], and [[Convert#Reference|Reference]] types.

=== Time ===
[[Image:time_icon.png|32px]]
* Time parameters can be converted to the [[Convert#Add|Add]], [[Convert#Linear|Linear]], [[Convert#Random|Random]], [[Convert#Range|Range]], [[Convert#Scale|Scale]], [[Convert#Step|Step]], [[Convert#Subtract|Subtract]], [[Convert#Switch|Switch]], [[Convert#Time Loop|Time Loop]], [[Convert#Timed Swap|Timed Swap]], and [[Convert#Reference|Reference]] types.

=== Vector ===
[[Image:vector_icon.png|32px]]
* Vector parameters can be converted to [[Convert#Add|Add]], [[Convert#BLine Tangent|BLine Tangent]], [[Convert#BLine Vertex|BLine Vertex]], [[Convert#Composite|Composite]], [[Convert#Linear|Linear]], [[Convert#Radial Composite|Radial Composite]], [[Convert#Random|Random]], [[Convert#Scale|Scale]], [[Convert#Segment Tangent|Segment Tangent]], [[Convert#Segment Vertex|Segment Vertex]], [[Convert#Step|Step]], [[Convert#Subtract|Subtract]], [[Convert#Switch|Switch]], [[Convert#Time Loop|Time Loop]], [[Convert#Timed Swap|Timed Swap]], and [[Convert#Reference|Reference]] types.

== Compatibility ==

When a new ValueNode type is added to Synfig, the .sif file format is extended to include a way of writing the new type. This extension won't be able to be read by any older version of Synfig. Here's a list of the ValueNode types that have been added, along with the subversion revision number in which they first appeared:

<blockquote>
{| style="width:55%"
| '''Version''' || '''Revision''' || '''Convert'''
|-
| <hr> || <hr> || <hr>
|-
| '''(0.61.09)''' || not yet released ||  
|-
|   || 2034 || [[#Logarithm|Logarithm]]
|-
|   || 2010 || [[#Int String|Int String]]
|-
|   || 2010 || [[#Angle String|Angle String]]
|-
|   || 2007 || [[#Joined List|Joined List]]
|-
|   || 2003 || [[#Real String|Real String]]
|-
|   || 2000 || [[#Time String|Time String]]
|-
|   || 1891 || [[#Dot Product|Dot Product]]
|-
|   || 1885 || [[#Gradient Color|Gradient Color]]
|-
|   || 1882 || [[#Vector X|Vector X]]
|-
|   || 1882 || [[#Vector Y|Vector Y]]
|-
|   || 1881 || [[#Vector Length|Vector Length]]
|-
|   || 1880 || [[#Vector Angle|Vector Angle]]
|-
| <hr> || <hr> || <hr>
|-
| '''(0.61.08)''' || 1839 ||  
|-
|   || 1694 || [[#BLine Width|BLine Width]]
|-
|   || 1690 || [[#Random|Random]] (for bools)
|-
|   || 1691 || [[#Step|Step]]
|-
|   || 1354 || [[#Subtract|Subtract]] (for gradients)
|-
|   || 1354 || [[#Add|Add]] (for gradients)
|-
|   || 1267 || [[#From Integer|From Integer]]
|-
|   || 1267 || [[#Duplicate|Duplicate]]
|-
|   || 1238 || [[#Reciprocal|Reciprocal]]
|-
|   || 1226 || [[#Time Loop|Time Loop]]
|-
|   || 1162 || [[#Reverse Tangent|Reverse Tangent]]
|-
|   || 1132 || [[#aTan2|aTan2]]
|-
|   || 1111 || [[#Cos|Cos]]
|-
|   || 923 || [[#Switch|Switch]]
|-
|   || 907 || [[#Random|Random]]
|-
| <hr> || <hr> || <hr>
|-
| '''(0.61.07)''' || 878 ||  
|-
|   || 776 || [[#Range|Range]]
|-
|   || 744 || [[#BLine Vertex|BLine Vertex]]
|-
|   || 744 || [[#BLine Tangent|BLine Tangent]]
|-
|   || 742 || [[#Add|Add]]
|-
|   || 739 || [[#Exponential|Exponential]]
|-
|   || 666 || [[#Repeat Gradient|Repeat Gradient]]
|-
|   || 610 || [[#Timed Swap|Timed Swap]]
|-
| <hr> || <hr> || <hr>
|-
| '''(0.61.06)''' || 536 ||  
|-|}
</blockquote>

Doc:Slideshow Tutorial

2009-03-13T22:58:19Z

Nikitakit: Spelling

In Synfig, there are many ways to create a slideshow from a series of images. Probably the simplest is using the [[ListImporter|List Importer]] to import a series of images. However, the method only works on raster images and is incapable of generating transitions. The technique described here is only slightly more complex, but it allows creating a presentation from a series of Synfig layers, regardless of type of size. The method can only produce cross-fade transitions; anything more complex would require a more advanced technique.

==Technical Description==

Synfig animates with a series of layers, each of which exists throughout the entire timeline. Hence, our goal is to make only one of the layers visible at any given time. Though there are many ways to achieve this goal, this tutorial will assure that only one layer is seen by using the [[Blend_Method_Parameter|Blend]] and [[Amount_Parameter|Amount]] parameters of each layer.

All graphical layers in Synfig have these two essential properties. The [[Blend_Method_Parameter|Blend Mode]] defines how the image should be layered on everything below it, and the Amount dictates to what extent the blending is done. In the default blend mode, [[Blend_Method_Parameter#Composite|Composite]], objects are simply placed on top of everything below them. In this case, the Amount value determines the overall transparency of the layer: at a value of 1.0, the layer is fully visible; at 0.0, it is entirely transparent. In-between values constitute partial transparency, which will form the transitions. These properties can be used to display a series of pictures. Each is its own layer and at any given point in time, one layer's amount is set to 1.0 while all others equal 0. However, there is a more efficient way of accomplishing the task. This method requires switching all images to the [[Blend_Method_Parameter#Straight|Straight]] blend mode.

This blend mode has an advantage: all layers below the current one are hidden. Therefore it is no longer necessary for layers below the current one to have a an Amount of 0. Using the Amount for crossfade still works, but it now needs to be changed only once: all layers start with a value of 1, and then be made transparent from the highest to the lowest.

The effect could be animated with two waypoints per layer. However, Synfig offers an even simpler method that does not require using the animation mode. Instead, linking functionality can be used. The data type for Amount is currently set to be a real number. Instead, let's replace that with a special function by converting the layer to [[Convert#Timed_Swap|Timed Swap]].

[[Image:Slideshow_amount4.png]]

Now we examine the parameters of this new data type. The first is the initial value (1.0), the second is the final value (0.0), and the third is the time when the values will switch. If we want the image to display for two seconds, we can set the Swap Time to "2s". (Note: this assumes we are starting at 0s). Then the amount will be 1.0 for three seconds (image visible) and 0 for the remainder of the timeline (image hidden). The last value will be the duration of the crossfade transition. Note that the transition takes away from the time for which the image will be displayed. For example, a value of "1s" means that the image will be fully opaque for one second, fade in one second, and then remain faded for the remainder of the animation.

Applying successive times to layers from the top down will fade them one by one, creating the desired slideshow effect.

==Step-by-Step Instructions==
Here are step-by-step instructions for applying this principle to an animation.

===Setting Up===
Open a Synfig document and import any images, canvases, etc. Images can be imported using >File>Import (The first ">" signifies the [[Canvas_Menu_Caret|Caret Menu]]). Note that importing ''links'' to the image using a ''relative'' path. Take care to maintain the relative positions of the files when moving them. If multiple layers represent a single image, encapsulate them into an [[Inline Canvas]].
Then arrange the images in the order they will be displayed, first image on top.

===Blend Method===
Select all layers in the layer panel. Then go to the parameters panel and set the Blend Method to Straight.
[[Image:Slideshow_blend1.png]][[Image:Slideshow_blend2.png]]

===Timed Swap===
Unlike Blend Mode, converting to [[Convert#Timed_Swap|Timed Swap]] must be done individually for each layer.
Set "Before" to 1.0 and "After" to 0.
Suppose you want the images to swap every 4 seconds, using 1 second transitions. Then set the "Duration" to "1s". Afterwards, set Time for the first layer to 4+1=5. Then increase the time for each successive layer (5,10,15,20,...). The Swap Time is the point where the image fully disappears. Configure these values to fit your needs.

[[Image:Slideshow_amount1.png]] [[Image:Slideshow_amount2.png]]
[[Image:Slideshow_amount3.png]] [[Image:Slideshow_amount4.png]]

===Animation Length===
Now that times have been configured, your file must be configured to render the full animation length. Go to >Edit>Properties and switch to the "Time" tab. Set the end time to equal the last of your time values. You can add a few seconds if you want a blank/black screen at the end, after the images have faded.

===Extra: Background===
You may have noticed that the Straight Blend Mode removes any backgrounds from the image. Here are two methods to add a background:

a) Encapsulate all image layers. Now the Straight blend mode only works within the inline canvas. Once this is done, add any backgrounds below the canvas, and any foreground above the canvas.

b) Add a background layer/canvas to the ''top'' of the layer list. Since it is above all other layers, the Straight layering mode doesn't affect it. However, it would normally shroud all the images. To make it appear below everything else, set the Blend Mode to [[Blend_Method_Parameter#Behind|Behind]].

==Endnotes==

Congratulations! You have now finished reading the slideshow tutorial. Please leave me (nikitakit) a comment about your thoughts concerning this page.

GNU/Linux users may also be interested in [http://akhilman.googlepages.com/images2sif.sh AkhIL's imag2sif shell script]. It imports images into Synfig and creates a rotate and translate layer for each.

The explanation of the "Straight" blend mode in this tutorial lacks a screenshot. Feel free to add one.

Tutorials

2009-03-13T22:56:57Z

Nikitakit: Slideshow Tutorial

[[Category:Tutorials]]
[[Category:Permalink]]

This is an index of all of the tutorials for Synfig Studio.

{| border="1" cellspacing="0" align="center" width="80%"
|'''Tutorial Name'''||'''Description''' || '''Level'''
|-
| [[Getting Started]] [[http://synfig.org/files/voria/synfig_tutorial.pdf PDF]] || New to Synfig Studio? This tutorial will help you get the gist of things || Basic
|-
| [[Animation Basics]] || Introduction to making things move, the timeline, and the [[Keyframes Panel|Keyframes Panel]]. || Basic
|-
| [[Adding Layers]] || Introduction to the Layers palette, and basics of compositing. || Basic
|-
| [[Creating Shapes]] || Introduction to making shapes using the bline and normal tools. || Basic
|-
| [[How do I|How do I...?]] || Quick tutorials, and commonly-needed tasks. || Basic
|-
| [[Slideshow Tutorial]] || Make a slideshow out of a series of images or other Synfig layers. || Intermediate
|-
| [[Flower Animation]] || A beginner tutorial, showing animation with blines. It could be a good tutorial to follow, after the Animations Basics one. || Intermediate
|-
| [[Snowflake with the Duplicate Layer]] || A tutorial explaining how to use the Duplicate Layer to easily duplicate objects. || Intermediate
|-
| [[Shiny Effects]] #1 || A tutorial of making some shiny effects. || Intermediate
|-
| [[Building a magnifying glass]] [[http://www.musikboden.se/synfigfiles/tutorial_magnifying_glass.pdf PDF]] || A tutorial showing how to build a magnifying glass. || Intermediate
|-
| [[Rescale Animations]] || A tutorial that shows how to rescale a portion of animation in start - end and speed up/down (WIP). || Intermediate.
|-
| [[Cut-out_Animation]] || A tutorial that shows how to create cut-out style animations. || Intermediate.
|-
| [[Following a BLine]] || A tutorial showing how to make a layer follow a BLine rotating to face the direction it's moving in. || Advanced
|-
| [[Walk Cycle]] || Tutorial showing import of multiple still frames, and rotoscoping to generate a walk cycle animation || Advanced
|-
| [[Reuse Animations]] || Tutorial that explains how to reuse "poses" of portions of the scene without interfere on the rest of it. || Advanced
|-
| [[Switching Scenes]] || Tutorial that explains how to edit a collection of .sif files together and switch back and forth between them. || Advanced
|-
| [[Reuse Exported ValueNodes]] || Small tutorial to show how to reuse cool conversion collections on several animations || Advanced
|-
| [[Sewing BLines]] || A tutorial to show how to sew the edges of the BLines (Outlines, Regions and any BLine based) to each others || Advanced
|-
| [[Parabolic Shot]] || A tutorial to show how to make layers follow a mathematical equation || Advanced
|-
| [[Particles]] || A tutorial to show how to use the particles template released by [[User:Genete|Genete]] || Advanced
|-
| [[Brushes]] || A tutorial to show how to create brushes using the Duplicate Layer and the Link to Bline features|| Advanced
|-
| [http://morevnaproject.org/2008/11/27/camera-widget/ Camera view] || How to arrange camera pan/zoom of canvas and manage ValueBase Nodes of imported canvases || Advanced
|-
| [[Requested Tutorials]] || Need a tutorial? Request it here. || N/A
|}

== See Also ==
* [[Keyboard Shortcuts]]
* [[Mouse Shortcuts]]
* [[Video Tutorials]]
* [[Quick Overview]]

General animation tutorial links:

* [http://www.keithlango.com/tutorials/old/popThru/popThru.html Keith Largo Tutes]
* [http://www.animationarchive.org/2006/05/meta-100000-animation-drawing-course.html The Animation Drawing Course at The Animation Archive]
*[http://www.garycmartin.com/mouth_shapes.html Lip Sync]
*[http://www.channel4.com/4talent/moveit/index.html MOVE IT! Animation Tutorial]

Requested Tutorials

2009-03-13T22:50:50Z

Nikitakit: Slideshow Tutorial is now available

[[Category:Tutorials]]

== Requested Tutorials ==

* Explanation of the difference between waypoints and keyframes. (Meanwhile someone writes this requested tutorial you can have a look to [[Keyframe | keyframes]] and [[Waypoints|waypoints]] pages).
* Making a ball bounce- tutorial
* How to rotate objects.(done in Categorical Help> Synfig Studio Interface> The ToolBox> Rotate Tool)
* Make an object to follow a path given by a mathematical function [[Parabolic Shot|Parabolic Shot]]. This is applicable to [[Ball_Bounce|ball-bounce-tutorial (unfinished)]].
* How to change the location of a shape's pivot point. Or a cut-out animation tutorial. (I think I worked it out, making the rotation by rotation layers. Kinda weird, but actually it is there.)

Doc:Slideshow Tutorial

2009-03-13T22:47:54Z

Nikitakit: Finish tutorial

In Synfig, there are many ways to create a slideshow from a series of images. Probably the simplest is using the [[ListImporter|List Importer]] to import a series of images. However, the method only works on raster images and is incapable of generating transitions. The technique described here is only slightly more complex, but it allows creating a presentation from a series of Synfig layers, regardless of type of size. The method can only produce cross-fade transitions; anything more complex would require a more advanced technique.

==Technical Description==

Synfig animates with a seried of layers, each of which exists throughout the entire timeline. Hence, our goal is to make only one of the layers visible at any given time. Though there are many ways to achieve this goal, this tutorial will assure that only one layer is seen by using the [[Blend_Method_Parameter|Blend]] and [[Amount_Parameter|Amount]] parameters of each layer.

All graphical layers in Synfig have these two essential properties. The [[Blend_Method_Parameter|Blend Mode]] defines how the image should be layered on everything below it, and the Amount dictates to what extent the blending is done. In the default blend mode, [[Blend_Method_Parameter#Composite|Composite]], objects are simply placed on top of everything below them. In this case, the Amount value determines the overall transparency of the layer: at a value of 1.0, the layer is fully visible; at 0.0, it is entirely transparent. In-betwen values constitute partial transparency, which will form the transitions. These properties can be used to display a series of pictures. Each is its own layer and at any given point in time, one layer's amount is set to 1.0 while all others equal 0. However, there is a more efficient way of accomplishing the task. This method requires switching all images to the [[Blend_Method_Parameter#Straight|Straight]] blend mode.

This blend mode has an advantage: all layers below the current one are hidden. Therefore it is no longer necessary for layers below the current one to have a an Amount of 0. Using the Amount for crossfade still works, but it now needs to be changed only once: all layers start with a value of 1, and then be made transparent from the highest to the lowest.

The effect could be animated with two waypoints per layer. However, Synfig offers an even simpler method that does not require using the animation mode. Instead, linking functionality can be used. The data type for Amount is currently set to be a real number. Instead, let's replace that with a special function by converting the layer to [[Convert#Timed_Swap|Timed Swap]].

[[Image:Slideshow_amount4.png]]

Now we examine the parameters of this new data type. The first is the initial value (1.0), the second is the final value (0.0), and the third is the time when the values will switch. If we want the image to display for two seconds, we can set the Swap Time to "2s". (Note: this assumes we are starting at 0s). Then the amount will be 1.0 for three seconds (image visible) and 0 for the remainer of the timeline (image hidden). The last value will be the duration of the crossfade transition. Note that the transition takes away from the time for which the image will be displayed. For example, a value of "1s" means that the image will be fully opaque for one second, fade in one second, and then remain faded for the remainder of the animation.

Applying successive times to layers from the top down will fade them one by one, creating the desired slideshow effect.

==Step-by-Step Instructions==
Here are step-by-step instructions for applying this principle to an animation.

===Setting Up===
Open a Synfig document and import any images, canvases, etc. Images can be imported using >File>Import (The first ">" signifies the [[Canvas_Menu_Caret|Caret Menu]]). Note that importing ''links'' to the image using a ''relative'' path. Take care to maintain the relative positions of the files when moving them. If multiple layers represent a single image, encapsulate them into an [[Inline Canvas]].
Then arrange the images in the order they will be displayed, first image on top.

===Blend Method===
Select all layers in the layer panel. Then go to the parameters panel and set the Blend Method to Straight.
[[Image:Slideshow_blend1.png]][[Image:Slideshow_blend2.png]]

===Timed Swap===
Unlike Blend Mode, converting to [[Convert#Timed_Swap|Timed Swap]] must be done individually for each layer.
Set "Before" to 1.0 and "After" to 0.
Suppose you want the images to swap every 4 seconds, using 1 second transitions. Then set the "Duration" to "1s". Afterwards, set Time for the first layer to 4+1=5. Then increase the time for each successive layer (5,10,15,20,...). The Swap Time is the point where the image fully disappears. Configure these values to fit your needs.

[[Image:Slideshow_amount1.png]] [[Image:Slideshow_amount2.png]]
[[Image:Slideshow_amount3.png]] [[Image:Slideshow_amount4.png]]

===Animation Length===
Now that times have been configured, your file must be configured to render the full animation length. Go to >Edit>Properties and switch to the "Time" tab. Set the end time to equal the last of your time values. You can add a few seconds if you want a blank/black screen at the end, after the images have faded.

===Extra: Background===
You may have noticed that the Straight Blend Mode removes any backgrounds from the image. Here are two methods to add a background:

a) Encapsulate all image layers. Now the Straight blend mode only works within the inline canvas. Once this is done, add any backgrounds below the canvas, and any foreground above the canvas.

b) Add a background layer/canvas to the ''top'' of the layer list. Since it is above all other layers, the Straight layering mode doesn't affect it. However, it would normally shroud all the images. To make it appear below everything else, set the Blend Mode to [[Blend_Method_Parameter#Behind|Behind]].

==Endnotes==

Congratulations! You have now finished reading the slideshow tutorial. Please leave me (nikitakit) a comment about your thoughts concerning this page.

GNU/Linux users may also be interested in [http://akhilman.googlepages.com/images2sif.sh AkhIL's imag2sif shell script]. It imports images into Synfig and creates a rotate and translate layer for each.

The explanation of the "Straight" blend mode in this tutorial lacks a screenshot. Feel free to add one.

Doc:Slideshow Tutorial

2009-03-13T22:37:59Z

Nikitakit: Text to match screenshot

NOTE: this tutorial is a work in progress. If you have any questions, contact nikitakit.

In Synfig, there are many ways to create a slideshow from a series of images. Probably the simplest is using the [[ListImporter|List Importer]] to import a series of images. However, the method only works on images [of the same size (?)] and is incapable of generating transitions. The technique described here is only slightly more complex, but it allows creating a presentation from a series of Synfig layers, regardless of type of size. The method can only produce cross-fade transitions; anything more complex would require a more advanced technique.

==Technical Description==

Synfig animates with a seried of layers, each of which exists throughout the entire timeline. Hence, our goal is to make only one of the layers visible at any given time. Though there are many ways to achieve this goal, this tutorial will assure that only one layer is seen by using the [[Blend_Method_Parameter|Blend]] and [[Amount_Parameter|Amount]] parameters of each layer.

All graphical layers in Synfig have these two essential properties. The [[Blend_Method_Parameter|Blend Mode]] defines how the image should be layered on everything below it, and the Amount dictates to what extent the blending is done. In the default blend mode, [[Blend_Method_Parameter#Composite|Composite]], objects are simply placed on top of everything below them. In this case, the Amount value determines the overall transparency of the layer: at a value of 1.0, the layer is fully visible; at 0.0, it is entirely transparent. In-betwen values constitute partial transparency, which will form the transitions. These properties can be used to display a series of pictures. Each is its own layer and at any given point in time, one layer's amount is set to 1.0 while all others equal 0. However, there is a more efficient way of accomplishing the task. This method requires switching all images to the [[Blend_Method_Parameter#Straight|Straight]] blend mode.

[Examine the picture that has not yet been added...]

[As you can see,] this blend mode has an advantage: all layers below the current one are hidden. Therefore it is no longer necessary for layers below the current one to havea an Amount of 0. Using the Amount for crossfade still works, but it now needs to be changed only once: all layers start with a value of 1, and then be made transparent from the highest to the lowest.

The effect could be animated with two waypoints per layer. However, Synfig offers an even simpler method that does not require using the animation mode. Instead, linking functionality can be used. The data type for Amount is currently set to be a real number. Instead, let's replace that with a special function by converting the layer to [[Convert#Timed_Swap|Timed Swap]].

[[Image:Slideshow_amount4.png]]

Now we examine the parameters of this new data type. The first is the initial value (1.0), the second is the final value (0.0), and the third is the time when the values will switch. If we want the image to display for two seconds, we can set the Swap Time to "2s". (Note: this assumes we are starting at 0s). Then the amount will be 1.0 for three seconds (image visible) and 0 for the remainer of the timeline (image hidden). The last value will be the duration of the crossfade transition. Note that the transition takes away from the time for which the image will be displayed. For example, a value of "1s" means that the image will be fully opaque for one second, fade in one second, and then remain faded for the remainder of the animation.

Applying successive times to layers from the top down will fade them one by one, creating the desired slideshow effect.

==Step-by-Step Instructions==
Here are step-by-step instructions for applying this principle to an animation.

===Setting Up===
Open a Synfig document and import any images, canvases, etc. Images can be imported using >File>Import (The first ">" signifies the [[Canvas_Menu_Caret|Caret Menu]]). Note that importing ''links'' to the image using a ''relative'' path. Take care to maintain the relative positions of the files when moving them. If multiple layers represent a single image, encapsulate them into an [[Inline Canvas]].
Then arrange the images in the order they will be displayed, first image on top.

===Blend Method===
Select all layers in the layer panel. Then go to the parameters panel and set the Blend Method to Straight.
[[Image:Slideshow_blend1.png]][[Image:Slideshow_blend2.png]]

===Timed Swap===
Unlike Blend Mode, converting to [[Convert#Timed_Swap|Timed Swap]] must be done individually for each layer.
Set "Before" to 1.0 and "After" to 0.
Suppose you want the images to swap every 4 seconds, using 1 second transitions. Then set the "Duration" to "1s". Afterwards, set Time for the first layer to 4+1=5. Then increase the time for each successive layer (5,10,15,20,...). The Swap Time is the point where the image fully disappears. Configure these values to fit your needs.

[[Image:Slideshow_amount1.png]] [[Image:Slideshow_amount2.png]]
[[Image:Slideshow_amount3.png]] [[Image:Slideshow_amount4.png]]

===Animation Length===
Now that times have been configured, your file must be configured to render the full animation length. Go to >Edit>Properties and switch to the "Time" tab. Set the end time to equal the last of your time values. You can add a few seconds if you want a blank/black screen at the end, after the images have faded.

===Extra: Background===
You may have noticed that the Straight Blend Mode removes any backgrounds from the image. Here are two methods to add a background:

a) Encapsulate all image layers. Now the Straight blend mode only works within the inline canvas. Once this is done, add any backgrounds below the canvas, and any foreground above the canvas.

b) Add a background layer/canvas to the ''top'' of the layer list. Since it is above all other layers, the Straight layering mode doesn't affect it. However, it would normally shroud all the images. To make it aappear below everything else, set the Blend Mode to [[Blend_Method_Parameter#Behind|Behind]].

==Endnotes==

Congratulations! You have now finished reading the slideshow tutorial. Please leave me (nikitakit) a comment about your thoughts concerning this page.

GNU/Linux users may also be interested in [http://akhilman.googlepages.com/images2sif.sh AkhIL's imag2sif shell script]. It imports images into Synfig and creates a rotate and translate layer for each.

File:Slideshow amount4.png

2009-03-13T22:36:37Z

Nikitakit: Slideshow Tutorial: The "After" Parameter is set to 0

Slideshow Tutorial: The "After" Parameter is set to 0

File:Slideshow amount3.png

2009-03-13T22:36:12Z

Nikitakit: Slideshow Tutorial: "Amount" has now been converted to "Timed Swap"

Slideshow Tutorial: "Amount" has now been converted to "Timed Swap"

File:Slideshow amount2.png

2009-03-13T22:35:36Z

Nikitakit: Slideshow Tutorial: Converting "Amount" to "Timed Swap"

Slideshow Tutorial: Converting "Amount" to "Timed Swap"

File:Slideshow amount1.png

2009-03-13T22:35:01Z

Nikitakit: Slideshow Tutorial: The "Amount" Parameter is selected

Slideshow Tutorial: The "Amount" Parameter is selected

File:Slideshow blend2.png

2009-03-13T22:34:23Z

Nikitakit: Slideshow Tutorial:Changing the Blend Method to "Straight"

Slideshow Tutorial:Changing the Blend Method to "Straight"

File:Slideshow blend1.png

2009-03-13T22:33:48Z

Nikitakit: Slideshow Tutorial: The Blend Method is "Composite"

Slideshow Tutorial: The Blend Method is "Composite"

Doc:Slideshow Tutorial

2009-03-13T22:32:57Z

Nikitakit: Images

NOTE: this tutorial is a work in progress. If you have any questions, contact nikitakit.

In Synfig, there are many ways to create a slideshow from a series of images. Probably the simplest is using the [[ListImporter|List Importer]] to import a series of images. However, the method only works on images [of the same size (?)] and is incapable of generating transitions. The technique described here is only slightly more complex, but it allows creating a presentation from a series of Synfig layers, regardless of type of size. The method can only produce cross-fade transitions; anything more complex would require a more advanced technique.

==Technical Description==

Synfig animates with a seried of layers, each of which exists throughout the entire timeline. Hence, our goal is to make only one of the layers visible at any given time. Though there are many ways to achieve this goal, this tutorial will assure that only one layer is seen by using the [[Blend_Method_Parameter|Blend]] and [[Amount_Parameter|Amount]] parameters of each layer.

All graphical layers in Synfig have these two essential properties. The [[Blend_Method_Parameter|Blend Mode]] defines how the image should be layered on everything below it, and the Amount dictates to what extent the blending is done. In the default blend mode, [[Blend_Method_Parameter#Composite|Composite]], objects are simply placed on top of everything below them. In this case, the Amount value determines the overall transparency of the layer: at a value of 1.0, the layer is fully visible; at 0.0, it is entirely transparent. In-betwen values constitute partial transparency, which will form the transitions. These properties can be used to display a series of pictures. Each is its own layer and at any given point in time, one layer's amount is set to 1.0 while all others equal 0. However, there is a more efficient way of accomplishing the task. This method requires switching all images to the [[Blend_Method_Parameter#Straight|Straight]] blend mode.

[Examine the picture that has not yet been added...]

[As you can see,] this blend mode has an advantage: all layers below the current one are hidden. Therefore it is no longer necessary for layers below the current one to havea an Amount of 0. Using the Amount for crossfade still works, but it now needs to be changed only once: all layers start with a value of 1, and then be made transparent from the highest to the lowest.

The effect could be animated with two waypoints per layer. However, Synfig offers an even simpler method that does not require using the animation mode. Instead, linking functionality can be used. The data type for Amount is currently set to be a real number. Instead, let's replace that with a special function by converting the layer to [[Convert#Timed_Swap|Timed Swap]].

[[Image:Slideshow_amount3.png]]

Now we examine the parameters of this new data type. The first is the initial value (1.0), the second is the final value (0.0), and the third is the time when the values will switch. If we want the image to display for three seconds, we can set the Swap Time to "3s". (Note: this assumes we are starting at 0s). Then the amount will be 1.0 for three seconds (image visible) and 0 for the remainer of the timeline (image hidden). The last value will be the duration of the crossfade transition. Note that the transition takes away from the time for which the image will be displayed. For example, a value of "1s" means that the image will be fully opaque for two seconds, fade in one second, and then remain faded for the remainder of the animation.

Applying successive times to layers from the top down will fade them one by one, creating the desired slideshow effect.

==Step-by-Step Instructions==
Here are step-by-step instructions for applying this principle to an animation.

===Setting Up===
Open a Synfig document and import any images, canvases, etc. Images can be imported using >File>Import (The first ">" signifies the [[Canvas_Menu_Caret|Caret Menu]]). Note that importing ''links'' to the image using a ''relative'' path. Take care to maintain the relative positions of the files when moving them. If multiple layers represent a single image, encapsulate them into an [[Inline Canvas]].
Then arrange the images in the order they will be displayed, first image on top.

===Blend Method===
Select all layers in the layer panel. Then go to the parameters panel and set the Blend Method to Straight.
[[Image:Slideshow_blend1.png]][[Image:Slideshow_blend2.png]]

===Timed Swap===
Unlike Blend Mode, converting to [[Convert#Timed_Swap|Timed Swap]] must be done individually for each layer.
Set "Before" to 1.0 and "After" to 0.
Suppose you want the images to swap every 4 seconds, using 1 second transitions. Then set the "Duration" to "1s". Afterwards, set Time for the first layer to 4+1=5. Then increase the time for each successive layer (5,10,15,20,...). The Swap Time is the point where the image fully disappears. Configure these values to fit your needs.

[[Image:Slideshow_amount1.png]] [[Image:Slideshow_amount2.png]]
[[Image:Slideshow_amount3.png]] [[Image:Slideshow_amount4.png]]

===Animation Length===
Now that times have been configured, your file must be configured to render the full animation length. Go to >Edit>Properties and switch to the "Time" tab. Set the end time to equal the last of your time values. You can add a few seconds if you want a blank/black screen at the end, after the images have faded.

===Extra: Background===
You may have noticed that the Straight Blend Mode removes any backgrounds from the image. Here are two methods to add a background:

a) Encapsulate all image layers. Now the Straight blend mode only works within the inline canvas. Once this is done, add any backgrounds below the canvas, and any foreground above the canvas.

b) Add a background layer/canvas to the ''top'' of the layer list. Since it is above all other layers, the Straight layering mode doesn't affect it. However, it would normally shroud all the images. To make it aappear below everything else, set the Blend Mode to [[Blend_Method_Parameter#Behind|Behind]].

==Endnotes==

Congratulations! You have now finished reading the slideshow tutorial. Please leave me (nikitakit) a comment about your thoughts concerning this page.

GNU/Linux users may also be interested in [http://akhilman.googlepages.com/images2sif.sh AkhIL's imag2sif shell script]. It imports images into Synfig and creates a rotate and translate layer for each.

Doc:Slideshow Tutorial

2009-03-12T22:06:44Z

Nikitakit: Formatting, Links

NOTE: this tutorial is a work in progress. If you have any questions, contact nikitakit.

In Synfig, there are many ways to create a slideshow from a series of images. Probably the simplest is using the [[ListImporter|List Importer]] to import a series of images. However, the method only works on images [of the same size (?)] and is incapable of generating transitions. The technique described here is only slightly more complex, but it allows creating a presentation from a series of Synfig layers, regardless of type of size. The method can only produce cross-fade transitions; anything more complex would require a more advanced technique.

==Technical Description==

Synfig animates with a seried of layers, each of which exists throughout the entire timeline. Hence, our goal is to make only one of the layers visible at any given time. Though there are many ways to achieve this goal, this tutorial will assure that only one layer is seen by using the [[Blend_Method_Parameter|Blend]] and [[Amount_Parameter|Amount]] parameters of each layer.

All graphical layers in Synfig have these two essential properties. The [[Blend_Method_Parameter|Blend Mode]] defines how the image should be layered on everything below it, and the Amount dictates to what extent the blending is done. In the default blend mode, [[Blend_Method_Parameter#Composite|Composite]], objects are simply placed on top of everything below them. In this case, the Amount value determines the overall transparency of the layer: at a value of 1.0, the layer is fully visible; at 0.0, it is entirely transparent. In-betwen values constitute partial transparency, which will form the transitions. These properties can be used to display a series of pictures. Each is its own layer and at any given point in time, one layer's amount is set to 1.0 while all others equal 0. However, there is a more efficient way of accomplishing the task. This method requires switching all images to the [[Blend_Method_Parameter#Straight|Straight]] blend mode.

[Examine the picture that has not yet been added...]

[As you can see,] this blend mode has an advantage: all layers below the current one are hidden. Therefore it is no longer necessary for layers below the current one to havea an Amount of 0. Using the Amount for crossfade still works, but it now needs to be changed only once: all layers start with a value of 1, and then be made transparent from the highest to the lowest.

The effect could be animated with two waypoints per layer. However, Synfig offers an even simpler method that does not require using the animation mode. Instead, linking functionality can be used. The data type for Amount is currently set to be a real number. Instead, let's replace that with a special function by converting the layer to [[Convert#Timed_Swap|Timed Swap]].

[Screenshot]

Now we examine the parameters of this new data type. The first is the initial value (1.0), the second is the final value (0.0), and the third is the time when the values will switch. If we want the image to display for three seconds, we can set the Swap Time to "3s". (Note: this assumes we are starting at 0s). Then the amount will be 1.0 for three seconds (image visible) and 0 for the remainer of the timeline (image hidden). The last value will be the duration of the crossfade transition. Note that the transition takes away from the time for which the image will be displayed. For example, a value of "1s" means that the image will be fully opaque for two seconds, fade in one second, and then remain faded for the remainder of the animation.

Applying successive times to layers from the top down will fade them one by one, creating the desired slideshow effect.

==Step-by-Step Instructions==
Here are step-by-step instructions for applying this principle to an animation.

===Setting Up===
Open a Synfig document and import any images, canvases, etc. Images can be imported using >File>Import (The first ">" signifies the [[Canvas_Menu_Caret|Caret Menu]]). Note that importing ''links'' to the image using a ''relative'' path. Take care to maintain the relative positions of the files when moving them. If multiple layers represent a single image, encapsulate them into an [[Inline Canvas]].
Then arrange the images in the order they will be displayed, first image on top.

===Blend Method===
Select all layers in the layer panel. Then go to the parameters panel and set the Blend Method to Straight.

===Timed Swap===
Unlike Blend Mode, converting to [[Convert#Timed_Swap|Timed Swap]] must be done individually for each layer.
Set "Before" to 1.0 and "After" to 0.
Suppose you want the images to swap every 4 seconds, using 1 second transitions. Then set the "Duration" to "1s". Afterwards, set Time for the first layer to 4+1=5. Then increase the time for each successive layer (5,10,15,20,...). The Swap Time is the point where the image fully disappears. Configure these values to fit your needs.

===Animation Length===
Now that times have been configured, your file must be configured to render the full animation length. Go to >Edit>Properties and switch to the "Time" tab. Set the end time to equal the last of your time values. You can add a few seconds if you want a blank/black screen at the end, after the images have faded.

===Extra: Background===
You may have noticed that the Straight Blend Mode removes any backgrounds from the image. Here are two methods to add a background:

a) Encapsulate all image layers. Now the Straight blend mode only works within the inline canvas. Once this is done, add any backgrounds below the canvas, and any foreground above the canvas.

b) Add a background layer/canvas to the ''top'' of the layer list. Since it is above all other layers, the Straight layering mode doesn't affect it. However, it would normally shroud all the images. To make it aappear below everything else, set the Blend Mode to [[Blend_Method_Parameter#Behind|Behind]].

==Endnotes==

Congratulations! You have now finished reading the slideshow tutorial. Please leave me (nikitakit) a comment about your thoughts concerning this page.

GNU/Linux users may also be interested in [http://akhilman.googlepages.com/images2sif.sh AkhIL's imag2sif shell script]. It imports images into Synfig and creates a rotate and translate layer for each.

Doc:Slideshow Tutorial

2009-03-12T18:49:55Z

Nikitakit: Create page

NOTE: this tutorial is a work in progress. If you have any questions, contact nikitakit.

In Synfig, there are many ways to create a slideshow from a series of images. Probably the simplest is using the [[ListImporter|List Importer]] to import a series of images. Hower, the method only works on images [of the same size (?)] and is incapable of generating transitions. The technique described here is only slightly more complex, but it allows creating a presentation from a series of Synfig layers, regardless of type of size. The method can only produce cross-fade transitions; anything more complex would require a more advanced technique.

=Technical Description=

Synfig animates with a seried of layers, each of which exists throughout the entire timeline. Hence, our goal is to make only one of the layers visible at any given time. Though there are many ways to achieve this goal, this tutorial will assure that only one layer is seen by using the Blend and Amount parameters of each layer.

All graphical layers in Synfig have these two essential properties. The Blend Mode defines how the image should be layered on everything below it, and the Amount dictates to what extent the blending is done. In the default blend mode, Composite, objects are simply placed on top of everything below them. In this case, the Amount value determines the overall transparency of the layer: at a value of 1.0, the layer is fully visible; at 0.0, it is entirely transparent. In-betwen values constitute partial transparency, which will form the transitions. These properties can be used to display a series of pictures. Each is its own layer and at any given point in time, one layer's amount is set to 1.0 while all others equal 0. However, there is a more efficient way of accomplishing the task. This method requires switching all images to the Straight blend mode.

[Examine the picture that has not yet been added...]

[As you can see,] this blend mode has an advantage: all layers below the current one are hidden. Therefore it is no longer necessary for layers below the current one to havea an Amount of 0. Using the Amount for crossfade still works, but it now needs to be changed only once: all layers start with a value of 1, and then be made transparent from the highest to the lowest.

The effect could be animated with two waypoints per layer. However, Synfig offers an even simpler method that does not require using the animation mode. Instead, linking functionality can be used. The data type for Amount is currently set to be a real number. Instead, let's replace that with a special function by converting the layer to "Timed Swap".

[Screenshot]

Now we examine the parameters of this new data type. The first is the initial value (1.0), the second is the final value (0.0), and the third is the time when the values will switch. If we want the image to display for three seconds, we can set the Swap Time to "3s". (Note: this assumes we are starting at 0s). Then the amount will be 1.0 for three seconds (image visible) and 0 for the remainer of the timeline (image hidden). The last value will be the duration of the crossfade transition. Note that the transition takes away from the time for which the image will be displayed. For example, a value of "1s" means that the image will be fully opaque for two seconds, fade in one second, and then remain faded for the remainder of the animation.

Applying successive times to layers from the top down will fade them one by one, creating the desired slideshow effect.

=Step-by-Step Instructions=
Here are step-by-step instructions for applying this principle to an animation.

==Setting Up==
Open a Synfig document and import any images, canvases, etc. Images can be imported using (?) >File>Import. Note that importing _links_ to the image using a _relative_ path. Take care to maintain the relative positions of the files when moving them. If multiple layers represent a single image, encapsulate them into an Inline Canvas.
Then arrange the images in the order they will be displayed, first image on top.

==Blend Method==
Select all layers in the layer panel. Then go to the parameters panel and set the Blend Method to Straight.

==Timed Swap==
Unlike Blend Mode, converting to Timed Swap must be done individually for each layer.
Set "Before" to 1.0 and "After" to 0.
Suppose you want the images to swap every 4 seconds, using 1 second transitions. Then set the "Duration" to "1s". Afterwards, set Time for the first layer to 4+1=5. Then increase the time for each successive layer (5,10,15,20,...). The Swap Time is the point where the image fully disappears. Configure these values to fit your needs.

==Animation Length==
Now that times have been configured, your file must be configured to render the full animation length. Go to >Edit>Properties and switch to the "Time" tab. Set the end time to equal the last of your time values. You can add a few seconds if you want a blank/black screen at the end, after the images have faded.

==Extra: Background==
You may have noticed that the Straight Blend Mode removes any backgrounds from the image. Here are two methods to add a background:

a) Encapsulate all image layers. Now the Straight blend mode only works within the inline canvas. Once this is done, add any backgrounds below the canvas, and any foreground above the canvas.

b) Add a background layer/canvas to the _top_ of the layer list. Since it is above all other layers, the Straight layering mode doesn't affect it. However, it would normally shroud all the images. To make it aappear below everything else, set the Blend Mode to "Behind".

Congratulations! You have now finished reading the slideshow tutorial. Please leave me (nikitakit) a comment about your thoughts concerning this page.

Preferences Dialog

2009-02-18T23:07:39Z

Nikitakit: Grammar edits

[[Category:Dialogs]]


[[Category:Dialogs]]

== Propose of the Setup Dialog ==

The Setup Dialog allows the user set certain properties and preferences that are globally adopted by the application and used by all the Documents opened or to be opened. The Setup Dialog is organized in Tabs allowing modify the properties or preferences by meaningful groups.

== Gamma Tab ==

[[Image:Gamma.png]]

The gamma tab controls how the color representation in Synfig Studio is managed while editing a Document. There is a gamma pattern diagram on the top to let the user visually know how the gamma modifications would look in the color space.

In the middle there are three color sliders that control the gamma for each separate channel. Default values for those sliders are 2.2 for each color. Depending on the gamma adjustment you have in your monitor or output device, you may want to change those values to be more appropriate.

Below those sliders there is a Black level selector. It is used to calibrate your output device to show the black color as black. Most of the time you'll need this value set to 0.0.

==Miscellaneous tab==

[[Image:Misc.png]]

This tab groups some miscellaneous global preferences for the application. All of them would affect new files opened or created after they have been changed.

=== Time Format ===

This selection menu allows to set the time format used in the application. It would affect how all time parameters and information you see in Synfig Studio are shown. Although internally all the time values are stored as seconds, you can see the time in other formats:

* HH:MM:SS.FF. This is a fixed format that shows always the time in hours:minutes:seconds.frames with two significant digits minimum. Examples: 123:45:58.13, 00:00:04.23
*(HHh MMm SSs) FFf '''default'''. This is a flexible format that would use the needed space to show the time using the correct derived unit. Examples: 123h 45m 58s 13f, 4s 23f. Notice that the second time only use the needed derived units (seconds) not using minutes or hours like in the previous type.
*(HHhMMmSSs)FFf. This one works exactly like the previous one but in a more compact format (no spaces). Examples: 123h45m58s13f, 4s23f.
* HHh MMm SSs FFf. This is like the default one but in a fixed format like the first one. Examples: 123h 45m 58s 13f, 00h 00m 04s 23f.
* HHhMMmSSsFFf. I think you can imagine how does this one works. Examples: 123h45m58s13f, 00h00m04s23f.
* FFf. This one shows all the times in frames. (There is a bug here because it doesn't work properly) Examples: 10693405f, 119f, assuming that the frames per second are set to 24.

=== Unit System ===

This drop down list allows change the global preference to the unit system that the user would want to use in any opened or created documents. Although all the vector dimensions are stored internally in synfig as units there are unit conversions to other systems to make editing more friendly or appropriate to the values that the user has from the model. Available Unit Systems are:

* points (pt)
* units (u)
* pixels (px)
* inches (in)
* metres (m)
* centimeters (cm)
* millimeters (mm)

See the [[Unit System|Unit System]] in action to know the equivalence between those units.

=== Recent Files ===

This spin button entry box allows the user to define how many recent files are shown when the [[Toolbox|Toolbox]]>File>Recent Files menu option is selected. Maximum value is set to 50 and minimum to 1. Default is 25.

=== Automatic Backup Interval ===

Synfig studio may crash (an infrequent thing lately), or you may have lost power or killed the program for any reason. Synfig Studio does a security copy of the current working document and would ask to recover it the next time you run the program. It can be set to a minimum of 1 second and does not have a maximum. Set it to 0s to disable the automatic backup. Default value is 3m.

===Browser command ===

This entry box allows the user select the name of your preferred browser. Set there the name of the binary to execute when Synfig Studio need to invoke the external browser (for example when clicking on the help menu items). The default value for Unix like system is "xdg-open" and "open" for Windows and MacOs.

===Visually Linear Color Selection ===

This [http://en.wikipedia.org/wiki/RGB_color_model#Nonlinearity Wikipedia] article talks about how color output is non-linear, that if 0 is black and 100 is white, then 50 is only about 22 percent of the brightness of white, rather than 50% as you might expect.

In Synfig Studio there is an option (on by default) to make sure that if you ask for 50, you get 50% of the brightness of white.

If you turn this option off, everything will go back to its non-linear, yet strangely comfortable and familiar mode.

=== Restrict Real Value Ducks to the Top Right Quadrant ===

This is a feature that makes the manipulation of the real value ducks easier in certain situations. Real value ducks are the ones that can manage any kind of real number (if it is implemented in the layer interface). For example Circle Radius is controlled by a Real Value Duck. Also the Outlines Width are controlled by this kind of ducks. If you have to set the real value exactly to 0.0 it becomes especially difficult to do with the normal behavior of the real value ducks. If you set this parameter on, the position of the duck is restricted to be in the top right quadrant of the 2D space. In this way you can set the real value to any number and also easily reach the value of 0.0 just dragging the duck to the left bottom part of your 2D space.

== Document Tab ==

[[Image:Document.png]]

This tab groups some Document global preferences for the application. All of them would affect new files opened or created after they have been changed.

=== New Document filename prefix ===

This option sets the prefix of the newly created Documents in Synfig Studio. A sequential number, starting with 1, will be added to it for each new file you create in a Synfig Studio session. This is particularly useful if you're working in a project with several files.

=== New Document X and Y sizes ===

In those spin buttons entries you can set the preferred X and Y dimensions of the new created documents. Again this is useful if you're working with a certain resolution and want to keep all the file exactly the same without the tedious task of editing the particular dimensions of each new created file. Image Area (in units) are calculated accordingly to the correspondence between pixels and units (60 pixels = 1 unit). Default value are X=480 and Y=270 pixels.

There is a Set of Predefined Resolutions to automatically set the X and Y dimensions to the standards of the digital industry. Select any of them and the X and Y sizes would change automatically. Default resolution is "480x270 Web 480x HD".

ToolBox File Menu

2009-02-18T22:53:47Z

Nikitakit:

The Toolbox File Menu has the following options:

*'''New''' (CTRL+N): Create a new file. Its default name is ''Synfig Animation #'' where # starts from 1 and increases by 1 for each new file you create in a Synfigstudio session. It starts editing the "Root" canvas.
*'''Open''' (CTRL+O): Pops up a choose file dialog to select the sifz file you want to open.
*'''Open Recent''': It gives a dynamic menu list with the last 25 (maximum) recent opened (or created) files.
*'''Save As''': Pops up a save file dialog to save the current file with a given name.
*'''Close''' (CTRL+W): Close the current document in edition. It would ask for save it if the document is marked as "dirty".
*'''Panels''': It gives a sub menu with the following entries:
**'''Vertical Dock: Canvases, History''': It opens a vertical dock window with the [[Canvas Browser Panel|Canvas Browser Panel]], the [[Canvas Drop Down List]] and the [[History Dialog]]
**'''Horizontal Dock: Layers, Children, Params''': It opens an horizontal dock window with the [Layers Panel]], the [[Children Panel]] and the [[Params Panel]]
**'''Reset Windows To Original Layout''': Reposition and the Windows and Panels to its default position.
**'''[[Tool Options Panel|Tool Options]]''': Opens this Panel
**'''[[History Panel|History]]''': Opens this Panel
**'''[[Canvas Browser Panel|Canvas Browser]]''': Opens this Panel
**'''[[Keyframes Panel|Keyframe]]''': Opens this Panel
**'''[[Layers Panel|Layers]]''': Opens this Panel
**'''[[Params Panel|Params]]''': Opens this Panel
**'''[[Canvas MetaData Panel|Canvas MetaData]]''': Opens this Panel
**'''[[Children Panel|Children]]''': Opens this Panel
**'''[[Info Panel|Info]]''': Opens this Panel
**'''[[Timetrack Panel|Timetrack]]''': Opens this Panel
**'''[[Curves Panel|Curves]]''': Opens this Panel
**'''[[Groups Panel|Groups]]''': Opens this Panel
**'''[[Palette Editor Panel|Palette Editor]]''': Opens this Panel
*'''Input Devices...''': It pops up an input device dialog window to modify your preferences with those devices. If there isn't any device connected it brings an information window.
*'''Setup...''': It pops up a [[Setup Dialog]] Window where the user can establish the preferences for the program, such as measure units, preferred external browser etc.
*'''Quit''' (CTRL+Q): It quits Synfigstudio. If there is any "dirty" file it ask for save.

Spline

2009-02-18T22:46:51Z

Nikitakit: Stub page

Blines are the most commonly used objects in any normal animation done with Synfig, and can be made using the [[BLine Tool]].

Please see the [[BLine Tool]] page for more information.

Toolbox File Palette

2009-02-18T15:56:45Z

Nikitakit:

The Toolbox File Palette has the following buttons:

*'''New...''': Create a new file. Its default name is ''Synfig Animation #'' where # starts from 1 and increases by 1 for each new file you create in a Synfigstudio session. It starts editing the "Root" canvas.
*'''Open...''' : Pops up a choose file dialog to select the sifz file you want to open.
*'''Save''': Saves the selected file. If it has not been saved previously it works like the Save As button.
*'''Save As...''': Pops up a save file dialog to save the current file with a given name.
*'''Save All''': Save all the files.
*'''Undo''': It makes the same than the corresponding menu entry from the [[Canvas Edit Menu]].
*'''Redo''': It makes the same than the corresponding menu entry from the [[Canvas Edit Menu]].
*'''Setup...''': It pops up a [[Setup Dialog]] Window where the user can stablish the preferences for the program like measure units, preferred external browser etc.
*'''About''': It pops up the [[About Dialog]].
*'''Help''' : It opens the [[Documentation]] page in the default browser.